Filter
Phaser . Physics . Arcade . StaticGroup
Phaser . Physics . Arcade . StaticGroup
An Arcade Physics Static Group object.
All Game Objects created by or added to this Group will automatically be given static Arcade Physics bodies, if they have no body.
Its dynamic counterpart is Phaser.Physics.Arcade.Group.
Constructor:
new StaticGroup(world, scene, [children], [config])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| world | Phaser.Physics.Arcade.World |
The physics simulation. |
|
| scene | Phaser.Scene |
The scene this group belongs to. |
|
| children | Array.<Phaser.GameObjects.GameObject> | Phaser.Types.GameObjects.Group.GroupConfig | Phaser.Types.GameObjects.Group.GroupCreateConfig | <optional> |
Game Objects to add to this group; or the |
| config | Phaser.Types.GameObjects.Group.GroupConfig | Phaser.Types.GameObjects.Group.GroupCreateConfig | <optional> |
Settings for this group. |
Extends
Members
Description:
Whether this group runs its Phaser.GameObjects.Group#preUpdate method (which may update any members).
Type:
Description:
Members of this group.
Description:
The class to create new group members from.
Type:
Description:
The Arcade Physics Static Group Collision Category.
This can be set to any valid collision bitfield value.
See the setCollisionCategory method for more details.
Type:
Description:
The Arcade Physics Static Group Collision Mask.
See the setCollidesWith method for more details.
Type:
Description:
A function to be called when adding or creating group members.
Description:
A function to be called when creating several group members at once.
Description:
A default texture frame to use when creating new group members.
Type:
Description:
A default texture key to use when creating new group members.
This is used in Phaser.GameObjects.Group#create but not in Phaser.GameObjects.Group#createMultiple.
Type:
Description:
A flag identifying this object as a group.
Type:
Description:
The maximum size of this group, if used as a pool. -1 is no limit.
Type:
Description:
The name of this group. Empty by default and never populated by Phaser, this is left for developers to use.
Type:
Description:
The scene this group belongs to.
Type:
Description:
A function to be called when removing group members.
Description:
Whether to call the update method of any members.
Type:
Description:
This scene this group belongs to.
Type:
Description:
A textual representation of this Game Object. Used internally by Phaser but is available for your own custom classes to populate.
Type:
Methods
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| child | Phaser.GameObjects.GameObject |
The Game Object to add. |
||
| addToScene | boolean | <optional> | false |
Also add the Game Object to the scene. |
Returns:
Description:
This Group object.
Description:
Adds the given Collision Category to the list of those that this Arcade Physics Body will collide with.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category to add. |
Returns:
Description:
This Game Object.
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Adds several Game Objects to this group.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| children | Array.<Phaser.GameObjects.GameObject> |
The Game Objects to add. |
||
| addToScene | boolean | <optional> | false |
Also add the Game Objects to the scene. |
Returns:
Description:
This group.
Description:
Sets the angle of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the angle to, in degrees. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Removes all members of this Group and optionally removes them from the Scene and / or destroys them.
Does not call Phaser.GameObjects.Group#removeCallback.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| removeFromScene | boolean | <optional> | false |
Optionally remove each Group member from the Scene. |
| destroyChild | boolean | <optional> | false |
Optionally call destroy on the removed Group members. |
Returns:
Description:
This group.
Description:
Tests if a Game Object is a member of this group.
Parameters:
| name | type | description |
|---|---|---|
| child | Phaser.GameObjects.GameObject |
A Game Object. |
Returns:
Description:
True if the Game Object is a member of this group.
Type:
- boolean
Description:
Counts the number of active (or inactive) group members.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| value | boolean | <optional> | true |
Count active (true) or inactive (false) group members. |
Returns:
Description:
The number of group members with an active state matching the active argument.
Type:
- number
Description:
Creates a new Game Object and adds it to this group, unless the group is.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number | <optional> | 0 |
The horizontal position of the new Game Object in the world. |
| y | number | <optional> | 0 |
The vertical position of the new Game Object in the world. |
| key | string | <optional> | defaultKey |
The texture key of the new Game Object. |
| frame | string | number | <optional> | defaultFrame |
The texture frame of the new Game Object. |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object. |
| active | boolean | <optional> | true |
The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object. |
Returns:
Description:
The new Game Object (usually a Sprite, etc.).
Type:
- any
Description:
Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.
Parameters:
| name | type | description |
|---|---|---|
| child | Phaser.GameObjects.GameObject |
The new group member. |
Description:
A helper for Phaser.GameObjects.Group#createMultiple.
Parameters:
| name | type | description |
|---|---|---|
| options | Phaser.Types.GameObjects.Group.GroupCreateConfig |
Creation settings. |
Returns:
Description:
The newly created Game Objects.
Type:
-
Array.
Description:
Creates several Game Objects and adds them to this group.
If the group becomes Phaser.GameObjects.Group#isFull, no further Game Objects are created.
Calls Phaser.GameObjects.Group#createMultipleCallback and Phaser.GameObjects.Group#createCallback.
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Types.GameObjects.Group.GroupCreateConfig | Array.<Phaser.Types.GameObjects.Group.GroupCreateConfig> |
Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn. |
Returns:
Description:
The newly created Game Objects.
Type:
-
Array.
Description:
Refreshes the group.
Parameters:
| name | type | description |
|---|---|---|
| entries | Array.<Phaser.GameObjects.GameObject> |
The newly created group members. |
Description:
Empties this Group of all children and removes it from the Scene.
Does not call Phaser.GameObjects.Group#removeCallback.
Children of this Group will not be removed from the Scene by calling this method
unless you specify the removeFromScene parameter.
Children of this Group will also not be destroyed by calling this method
unless you specify the destroyChildren parameter.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| destroyChildren | boolean | <optional> | false |
Also {@link Phaser.GameObjects.GameObject#destroy} each Group member. |
| removeFromScene | boolean | <optional> | false |
Optionally remove each Group member from the Scene. |
Description:
Calls each of the listeners registered for a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| args | * | <optional> |
Additional arguments that will be passed to the event handler. |
Returns:
Description:
true if the event had listeners, else false.
Type:
- boolean
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Scans the group for the first member that has an Phaser.GameObjects.GameObject#active state set to false,
assigns x and y, and returns the member.
If no inactive member is found and the group isn't full then it will create a new Game Object using x, y, key, frame, and visible.
The new Game Object will have its active state set to true.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first inactive group member, or a newly created member, or null.
Type:
- any
Description:
All members of the group.
Returns:
Description:
The group members.
Type:
- Array.<Phaser.GameObjects.GameObject>
Description:
Scans the Group, from top to bottom, for the first member that has an Phaser.GameObjects.GameObject#active state matching the argument,
assigns x and y, and returns the member.
If no matching member is found and createIfNull is true and the group isn't full then it will create a new Game Object using x, y, key, frame, and visible.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| state | boolean | <optional> | false |
The {@link Phaser.GameObjects.GameObject#active} value to match. |
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first matching group member, or a newly created member, or null.
Type:
- any
Description:
Scans the group for the first member that has an Phaser.GameObjects.GameObject#active state set to true,
assigns x and y, and returns the member.
If no active member is found and createIfNull is true and the group isn't full then it will create a new one using x, y, key, frame, and visible.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first active group member, or a newly created member, or null.
Type:
- any
Description:
Scans the group for the first member that has an Phaser.GameObjects.GameObject#active state set to false,
assigns x and y, and returns the member.
If no inactive member is found and createIfNull is true and the group isn't full then it will create a new one using x, y, key, frame, and visible.
The new Game Object will have an active state set to true.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first inactive group member, or a newly created member, or null.
Type:
- any
Description:
Scans the Group, from top to bottom, for the nth member that has an Phaser.GameObjects.GameObject#active state matching the argument,
assigns x and y, and returns the member.
If no matching member is found and createIfNull is true and the group isn't full then it will create a new Game Object using x, y, key, frame, and visible.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| nth | number |
The nth matching Group member to search for. |
||
| state | boolean | <optional> | false |
The {@link Phaser.GameObjects.GameObject#active} value to match. |
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first matching group member, or a newly created member, or null.
Type:
- any
Description:
Scans the Group for the last member that has an Phaser.GameObjects.GameObject#active state matching the argument,
assigns x and y, and returns the member.
If no matching member is found and createIfNull is true and the group isn't full then it will create a new Game Object using x, y, key, frame, and visible.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| state | boolean | <optional> | false |
The {@link Phaser.GameObjects.GameObject#active} value to match. |
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first matching group member, or a newly created member, or null.
Type:
- any
Description:
Scans the Group for the last nth member that has an Phaser.GameObjects.GameObject#active state matching the argument,
assigns x and y, and returns the member.
If no matching member is found and createIfNull is true and the group isn't full then it will create a new Game Object using x, y, key, frame, and visible.
Unless a new member is created, key, frame, and visible are ignored.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| nth | number |
The nth matching Group member to search for. |
||
| state | boolean | <optional> | false |
The {@link Phaser.GameObjects.GameObject#active} value to match. |
| createIfNull | boolean | <optional> | false |
Create a new Game Object if no matching members are found, using the following arguments. |
| x | number | <optional> |
The horizontal position of the Game Object in the world. |
|
| y | number | <optional> |
The vertical position of the Game Object in the world. |
|
| key | string | <optional> | defaultKey |
The texture key assigned to a new Game Object (if one is created). |
| frame | string | number | <optional> | defaultFrame |
A texture frame assigned to a new Game Object (if one is created). |
| visible | boolean | <optional> | true |
The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created). |
Returns:
Description:
The first matching group member, or a newly created member, or null.
Type:
- any
Description:
The number of members of the group.
Type:
- number
Description:
Returns all children in this Group that match the given criteria based on the property and value arguments.
For example: getMatching('visible', true) would return only children that have their visible property set.
Optionally, you can specify a start and end index. For example if the Group has 100 elements,
and you set startIndex to 0 and endIndex to 50, it would return matches from only
the first 50.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| property | string | <optional> |
The property to test on each array element. |
| value | * | <optional> |
The value to test the property against. Must pass a strict ( |
| startIndex | number | <optional> |
An optional start index to search from. |
| endIndex | number | <optional> |
An optional end index to search to. |
Returns:
Description:
An array of matching Group members. The array will be empty if nothing matched.
Type:
-
Array.
Description:
The difference of Phaser.GameObjects.Group#maxSize and the number of active group members.
This represents the number of group members that could be created or reactivated before reaching the size limit.
Returns:
Description:
maxSize minus the number of active group numbers; or a large number (if maxSize is -1).
Type:
- number
Description:
Counts the number of in-use (active) group members.
Returns:
Description:
The number of group members with an active state of true.
Type:
- number
Description:
Adds the given value to the x of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to be added to the |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Adds the given value to the x, y of each group member.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The amount to be added to the |
||
| y | number | <optional> | x |
The amount to be added to the |
| stepX | number | <optional> | 0 |
This is added to the |
| stepY | number | <optional> | 0 |
This is added to the |
Returns:
Description:
This Group object.
Description:
Adds the given value to the y of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to be added to the |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Whether this group's size at its maximum.
Returns:
Description:
True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}.
Type:
- boolean
Description:
Deactivates a member of this group.
Parameters:
| name | type | description |
|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
A member of this group. |
Description:
Deactivates and hides a member of this group.
Parameters:
| name | type | description |
|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
A member of this group. |
Description:
Return the number of listeners listening to a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The number of listeners.
Type:
- number
Description:
Return the listeners registered for a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The registered listeners.
Type:
- Array.<function()>
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Add a one-time listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Plays an animation for all members of this group.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
The string-based key of the animation to play. |
|
| startFrame | string | <optional> |
Optionally start the animation playing from this frame index. |
Returns:
Description:
This Group object.
Description:
Updates any group members, if Phaser.GameObjects.Group#runChildUpdate is enabled.
Parameters:
| name | type | description |
|---|---|---|
| time | number |
The current timestamp. |
| delta | number |
The delta time elapsed since the last frame. |
Description:
Adds the given value to the property as defined in key of each group member.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| key | string |
The property to be updated. |
||
| value | number |
The amount to set the property to. |
||
| step | number | <optional> | 0 |
This is added to the |
| index | number | <optional> | 0 |
An optional offset to start searching from within the items array. |
| direction | number | <optional> | 1 |
The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. |
Returns:
Description:
This Group object.
Description:
Sets the property as defined in key of each group member to the given value.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| key | string |
The property to be updated. |
||
| value | number |
The amount to set the property to. |
||
| step | number | <optional> | 0 |
This is added to the |
| index | number | <optional> | 0 |
An optional offset to start searching from within the items array. |
| direction | number | <optional> | 1 |
The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. |
Returns:
Description:
This Group object.
Description:
Resets each Body to the position of its parent Game Object. Body sizes aren't changed (use Phaser.Physics.Arcade.Components.Enable#refreshBody for that).
Returns:
Description:
This group.
Description:
Removes a member of this Group and optionally removes it from the Scene and / or destroys it.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| child | Phaser.GameObjects.GameObject |
The Game Object to remove. |
||
| removeFromScene | boolean | <optional> | false |
Optionally remove the Group member from the Scene it belongs to. |
| destroyChild | boolean | <optional> | false |
Optionally call destroy on the removed Group member. |
Returns:
Description:
This Group object.
Description:
Remove all listeners, or those of the specified event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol | <optional> |
The event name. |
Returns:
Description:
this.
Description:
Disables the group member's physics body, removing it from the simulation.
Parameters:
| name | type | description |
|---|---|---|
| child | Phaser.GameObjects.GameObject |
The group member being removed. |
Description:
Removes the given Collision Category from the list of those that this Arcade Physics Body will collide with.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category to add. |
Returns:
Description:
This Game Object.
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Resets the Collision Category and Mask back to the defaults, which is to collide with everything.
Returns:
Description:
This Game Object.
Description:
Sets the rotation of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the rotation to, in radians. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Rotates each group member around the given point by the given angle.
Parameters:
| name | type | description |
|---|---|---|
| point | Phaser.Types.Math.Vector2Like |
Any object with public |
| angle | number |
The angle to rotate by, in radians. |
Returns:
Description:
This Group object.
Description:
Rotates each group member around the given point by the given angle and distance.
Parameters:
| name | type | description |
|---|---|---|
| point | Phaser.Types.Math.Vector2Like |
Any object with public |
| angle | number |
The angle to rotate by, in radians. |
| distance | number |
The distance from the point of rotation in pixels. |
Returns:
Description:
This Group object.
Description:
Sets the scaleX of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the property to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the scaleX, scaleY of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| scaleX | number |
The amount to be added to the |
|
| scaleY | number | <optional> |
The amount to be added to the |
| stepX | number | <optional> |
This is added to the |
| stepY | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the scaleY of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the property to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the active property of this Group.
When active, this Group runs its preUpdate method.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
True if this Group should be set as active, false if not. |
Returns:
Description:
This Group object.
Description:
Sets the alpha of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the alpha to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the blendMode of each group member.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The amount to set the property to. |
Returns:
Description:
This Group object.
Description:
Sets all of the Collision Categories that this Arcade Physics Body will collide with. You can either pass a single category value, or an array of them.
Calling this method will reset all of the collision categories, so only those passed to this method are enabled.
If you wish to add a new category to the existing mask, call
the addCollisionCategory method.
If you wish to reset the collision category and mask, call
the resetCollisionCategory method.
Parameters:
| name | type | description |
|---|---|---|
| categories | number | Array.<number> |
The collision category to collide with, or an array of them. |
Returns:
Description:
This Game Object.
Description:
Sets the Collision Category that this Arcade Physics Body will use in order to determine what it can collide with.
It can only have one single category assigned to it.
If you wish to reset the collision category and mask, call
the resetCollisionCategory method.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category. |
Returns:
Description:
This Game Object.
Description:
Sets the depth of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the property to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.
Parameters:
| name | type | description |
|---|---|---|
| hitArea | * |
Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used. |
| hitAreaCallback | Phaser.Types.Input.HitAreaCallback |
A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback. |
Returns:
Description:
This Group object.
Description:
Sets the name property of this Group.
The name property is not populated by Phaser and is presented for your own use.
Parameters:
| name | type | description |
|---|---|---|
| value | string |
The name to be given to this Group. |
Returns:
Description:
This Group object.
Description:
Sets the originX, originY of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| originX | number |
The amount to set the |
|
| originY | number | <optional> |
The amount to set the |
| stepX | number | <optional> |
This is added to the |
| stepY | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the tint of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| topLeft | number |
The tint being applied to top-left corner of item. If other parameters are given no value, this tint will be applied to whole item. |
|
| topRight | number | <optional> |
The tint to be applied to top-right corner of item. |
| bottomLeft | number | <optional> |
The tint to be applied to the bottom-left corner of item. |
| bottomRight | number | <optional> |
The tint to be applied to the bottom-right corner of item. |
Returns:
Description:
This Group object.
Description:
Sets the visible of each group member.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| value | boolean |
The value to set the property to. |
||
| index | number | <optional> | 0 |
An optional offset to start searching from within the items array. |
| direction | number | <optional> | 1 |
The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. |
Returns:
Description:
This Group object.
Description:
Sets the x of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the property to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the x, y of each group member.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The amount to set the |
||
| y | number | <optional> | x |
The amount to set the |
| stepX | number | <optional> | 0 |
This is added to the |
| stepY | number | <optional> | 0 |
This is added to the |
Returns:
Description:
This Group object.
Description:
Sets the y of each group member.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number |
The amount to set the property to. |
|
| step | number | <optional> |
This is added to the |
Returns:
Description:
This Group object.
Description:
Iterate through the group members changing the position of each element to be that of the element that came before it in the array (or after it if direction = 1)
The first group member position is set to x/y.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number |
The x coordinate to place the first item in the array at. |
|
| y | number |
The y coordinate to place the first item in the array at. |
|
| direction | number | <optional> |
The iteration direction. 0 = first to last and 1 = last to first. |
Returns:
Description:
This Group object.
Description:
Shuffles the group members in place.
Returns:
Description:
This Group object.
Description:
Removes all listeners.
Description:
Toggles (flips) the visible state of each member of this group.
Returns:
Description:
This Group object.
Description:
Checks to see if the given Collision Category will collide with this Arcade Physics object or not.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
Collision category value to test. |
Returns:
Description:
true if the given category will collide with this object, otherwise false.
Type:
- boolean