Group

.GameObjects. Group

群组是您创建,操作或回收类似游戏对象的一种方式. 组成员资格是非排他性的.一个游戏对象可以属于几个组,一个组,或者不属于任何组. 群组本身无法显示,也无法定位,旋转,缩放或隐藏.

Constructor

new Group(scene, childrenopt, configopt)

Since:
  • 3.0.0
See:
Parameters:
Name Type Attributes Description
scene Phaser.Scene 这组所属的场景.
children Array.<Phaser.GameObjects.GameObject> | Phaser.Types.GameObjects.Group.GroupConfig | Phaser.Types.GameObjects.Group.GroupCreateConfig <optional>
要添加到该组的游戏对象;或 `config` 参数.
config Phaser.Types.GameObjects.Group.GroupConfig | Phaser.Types.GameObjects.Group.GroupCreateConfig <optional>
该组的设置.如果设置了 `key` ,相位器.组#createMultiple也用这些设置调用.

Extends

Members

active :boolean

Since:
  • 3.0.0
这个群是否运行它的Phaser.GameObjects.Group#preUpdate方法(可以更新任何成员).
Type:
  • boolean

children :Phaser.Structs.Set.<Phaser.GameObjects.GameObject>

Since:
  • 3.0.0
这个团体的成员.
Type:

classType :function

Since:
  • 3.0.0
Default Value:
  • Phaser.GameObjects.Sprite
从中创建新组成员的类.
Type:
  • function

(nullable) createCallback :Phaser.Types.GameObjects.Group.GroupCallback

Since:
  • 3.0.0
添加或创建组成员时要调用的函数.
Type:

(nullable) createMultipleCallback :Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback

Since:
  • 3.0.0
一次创建多个组成员时要调用的函数.
Type:

defaultFrame :string|number

Since:
  • 3.0.0
创建新组成员时使用的默认纹理框架.
Type:
  • string | number

defaultKey :string

Since:
  • 3.0.0
创建新组成员时使用的默认纹理键. 这在Phaser.GameObjects.Group#create 但在Phaser.GameObjects.Group#createMultiple.
Type:
  • string

isParent :boolean

Since:
  • 3.0.0
Default Value:
  • true
将此对象标识为一个组的标志.
Type:
  • boolean

maxSize :number

Since:
  • 3.0.0
Default Value:
  • -1
如果用作池,该组的最大大小.-1是没有限制的.
Type:
  • number

name :string

Since:
  • 3.18.0
Default Value:
  • ''
该组的名称. 默认情况下是空的,Phaser从不填充,这留给开发人员使用.
Type:
  • string

(nullable) removeCallback :Phaser.Types.GameObjects.Group.GroupCallback

Since:
  • 3.0.0
移除组成员时要调用的函数.
Type:

runChildUpdate :boolean

Since:
  • 3.0.0
Default Value:
  • false
See:
是否调用任何成员的更新方法.
Type:
  • boolean

scene :Phaser.Scene

Since:
  • 3.0.0
这个组属于这个场景.
Type:

type :string

Since:
  • 3.21.0
Default Value:
  • 'Group'
此游戏对象的文本表示. 由Phaser内部使用,但可用于您自己的自定义类来填充.
Type:
  • string

Methods

add(child, addToSceneopt) → {this}

Since:
  • 3.0.0
向该组添加游戏对象. 调用Phaser.GameObjects.Group#createCallback.
Parameters:
Name Type Attributes Default Description
child Phaser.GameObjects.GameObject 要添加的游戏对象.
addToScene boolean <optional>
false 也添加游戏对象到场景中.
Returns:
此组对象.
Type
this

addListener(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

addMultiple(children, addToSceneopt) → {this}

Since:
  • 3.0.0
向该组添加几个游戏对象. 调用Phaser.GameObjects.Group#createCallback.
Parameters:
Name Type Attributes Default Description
children Array.<Phaser.GameObjects.GameObject> 要添加的游戏对象.
addToScene boolean <optional>
false 也添加游戏对象到场景中.
Returns:
这个群体.
Type
this

angle(value, stepopt) → {this}

Since:
  • 3.21.0
设置每个组成员的角度.
Parameters:
Name Type Attributes Default Description
value number 要设置角度的量,以度为单位.
step number <optional>
0 这被加到 `value` 量上,乘以迭代计数器.
Returns:
此组对象.
Type
this

clear(removeFromSceneopt, destroyChildopt) → {this}

Since:
  • 3.0.0
删除该组的所有成员,并可选择将其从场景中删除和/或销毁. 不调用Phaser.GameObjects.Group#removeCallback.
Parameters:
Name Type Attributes Default Description
removeFromScene boolean <optional>
false 选择性地从场景中移除每个组成员.
destroyChild boolean <optional>
false 可以选择对删除的组成员调用销毁.
Returns:
这个群体.
Type
this

contains(child) → {boolean}

Since:
  • 3.0.0
测试游戏对象是否是该组的成员.
Parameters:
Name Type Description
child Phaser.GameObjects.GameObject 一个游戏对象.
Returns:
如果游戏对象是该组的成员,则为True.
Type
boolean

countActive(valueopt) → {number}

Since:
  • 3.0.0
计算活动(或非活动)组成员的数量.
Parameters:
Name Type Attributes Default Description
value boolean <optional>
true 统计活动(真)或非活动(假)组成员.
Returns:
活动状态与 `active` 参数匹配的组成员数.
Type
number

create(xopt, yopt, keyopt, frameopt, visibleopt, activeopt) → {any}

Since:
  • 3.0.0
创建一个新的游戏对象并将其添加到该组,除非该组is full. 调用Phaser.GameObjects.Group#createCallback.
Parameters:
Name Type Attributes Default Description
x number <optional>
0 新游戏对象在世界上的水平位置.
y number <optional>
0 新游戏对象在世界上的垂直位置.
key string <optional>
defaultKey 新游戏对象的纹理键.
frame string | number <optional>
defaultFrame 新游戏对象的纹理框架.
visible boolean <optional>
true The Phaser.GameObjects.Components.Visible#visible 新游戏对象的状态.
active boolean <optional>
true The Phaser.GameObjects.GameObject#active 新游戏对象的状态.
Returns:
新的游戏对象(通常是精灵等).
Type
any

createFromConfig(options) → {Array.<any>}

Since:
  • 3.0.0
Parameters:
Name Type Description
options Phaser.Types.GameObjects.Group.GroupCreateConfig 创建设置.
Returns:
新创建的游戏对象.
Type
Array.<any>

createMultiple(config) → {Array.<any>}

Since:
  • 3.0.0
创建几个游戏对象并将它们添加到该组. 如果群变成Phaser.GameObjects.Group#isFull,不再创建游戏对象. 调用Phaser.GameObjects.Group#createMultipleCallbackPhaser.GameObjects.Group#createCallback.
Parameters:
Name Type Description
config Phaser.Types.GameObjects.Group.GroupCreateConfig | Array.<Phaser.Types.GameObjects.Group.GroupCreateConfig> 创建设置.这可以是单个配置对象,也可以是一组这样的对象,它们将依次应用.
Returns:
新创建的游戏对象.
Type
Array.<any>

destroy(destroyChildrenopt, removeFromSceneopt)

Since:
  • 3.0.0
Overrides:
清空该组的所有子对象,并将其从场景中移除. 不调用Phaser.GameObjects.Group#removeCallback. 通过调用此方法,不会将该组的子代从场景中移除 除非您指定了 `removeFromScene` 参数. 该组的子代也不会通过调用此方法而被销毁 除非您指定 `destroyChildren` 参数.
Parameters:
Name Type Attributes Default Description
destroyChildren boolean <optional>
false Also Phaser.GameObjects.GameObject#destroy 每个小组成员.
removeFromScene boolean <optional>
false 选择性地从场景中移除每个组成员.

emit(event, …argsopt) → {boolean}

Since:
  • 3.0.0
Inherited From:
调用为给定事件注册的每个侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
args * <optional>
<repeatable>
将传递给事件处理程序的附加参数.
Returns:
`true` 如果事件有侦听器,则为 `false` .
Type
boolean