Group

.GameObjects. Group

Type Definitions

GroupCallback(item)

Since:
  • 3.0.0
Parameters:
Name Type Description
item Phaser.GameObjects.GameObject A group member

GroupConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
classType function <optional>
<nullable>
Sprite Sets Phaser.GameObjects.Group#classType.
name string <optional>
<nullable>
'' Sets Phaser.GameObjects.Group#name.
active boolean <optional>
<nullable>
true Sets Phaser.GameObjects.Group#active.
maxSize number <optional>
<nullable>
-1 Sets Phaser.GameObjects.Group#maxSize.
defaultKey string <optional>
<nullable>
null Sets Phaser.GameObjects.Group#defaultKey.
defaultFrame string | number <optional>
<nullable>
null Sets Phaser.GameObjects.Group#defaultFrame.
runChildUpdate boolean <optional>
<nullable>
false Sets Phaser.GameObjects.Group#runChildUpdate.
createCallback Phaser.Types.GameObjects.Group.GroupCallback <optional>
<nullable>
null Sets Phaser.GameObjects.Group#createCallback.
removeCallback Phaser.Types.GameObjects.Group.GroupCallback <optional>
<nullable>
null Sets Phaser.GameObjects.Group#removeCallback.
createMultipleCallback Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback <optional>
<nullable>
null Sets Phaser.GameObjects.Group#createMultipleCallback.
Type:
  • object

GroupCreateConfig

Since:
  • 3.0.0
See:
Properties:
Name Type Attributes Default Description
classType function <optional>
<nullable>
每个新游戏对象的类别.
key string | Array.<string> <optional>
每个新游戏对象的纹理键.
frame string | Array.<string> | number | Array.<number> <optional>
<nullable>
null 每个新游戏对象的纹理框架.
quantity number <optional>
<nullable>
false 要创建的游戏对象的数量.如果设置,这将覆盖 `frameQuantity` 值.使用 `frameQuantity` 进行更高级的控制.
visible boolean <optional>
<nullable>
true 每个新游戏对象的可见状态.
active boolean <optional>
<nullable>
true 每个新游戏对象的活动状态.
repeat number <optional>
<nullable>
0 每个 `key` × `frame` 组合将被*重复的次数*(在第一个组合之后).
randomKey boolean <optional>
<nullable>
false 随机选择一个 `key` .
randomFrame boolean <optional>
<nullable>
false 随机选择一个 `frame` .
yoyo boolean <optional>
<nullable>
false 通过 `key` 和 `frame` 向前然后向后移动来选择关键点和帧.
frameQuantity number <optional>
<nullable>
1 每个 `frame` 应与一个 `key` 组合的次数.
max number <optional>
<nullable>
0 要创建的新游戏对象的最大数量.0不是最大值.
setXY object <optional>
<nullable>
Properties
Name Type Attributes Default Description
x number <optional>
<nullable>
0 每个新游戏对象的水平位置.
y number <optional>
<nullable>
0 每个新游戏对象的垂直位置.
stepX number <optional>
<nullable>
0 从 `setXY.x` 开始,将每个游戏对象的水平位置从上一个位置增加这个量.
stepY number <optional>
<nullable>
0 从 `setXY.y` 开始,将每个游戏对象的垂直位置从上一个位置增加这个量.
setRotation object <optional>
<nullable>
Properties
Name Type Attributes Default Description
value number <optional>
<nullable>
0 每个新游戏对象的旋转.
step number <optional>
<nullable>
0 将每个游戏对象的旋转从上一个增加这个数量,从 `setRotation.value` 开始.
setScale object <optional>
<nullable>
Properties
Name Type Attributes Default Description
x number <optional>
<nullable>
0 每个新游戏对象的水平比例.
y number <optional>
<nullable>
0 每个新游戏对象的垂直比例.
stepX number <optional>
<nullable>
0 从`setScale.x`开始,将每个游戏对象的水平比例从上一个增加这个数量.
stepY number <optional>
<nullable>
0 从 `setScale.y` 开始,将每个游戏对象的垂直比例从上一个增加这个量.
setOrigin object <optional>
<nullable>
Properties
Name Type Attributes Default Description
x number <optional>
<nullable>
0 每个新游戏对象的水平原点.
y number <optional>
<nullable>
0 每个新游戏对象的垂直原点.
stepX number <optional>
<nullable>
0 从 `setOrigin.x` 开始,将每个游戏对象的水平原点从上一个开始递增这个量.
stepY number <optional>
<nullable>
0 从 `setOrigin.y` 开始,将每个游戏对象的垂直原点从上一个增加这个量.
setAlpha object <optional>
<nullable>
Properties
Name Type Attributes Default Description
value number <optional>
<nullable>
0 每个新游戏对象的阿尔法值.
step number <optional>
<nullable>
0 从 `setAlpha.value` 开始,将每个游戏对象的alpha值从之前的值增加这个值.
setDepth object <optional>
<nullable>
Properties
Name Type Attributes Default Description
value number <optional>
<nullable>
0 每个新游戏对象的深度值.
step number <optional>
<nullable>
0 将每个游戏对象的深度从上一个增加这个量,从`setDepth.value`开始.
setScrollFactor object <optional>
<nullable>
Properties
Name Type Attributes Default Description
x number <optional>
<nullable>
0 每个新游戏对象的水平滚动系数.
y number <optional>
<nullable>
0 每个新游戏对象的垂直滚动因子.
stepX number <optional>
<nullable>
0 从 `setScrollFactor.x` 开始,将每个游戏对象的水平滚动因子从上一个增加这个量.
stepY number <optional>
<nullable>
0 从 `setScrollFactor.y` 开始,将每个游戏对象的垂直滚动因子从上一个增加这个量.
hitArea * <optional>
<nullable>
定义游戏对象命中区域的几何形状.
hitAreaCallback Phaser.Types.Input.HitAreaCallback <optional>
<nullable>
当与游戏对象交互时调用的回调.
gridAlign false | Phaser.Types.Actions.GridAlignConfig <optional>
<nullable>
false 使用这些设置在网格中对齐新的游戏对象.
创建的对象总数将为 key.length * frame.length * frame quantity *(yoyo?2 : 1) * (1 +重复) If `max` is nonzero, then the total created will not exceed `max`. `key` is required. Phaser.GameObjects.Group#defaultKey is not used.
Type:
  • object

GroupMultipleCreateCallback(items)

Since:
  • 3.0.0
Parameters:
Name Type Description
items Array.<Phaser.GameObjects.GameObject> The newly created group members