Types.GameObjects.Group
GroupCallback
<static> GroupCallback
Type: function
Member of: Phaser.Types.GameObjects.Group
Source: src/gameobjects/group/typedefs/GroupCallback.js#L1
Since: 3.0.0
GroupClassTypeConstructor
<static> GroupClassTypeConstructor
Type: function
Member of: Phaser.Types.GameObjects.Group
Source: src/gameobjects/group/typedefs/GroupClassTypeConstructor.js#L1
Since: 3.0.0
GroupConfig
<static> GroupConfig
| name | type | optional | default | description |
|---|---|---|---|---|
| classType | function | Yes | "Sprite" | Sets {@link Phaser.GameObjects.Group#classType}. |
| name | string | Yes | "''" | Sets {@link Phaser.GameObjects.Group#name}. |
| active | boolean | Yes | true | Sets {@link Phaser.GameObjects.Group#active}. |
| maxSize | number | Yes | -1 | Sets {@link Phaser.GameObjects.Group#maxSize}. |
| defaultKey | string | Yes | null | Sets {@link Phaser.GameObjects.Group#defaultKey}. |
| defaultFrame | string | number | Yes | null | Sets {@link Phaser.GameObjects.Group#defaultFrame}. |
| runChildUpdate | boolean | Yes | false | Sets {@link Phaser.GameObjects.Group#runChildUpdate}. |
| createCallback | Phaser.Types.GameObjects.Group.GroupCallback | Yes | null | Sets {@link Phaser.GameObjects.Group#createCallback}. |
| removeCallback | Phaser.Types.GameObjects.Group.GroupCallback | Yes | null | Sets {@link Phaser.GameObjects.Group#removeCallback}. |
| createMultipleCallback | Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback | Yes | null | Sets {@link Phaser.GameObjects.Group#createMultipleCallback}. |
Type: object
Member of: Phaser.Types.GameObjects.Group
Source: src/gameobjects/group/typedefs/GroupConfig.js#L1
Since: 3.0.0
GroupCreateConfig
<static> GroupCreateConfig
The total number of objects created will be
key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)
If max is nonzero, then the total created will not exceed max.
key is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.
| name | type | optional | default | description |
|---|---|---|---|---|
| key | string | Array.<string> | No | The texture key of each new Game Object. Must be provided or not objects will be created. | |
| classType | function | Yes | The class of each new Game Object. | |
| frame | string | Array.<string> | number | Array.<number> | Yes |
| quantity | number | Yes | false | The number of Game Objects to create. If set, this overrides the frameQuantity value. Use frameQuantity for more advanced control. |
| visible | boolean | Yes | true | The visible state of each new Game Object. |
| active | boolean | Yes | true | The active state of each new Game Object. |
| repeat | number | Yes | 0 | The number of times each key × frame combination will be repeated (after the first combination). |
| randomKey | boolean | Yes | false | Select a key at random. |
| randomFrame | boolean | Yes | false | Select a frame at random. |
| yoyo | boolean | Yes | false | Select keys and frames by moving forward then backward through key and frame. |
| frameQuantity | number | Yes | 1 | The number of times each frame should be combined with one key. |
| max | number | Yes | 0 | The maximum number of new Game Objects to create. 0 is no maximum. |
| setXY | object | Yes | Options as named in {@link Phaser.Actions.SetXY}. | |
| setRotation | object | Yes | Options as named in {@link Phaser.Actions.SetRotation}. | |
| setScale | object | Yes | Options as named in {@link Phaser.Actions.SetScale}. | |
| setOrigin | object | Yes | Options as named in {@link Phaser.Actions.SetOrigin}. | |
| setAlpha | object | Yes | Options as named in {@link Phaser.Actions.SetAlpha}. | |
| setDepth | object | Yes | Options as named in {@link Phaser.Actions.SetDepth}. | |
| setScrollFactor | object | Yes | Options as named in {@link Phaser.Actions.SetScrollFactor}. | |
| hitArea | * | Yes | A geometric shape that defines the hit area for the Game Object. | |
| hitAreaCallback | Phaser.Types.Input.HitAreaCallback | Yes | A callback to be invoked when the Game Object is interacted with. | |
| gridAlign | false | Phaser.Types.Actions.GridAlignConfig | Yes | false | Align the new Game Objects in a grid using these settings. |
Type: object
Member of: Phaser.Types.GameObjects.Group
Source: src/gameobjects/group/typedefs/GroupCreateConfig.js#L1
Since: 3.0.0
GroupMultipleCreateCallback
<static> GroupMultipleCreateCallback
Type: function
Member of: Phaser.Types.GameObjects.Group
Source: src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js#L1
Since: 3.0.0