Scenes

Scenes

Type Definitions

CreateSceneFromObjectConfig

Since:
  • 3.17.0
Properties:
Name Type Attributes Description
init Phaser.Types.Scenes.SceneInitCallback <optional>
场景的初始化回调.
preload Phaser.Types.Scenes.ScenePreloadCallback <optional>
场景的预加载回调.
create Phaser.Types.Scenes.SceneCreateCallback <optional>
场景的创建回调.
update Phaser.Types.Scenes.SceneUpdateCallback <optional>
场景的更新回调.参见Phaser.Scene#update.
extend any <optional>
任何附加属性,在创建后将被复制到场景中(除了 `data` 或 `sys` ).
Properties
Name Type Attributes Description
data any <optional>
任何值,这些值将被合并到场景的数据管理器存储中.
Type:
  • object

SceneCreateCallback(data)

Since:
  • 3.0.0
可以在您自己的场景中定义.用它来创建你的游戏对象. 场景开始时,场景管理器会在 `init()` 和 `preload()` 之后调用此方法. 如果LoaderPlugin是在 `preload()` 之后启动的,那么只有在加载完成之后才会调用该方法.
This:
Parameters:
Name Type Description
data object Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.

SceneInitCallback(data)

Since:
  • 3.0.0
可以在您自己的场景中定义. 场景管理器在场景开始时,在 `preload()` 和 `create()` 之前调用此方法.
This:
Parameters:
Name Type Description
data object Any data passed via `ScenePlugin.add()` or `ScenePlugin.start()`. Same as Scene.settings.data.

ScenePreloadCallback()

Since:
  • 3.0.0
可以在您自己的场景中定义.用它来装载资产. 场景管理器在 `init()` 后和z`create()z` 前调用此方法,前提是场景有LoaderPlugin. 此方法完成后,如果加载程序的队列不是空的,加载程序将自动启动.
This:

SceneTransitionConfig

Since:
  • 3.5.0
Properties:
Name Type Attributes Default Description
target string 要过渡到的场景键.
duration number <optional>
1000 转换持续的时间,以毫秒为单位.
sleep boolean <optional>
false 负责过渡的场景会在完成时被发送到睡眠状态( `true` ),还是停止?( `false` )
remove boolean <optional>
false 过渡完成后,负责过渡的场景是否会从场景管理器中删除?
allowInput boolean <optional>
false 场景输入系统能够在转换时处理事件吗?
moveAbove boolean <optional>
在过渡开始之前,将目标场景移动到该场景之上.
moveBelow boolean <optional>
在过渡开始之前,将目标场景移动到此场景之下.
onUpdate function <optional>
在转换期间,每个帧都会调用此回调.
onUpdateScope any <optional>
调用回调的上下文.
data any <optional>
包含您希望传递给目标场景的init / create方法(如果sleep为false)或目标场景的唤醒事件回调(如果sleep为true)的任何数据的对象.
Type:
  • object

SceneUpdateCallback()

Since:
  • 3.0.0
This:

SettingsConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
key string <optional>
这个场景唯一的关键.在整个游戏实例中必须是唯一的.
active boolean <optional>
false 场景是否以活动状态开始?活动场景会更新每个步骤.
visible boolean <optional>
true 场景开始时是否可见?一个可见的场景渲染每一步.
pack false | Phaser.Types.Loader.FileTypes.PackFileSection <optional>
false 场景开始前要加载的文件.
cameras Phaser.Types.Cameras.Scene2D.JSONCamera | Array.<Phaser.Types.Cameras.Scene2D.JSONCamera> <optional>
<nullable>
null 可选的摄像机配置对象.
map Object.<string, string> <optional>
覆盖场景的默认注射贴图.
mapAdd Object.<string, string> <optional>
扩展场景的注入贴图.
physics Phaser.Types.Core.PhysicsConfig <optional>
{} 场景的物理配置对象.
loader Phaser.Types.Core.LoaderConfig <optional>
{} 场景的加载器配置对象.
plugins false | * <optional>
false 场景的插件配置对象.
Type:
  • object

SettingsObject

Since:
  • 3.0.0
Properties:
Name Type Attributes Description
status number 场景的当前状态.映射到场景常量.
key string 这个场景唯一的关键.在整个游戏实例中是唯一的.
active boolean 此场景的活动状态.活动场景会更新每个步骤.
visible boolean 此场景的可见状态.一个可见的场景渲染每一步.
isBooted boolean 场景启动完成了吗?
isTransition boolean 场景是否处于过渡状态?
transitionFrom Phaser.Scene <nullable>
该场景正在转换的场景(如果已设置).
transitionDuration number 过渡的持续时间(如果已设置).
transitionAllowInput boolean 此场景是否允许在过渡期间接收输入?
data object 从场景管理器传递到该场景的数据包.
pack false | Phaser.Types.Loader.FileTypes.PackFileSection 场景开始前要加载的文件.
cameras Phaser.Types.Cameras.Scene2D.JSONCamera | Array.<Phaser.Types.Cameras.Scene2D.JSONCamera> <nullable>
摄像机配置对象.
map Object.<string, string> 场景的注射贴图.
physics Phaser.Types.Core.PhysicsConfig 场景的物理配置对象.
loader Phaser.Types.Core.LoaderConfig 场景的加载器配置对象.
plugins false | * 场景的插件配置对象.
Type:
  • object