ScenePlugin

.Scenes. ScenePlugin

场景插件是场景管理器的主要界面,允许你控制 游戏中的任何场景.你应该一直使用这个插件.默认情况下,它是 映射到场景属性.意思是,在场景中,你可以调用 方法如 `this.scene.start()` . 请注意,这个类中几乎所有的方法都是基于队列运行的,而不是 马上.例如,调用 `this.scene.launch(`sceneb` )`将尝试 当场景管理器下一次更新时,也就是游戏开始时,启动场景网站 台阶.所有操作都按在此调用的顺序排队和运行.

Constructor

new ScenePlugin(scene)

Since:
  • 3.0.0
Parameters:
Name Type Description
scene Phaser.Scene 此场景所在的场景.

Members

key :string

Since:
  • 3.0.0
此场景所在场景的关键点.
Type:
  • string

manager :Phaser.Scenes.SceneManager

Since:
  • 3.0.0
游戏场景管理员.
Type:

scene :Phaser.Scene

Since:
  • 3.0.0
此场景所在的场景.
Type:

settings :Phaser.Types.Scenes.SettingsObject

Since:
  • 3.0.0
此场景所在场景的设置.
Type:

systems :Phaser.Scenes.Systems

Since:
  • 3.0.0
该场景所在场景的场景系统实例.
Type:

transitionProgress :number

Since:
  • 3.5.0
如果此场景当前正在转换到另一个场景,这将保持不变 转换进度的当前百分比,介于0和1之间.
Type:
  • number

Methods

add(key, sceneConfig, autoStartopt, dataopt) → (nullable) {Phaser.Scene}

Since:
  • 3.0.0
将场景添加到场景管理器中,并在设置了`场景配置`属性的情况下启动它.
Parameters:
Name Type Attributes Default Description
key string 用于引用场景的唯一键,即. `MainMenu` 或 `LEVEL1` .
sceneConfig Phaser.Scene | Phaser.Types.Scenes.SettingsConfig | Phaser.Types.Scenes.CreateSceneFromObjectConfig | function 场景的配置
autoStart boolean <optional>
false 如果 `true` ,场景将在添加后立即启动.
data object <optional>
可选数据对象.这将被设置为 `z scene.settings.data` 并传递给 `z scene.init` 和 `z scene.create` .
Returns:
添加的场景,如果它是立即添加的,否则为 `null` .
Type
Phaser.Scene

bringToTop(keyopt) → {this}

Since:
  • 3.0.0
将场景置于场景列表的顶部. 这意味着它将渲染高于所有其他场景.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景移动.
Returns:
这个场景插件实例.
Type
this

get(key) → {Phaser.Scene}

Since:
  • 3.0.0
检索场景.
Parameters:
Name Type Description
key string | Phaser.Scene 要检索的场景.
Returns:
场景.
Type
Phaser.Scene

getIndex(keyopt) → {number}

Since:
  • 3.7.0
在场景列表中检索场景的数字索引.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要获取其索引的场景.
Returns:
场景的索引.
Type
number

isActive(keyopt) → {boolean}

Since:
  • 3.0.0
检查给定场景是否正在运行?
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要检查的场景.
Returns:
场景是否正在运行,如果没有找到匹配的场景,则为 `null` .
Type
boolean

isPaused(keyopt) → {boolean}

Since:
  • 3.17.0
检查给定场景是否暂停?
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要检查的场景.
Returns:
场景是否暂停,如果没有找到匹配的场景,则为 `null` .
Type
boolean

isSleeping(keyopt) → {boolean}

Since:
  • 3.0.0
检查给定场景是否正在睡觉?
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要检查的场景.
Returns:
场景是否正在休眠,如果没有找到匹配的场景,则为 `null` .
Type
boolean

isVisible(keyopt) → {boolean}

Since:
  • 3.0.0
检查给定场景是否可见?
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要检查的场景.
Returns:
场景是否可见,如果没有找到匹配的场景,则为 `null` .
Type
boolean

launch(key, dataopt) → {this}

Since:
  • 3.0.0
启动给定的场景,并与这个场景并行运行. 这将在下一次场景管理器更新时发生,而不是立即发生.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene 要启动的场景.
data object <optional>
场景数据.
Returns:
这个场景插件实例.
Type
this

moveAbove(keyA, keyBopt) → {this}

Since:
  • 3.2.0
交换场景列表中两个场景的位置,使场景B位于场景a的正上方. 这控制了它们的呈现和更新顺序.
Parameters:
Name Type Attributes Description
keyA string | Phaser.Scene 场景B将被移动到上面的场景.
keyB string | Phaser.Scene <optional>
要移动的场景.如果没有给出,则默认为该场景.
Returns:
这个场景插件实例.
Type
this

moveBelow(keyA, keyBopt) → {this}

Since:
  • 3.2.0
交换场景列表中两个场景的位置,使场景B位于场景a的正下方. 这控制了它们的呈现和更新顺序.
Parameters:
Name Type Attributes Description
keyA string | Phaser.Scene 场景B将被移动到下面的场景.
keyB string | Phaser.Scene <optional>
要移动的场景.如果没有给出,则默认为该场景.
Returns:
这个场景插件实例.
Type
this

moveDown(keyopt) → {this}

Since:
  • 3.0.0
将场景在场景列表中下移一个位置.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景移动.
Returns:
这个场景插件实例.
Type
this

moveUp(keyopt) → {this}

Since:
  • 3.0.0
将场景在场景列表中上移一个位置.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景移动.
Returns:
这个场景插件实例.
Type
this

pause(keyopt, dataopt) → {this}

Since:
  • 3.0.0
暂停场景-这阻止了更新步骤的发生,但它仍然呈现. 这将在下一次场景管理器更新时发生,而不是立即发生.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景暂停.
data object <optional>
一个可选的数据对象,将被传递到场景并在其暂停事件中发出.
Returns:
这个场景插件实例.
Type
this

remove(keyopt) → {this}

Since:
  • 3.2.0
从场景管理器中移除场景. 场景从本地场景数组中移除,其关键点从关键点中清除 缓存和场景.然后调用Systems.destroy. 如果场景管理器在调用此方法时正在处理场景,它将 将下一个更新序列的操作排队.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
要移除的场景.
Returns:
这个场景插件实例.
Type
this

restart(dataopt) → {this}

Since:
  • 3.4.0
重新启动此场景. 这将在下一次场景管理器更新时发生,而不是立即发生.
Parameters:
Name Type Attributes Description
data object <optional>
场景数据.
Returns:
这个场景插件实例.
Type
this

resume(keyopt, dataopt) → {this}

Since:
  • 3.0.0
恢复场景-再次开始更新循环. 这将在下一次场景管理器更新时发生,而不是立即发生.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景恢复.
data object <optional>
一个可选的数据对象,将被传递到场景并在其恢复事件中发出.
Returns:
这个场景插件实例.
Type
this

run(key, dataopt) → {this}

Since:
  • 3.10.0
运行给定场景,但不更改该场景的状态. 这将在下一次场景管理器更新时发生,而不是立即发生. 如果给定场景暂停,它将恢复它.如果睡觉,它会吵醒它. 如果根本不运行,就会启动. 如果你想打开一个模态场景,就使用这个 场景,然后在模态场景上 `run` .
Parameters:
Name Type Attributes Description
key string | Phaser.Scene 要运行的场景.
data object <optional>
将被传递到场景并在其就绪,唤醒或恢复事件中发出的数据对象.
Returns:
这个场景插件实例.
Type
this

sendToBack(keyopt) → {this}

Since:
  • 3.0.0
将场景发送到场景列表的后面. 这意味着它将在所有其他场景下渲染.
Parameters:
Name Type Attributes Description
key string | Phaser.Scene <optional>
场景移动.
Returns:
这个场景插件实例.
Type
this

setActive(value, keyopt, dataopt) → {this}

Since:
  • 3.0.0
设置给定场景的活动状态.
Parameters:
Name Type Attributes Description
value boolean 如果 `true` ,场景将被恢复.如果 `fa