Skip to content

Commit 6d588c4

Browse files
authored
Merge pull request phaserjs#4559 from samme/types/GroupCreateConfig
Correct types for GroupCreateConfig.key, GroupCreateConfig.frame
2 parents b649ec3 + 84e4767 commit 6d588c4

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

src/gameobjects/group/typedefs/GroupCreateConfig.js

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,16 @@
33
*
44
* key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)
55
*
6-
* In the simplest case, 1 + `repeat` objects will be created.
7-
*
8-
* If `max` is positive, then the total created will not exceed `max`.
6+
* If `max` is nonzero, then the total created will not exceed `max`.
97
*
108
* `key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.
11-
*
9+
*
1210
* @typedef {object} Phaser.Types.GameObjects.Group.GroupCreateConfig
1311
* @since 3.0.0
1412
*
1513
* @property {?Phaser.Types.GameObjects.Group.GroupClassTypeConstructor} [classType] - The class of each new Game Object.
16-
* @property {string} [key] - The texture key of each new Game Object.
17-
* @property {?(string|integer)} [frame=null] - The texture frame of each new Game Object.
14+
* @property {(string|string[])} [key] - The texture key of each new Game Object.
15+
* @property {?(string|string[]|integer|integer[])} [frame=null] - The texture frame of each new Game Object.
1816
* @property {?boolean} [visible=true] - The visible state of each new Game Object.
1917
* @property {?boolean} [active=true] - The active state of each new Game Object.
2018
* @property {?number} [repeat=0] - The number of times each `key` × `frame` combination will be *repeated* (after the first combination).

0 commit comments

Comments
 (0)