Events

.Scenes. Events

Events

ADDED_TO_SCENE

Since:
  • 3.50.0
游戏对象添加到场景事件. 当游戏对象被添加到场景中时,调度该事件. 听一个场景,使用`this.events.on('addedtoscene', listener)`.
Parameters:
Name Type Description
gameObject Phaser.GameObjects.GameObject 添加到场景中的游戏对象.
scene Phaser.Scene 添加游戏对象的场景.

BOOT

Since:
  • 3.0.0
场景系统启动事件. 此事件由场景在场景系统引导过程中调度.主要由场景插件使用. 听它从一个场景使用`this.events.on('boot', listener)`.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.

CREATE

Since:
  • 3.17.0
场景创建事件. 此事件由场景管理器创建后,由场景调度. 如果一个场景有一个 `create` 方法,那么这个事件将在运行后发出. 如果有一个转换,该事件将在 `TRANSITION_START` 事件之后触发. 听它从一个场景使用`this.events.on('create', listener)`.
Parameters:
Name Type Description
scene Phaser.Scene 对发出此事件的场景的引用.

DESTROY

Since:
  • 3.0.0
场景系统破坏事件. 在场景系统销毁过程中,该事件由场景调度. 听它从一个场景使用`this.events.on('destroy', listener)`. 您应该在此事件处理程序中销毁场景可能正在使用的任何资源.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.

PAUSE

Since:
  • 3.0.0
场景系统暂停事件. 此事件由场景在暂停时调度,或者直接通过 `pause` 方法调度,或者作为 另一个场景中的动作. 听它从一个场景使用`this.events.on('pause', listener)`.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
暂停时传递给此场景的可选数据对象.

POST_UPDATE

Since:
  • 3.0.0
场景系统更新后事件. 此事件由场景在主游戏循环步骤中调度. 场景的单个步骤的事件流程如下: 1. PRE_UPDATE 2. UPDATE 3. 如果存在的话,调用 `Scene.update` 方法 4. POST_UPDATE 5. PRE_RENDER 6. RENDER 听它从一个场景使用`this.events.on('postupdate', listener)`. 场景只有在活动时才会运行其步骤.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
time number 当前时间.如果来自请求动画帧,则为高分辨率计时器值,如果使用设置时间输出,则为日期.
delta number 自上一帧以来的增量时间(毫秒).这是一个基于FPS速率的平滑且有上限的值.

PRE_RENDER

Since:
  • 3.53.0
场景系统预渲染事件. 此事件由场景在主游戏循环步骤中调度. 场景的单个步骤的事件流程如下: 1. PRE_UPDATE 2. UPDATE 3. 如果存在的话,调用 `Scene.update` 方法 4. POST_UPDATE 5. PRE_RENDER 6. RENDER 使用从场景中收听此事件`this.events.on('prerender', listener)`. 场景只有在可见时才会渲染. 此事件在场景显示列表排序后和场景渲染前调度.
Parameters:
Name Type Description
renderer Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer 渲染场景的渲染器.

PRE_UPDATE

Since:
  • 3.0.0
场景系统预更新事件. 此事件由场景在主游戏循环步骤中调度. 场景的单个步骤的事件流程如下: 1. PRE_UPDATE 2. UPDATE 3. 如果存在的话,调用 `Scene.update` 方法 4. POST_UPDATE 5. PRE_RENDER 6. RENDER 听它从一个场景使用`this.events.on('preupdate', listener)`. 场景只有在活动时才会运行其步骤.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
time number 当前时间.如果来自请求动画帧,则为高分辨率计时器值,如果使用设置时间输出,则为日期.
delta number 自上一帧以来的增量时间(毫秒).这是一个基于FPS速率的平滑且有上限的值.

READY

Since:
  • 3.0.0
场景系统就绪事件. 此事件由场景在场景系统启动过程中调度. 在这个过程中,场景现在是完全活跃和渲染. 这个事件是给你的游戏代码使用的,因为所有插件都响应了之前的 `start` 事件. 听它从一个场景使用`this.events.on('ready', listener)`.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
启动时传递给此场景的可选数据对象.

REMOVED_FROM_SCENE

Since:
  • 3.50.0
从场景事件中移除的游戏对象. 当游戏对象从场景中移除时,调度此事件. 听一个场景,使用`this.events.on('removedfromscene', listener)`.
Parameters:
Name Type Description
gameObject Phaser.GameObjects.GameObject 从场景中移除的游戏对象.
scene Phaser.Scene 从其中移除游戏对象的场景.

RENDER

Since:
  • 3.0.0
场景系统渲染事件. 此事件由场景在主游戏循环步骤中调度. 场景的单个步骤的事件流程如下: 1. PRE_UPDATE 2. UPDATE 3. 如果存在的话,调用 `Scene.update` 方法 4. POST_UPDATE 5. PRE_RENDER 6. RENDER 听它从一个场景使用`this.events.on('render', listener)`. 场景只有在可见时才会渲染. 当此事件被调度时,场景将已经被渲染.
Parameters:
Name Type Description
renderer Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer 渲染场景的渲染器.

RESUME

Since:
  • 3.0.0
场景系统恢复事件. 当场景从暂停状态恢复时,该事件由场景调度,或者直接通过 `resume` 方法, 或者作为另一个场景中的动作. 听它从一个场景使用`this.events.on('resume', listener)`.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
恢复时传递给此场景的可选数据对象.

SHUTDOWN

Since:
  • 3.0.0
现场系统关闭事件. 此事件由场景在场景系统关闭过程中调度. 听它从一个场景使用`this.events.on('shutdown', listener)`. 您应该在这个事件处理程序中释放您的场景可能正在使用的任何资源,基于这样的理解 场景可以随时再次激活.一个关闭的场景不是`混乱`,它根本不是 当前活动.使用DESTRUCT事件来完全清除资源.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
关闭时传递给此场景的可选数据对象.

SLEEP

Since:
  • 3.0.0
场景系统睡眠事件. 当场景被发送到睡眠时,该事件由场景调度,或者直接通过 `sleep` 方法, 或者作为另一个场景中的动作. 听它从一个场景使用`this.events.on('sleep', listener)`.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
一个可选的数据对象,它在发送到睡眠状态时被传递到此场景.

START

Since:
  • 3.0.0
场景系统启动事件. 此事件由场景在场景系统启动过程中调度.主要由场景插件使用. 听它从一个场景使用`this.events.on('start', listener)`.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.

TRANSITION_COMPLETE

Since:
  • 3.5.0
场景转换完成事件. 此事件由过渡的目标场景调度. 当转换过程完成时就会发生.当持续时间计时器等于或超过持续时间时,就会发生这种情况 过渡时期. 听它从一个场景使用`this.events.on('transitioncomplete', listener)`. 场景转换事件流程如下: 1. TRANSITION_OUT - 开始转换的场景将发出此事件. 2. TRANSITION_INIT - 如果目标场景有一个 `init` 方法,它将发出这个事件. 3. TRANSITION_START - 目标场景将在调用其`create`方法后发出此事件,或... 4. TRANSITION_WAKE - 如果目标场景处于睡眠状态,并且已经被唤醒以进行转换,它将发出此事件. 5. TRANSITION_COMPLETE - 过渡完成时,目标场景将发出此事件.
Parameters:
Name Type Description
scene Phaser.Scene The Scene on which the transitioned completed.

TRANSITION_INIT

Since:
  • 3.5.0
场景转换初始化事件. 此事件由过渡的目标场景调度. 它在调用 `Scene.init` 方法后立即发生.如果场景没有 `init` 方法, 此事件不会被调度. 听它从一个场景使用`this.events.on('transitioninit', listener)`. 场景转换事件流程如下: 1. TRANSITION_OUT - 开始转换的场景将发出此事件. 2. TRANSITION_INIT - 如果目标场景有一个 `init` 方法,它将发出这个事件. 3. TRANSITION_START - 目标场景将在调用其`create`方法后发出此事件,或... 4. TRANSITION_WAKE - 如果目标场景处于睡眠状态,并且已经被唤醒以进行转换,它将发出此事件. 5. TRANSITION_COMPLETE - 过渡完成时,目标场景将发出此事件.
Parameters:
Name Type Description
from Phaser.Scene 对正在转换的场景的引用.
duration number 以毫秒为单位的转换持续时间.

TRANSITION_OUT

Since:
  • 3.5.0
场景转换事件. 当场景启动到另一个场景的转换时,该事件由场景调度. 听它从一个场景使用`this.events.on('transitionout', listener)`. 场景转换事件流程如下: 1. TRANSITION_OUT - 开始转换的场景将发出此事件. 2. TRANSITION_INIT - 如果目标场景有一个 `init` 方法,它将发出这个事件. 3. TRANSITION_START - 目标场景将在调用其`create`方法后发出此事件,或... 4. TRANSITION_WAKE - 如果目标场景处于睡眠状态,并且已经被唤醒以进行转换,它将发出此事件. 5. TRANSITION_COMPLETE - 过渡完成时,目标场景将发出此事件.
Parameters:
Name Type Description
target Phaser.Scene 对正在转换到的场景的引用.
duration number 以毫秒为单位的转换持续时间.

TRANSITION_START

Since:
  • 3.5.0
场景转换开始事件. 此事件由过渡的目标场景调度,仅当该场景未处于睡眠状态时. 它在调用 `Scene.create` 方法后立即发生.如果场景没有 `create` 方法, 无论如何都会调度此事件. 如果目标场景正在休眠,则TRANSITION_WAKE事件为 调度而不是此事件. 听它从一个场景使用`this.events.on('transitionstart', listener)`. 场景转换事件流程如下: 1. TRANSITION_OUT - 开始转换的场景将发出此事件. 2. TRANSITION_INIT - 如果目标场景有一个 `init` 方法,它将发出这个事件. 3. TRANSITION_START - 目标场景将在调用其`create`方法后发出此事件,或... 4. TRANSITION_WAKE - 如果目标场景处于睡眠状态,并且已经被唤醒以进行转换,它将发出此事件. 5. TRANSITION_COMPLETE - 过渡完成时,目标场景将发出此事件.
Parameters:
Name Type Description
from Phaser.Scene 对正在转换的场景的引用.
duration number 以毫秒为单位的转换持续时间.

TRANSITION_WAKE

Since:
  • 3.5.0
场景转换唤醒事件. 此事件由过渡的目标场景调度,前提是该场景之前处于睡眠状态 转变开始了.如果场景没有进入睡眠状态,请使用跃迁_开始事件. 听它从一个场景使用`this.events.on('transitionwake', listener)`. 场景转换事件流程如下: 1. TRANSITION_OUT - 开始转换的场景将发出此事件. 2. TRANSITION_INIT - 如果目标场景有一个 `init` 方法,它将发出这个事件. 3. TRANSITION_START - 目标场景将在调用其`create`方法后发出此事件,或... 4. TRANSITION_WAKE - 如果目标场景处于睡眠状态,并且已经被唤醒以进行转换,它将发出此事件. 5. TRANSITION_COMPLETE - 过渡完成时,目标场景将发出此事件.
Parameters:
Name Type Description
from Phaser.Scene 对正在转换的场景的引用.
duration number 以毫秒为单位的转换持续时间.

UPDATE

Since:
  • 3.0.0
场景系统更新事件. 此事件由场景在主游戏循环步骤中调度. 场景的单个步骤的事件流程如下: 1. PRE_UPDATE 2. UPDATE 3. 如果存在的话,调用 `Scene.update` 方法 4. POST_UPDATE 5. PRE_RENDER 6. RENDER 听它从一个场景使用`this.events.on('update', listener)`. 场景只有在活动时才会运行其步骤.
Parameters:
Name Type Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
time number 当前时间.如果来自请求动画帧,则为高分辨率计时器值,如果使用设置时间输出,则为日期.
delta number 自上一帧以来的增量时间(毫秒).这是一个基于FPS速率的平滑且有上限的值.

WAKE

Since:
  • 3.0.0
场景系统唤醒事件. 当场景从睡眠中被唤醒时,该事件由场景调度,或者直接通过 `wake` 方法, 或者作为另一个场景中的动作. 听它从一个场景使用`this.events.on('wake', listener)`.
Parameters:
Name Type Attributes Description
sys Phaser.Scenes.Systems 对发出此事件的场景的场景系统类的引用.
data any <optional>
一个可选的数据对象,当它被唤醒时被传递到这个场景.