Skip to content

Docs: fix the suboptions in GroupCreateConfig #7264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samme wants to merge 1 commit into
base: v4.0.0
Choose a base branch
from
+7 −37
Open

Docs: fix the suboptions in GroupCreateConfig #7264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 7 additions & 37 deletions src/gameobjects/group/typedefs/GroupCreateConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,47 +22,17 @@
* @property {?boolean} [yoyo=false] - Select keys and frames by moving forward then backward through `key` and `frame`.
* @property {?number} [frameQuantity=1] - The number of times each `frame` should be combined with one `key`.
* @property {?number} [max=0] - The maximum number of new Game Objects to create. 0 is no maximum.
* @property {?object} [setXY]
* @property {?number} [setXY.x=0] - The horizontal position of each new Game Object.
* @property {?number} [setXY.y=0] - The vertical position of each new Game Object.
* @property {?number} [setXY.stepX=0] - Increment each Game Object's horizontal position from the previous by this amount, starting from `setXY.x`.
* @property {?number} [setXY.stepY=0] - Increment each Game Object's vertical position from the previous by this amount, starting from `setXY.y`.
* @property {?object} [setRotation]
* @property {?number} [setRotation.value=0] - Rotation of each new Game Object.
* @property {?number} [setRotation.step=0] - Increment each Game Object's rotation from the previous by this amount, starting at `setRotation.value`.
* @property {?object} [setScale]
* @property {?number} [setScale.x=0] - The horizontal scale of each new Game Object.
* @property {?number} [setScale.y=0] - The vertical scale of each new Game Object.
* @property {?number} [setScale.stepX=0] - Increment each Game Object's horizontal scale from the previous by this amount, starting from `setScale.x`.
* @property {?number} [setScale.stepY=0] - Increment each Game object's vertical scale from the previous by this amount, starting from `setScale.y`.
* @property {?object} [setOrigin]
* @property {?number} [setOrigin.x=0] - The horizontal origin of each new Game Object.
* @property {?number} [setOrigin.y=0] - The vertical origin of each new Game Object.
* @property {?number} [setOrigin.stepX=0] - Increment each Game Object's horizontal origin from the previous by this amount, starting from `setOrigin.x`.
* @property {?number} [setOrigin.stepY=0] - Increment each Game object's vertical origin from the previous by this amount, starting from `setOrigin.y`.
* @property {?object} [setAlpha]
* @property {?number} [setAlpha.value=0] - The alpha value of each new Game Object.
* @property {?number} [setAlpha.step=0] - Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.
* @property {?object} [setDepth]
* @property {?number} [setDepth.value=0] - The depth value of each new Game Object.
* @property {?number} [setDepth.step=0] - Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.
* @property {?object} [setScrollFactor]
* @property {?number} [setScrollFactor.x=0] - The horizontal scroll factor of each new Game Object.
* @property {?number} [setScrollFactor.y=0] - The vertical scroll factor of each new Game Object.
* @property {?number} [setScrollFactor.stepX=0] - Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.
* @property {?number} [setScrollFactor.stepY=0] - Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.
* @property {?object} [setXY] - Options as named in {@link Phaser.Actions.SetXY}.
* @property {?object} [setRotation] - Options as named in {@link Phaser.Actions.SetRotation}.
* @property {?object} [setScale] - Options as named in {@link Phaser.Actions.SetScale}.
* @property {?object} [setOrigin] - Options as named in {@link Phaser.Actions.SetOrigin}.
* @property {?object} [setAlpha] - Options as named in {@link Phaser.Actions.SetAlpha}.
* @property {?object} [setDepth] - Options as named in {@link Phaser.Actions.SetDepth}.
* @property {?object} [setScrollFactor] - Options as named in {@link Phaser.Actions.SetScrollFactor}.
* @property {?*} [hitArea] - A geometric shape that defines the hit area for the Game Object.
* @property {?Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - A callback to be invoked when the Game Object is interacted with.
* @property {?(false|Phaser.Types.Actions.GridAlignConfig)} [gridAlign=false] - Align the new Game Objects in a grid using these settings.
*
* @see Phaser.Actions.GridAlign
* @see Phaser.Actions.SetAlpha
* @see Phaser.Actions.SetHitArea
* @see Phaser.Actions.SetRotation
* @see Phaser.Actions.SetScale
* @see Phaser.Actions.SetXY
* @see Phaser.Actions.SetDepth
* @see Phaser.Actions.SetScrollFactor
* @see Phaser.GameObjects.Group#createFromConfig
* @see Phaser.Utils.Array.Range
*/