Class Group

An Arcade Physics Group object.

The primary use of a Physics Group is a way to collect together physics enable objects that share the same intrinsic structure into a single pool. They can they be easily compared against other Groups, or Game Objects.

All Game Objects created by, or added to this Group will automatically be given dynamic Arcade Physics bodies (if they have no body already) and the bodies will receive the Groups default values.

You should not pass objects into this Group that should not receive a body. For example, do not add basic Geometry or Tilemap Layers into a Group, as they will not behave in the way you may expect. Groups should all ideally have objects of the same type in them.

If you wish to create a Group filled with Static Bodies, please see Phaser.Physics.Arcade.StaticGroup.

Hierarchy (View Summary)

GameObjects.Group
- Group

Implements

Physics.Arcade.Components.Collision

Index

Constructors

constructor

Properties

active children classType collisionCategory collisionMask createCallback createMultipleCallback defaultFrame defaultKey defaults isParent maxSize name physicsType removeCallback runChildUpdate scene type world

Methods

Constructors

constructor

new Group(
    world: Physics.Arcade.World,
    scene: Scene,
    children?: GameObject[] | GroupCreateConfig | PhysicsGroupConfig,
    config?: GroupCreateConfig | PhysicsGroupConfig,
): Physics.Arcade.Group
Parameters
- world: Physics.Arcade.World
  The physics simulation.
- scene: Scene
  The scene this group belongs to.
- Optionalchildren: GameObject[] | GroupCreateConfig | PhysicsGroupConfig
  Game Objects to add to this group; or the config argument.
- Optionalconfig: GroupCreateConfig | PhysicsGroupConfig
  Settings for this group.
Returns Physics.Arcade.Group
Overrides Group.constructor
- Defined in types/phaser.d.ts:88803

Properties

active

active: boolean

Whether this group runs its Phaser.GameObjects.Group#preUpdate method (which may update any members).

children

children: Set<GameObject>

Members of this group.

classType

classType: Function

The class to create new Group members from.

This should be either Phaser.Physics.Arcade.Image, Phaser.Physics.Arcade.Sprite, or a class extending one of those.

The constructor arguments must match (scene, x, y, texture, frame).

collisionCategory

collisionCategory: number

The Arcade Physics Group Collision Category.

This can be set to any valid collision bitfield value.

See the setCollisionCategory method for more details.

collisionMask

collisionMask: number

The Arcade Physics Group Collision Mask.

See the setCollidesWith method for more details.

createCallback

createCallback: GroupCallback

A function to be called when adding or creating group members.

createMultipleCallback

createMultipleCallback: GroupMultipleCreateCallback

A function to be called when creating several group members at once.

defaultFrame

defaultFrame: string | number

A default texture frame to use when creating new group members.

defaultKey

defaultKey: string

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.

defaults

defaults: PhysicsGroupDefaults

Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the config argument.

You can remove the default values by setting this property to {}.

isParent

isParent: boolean

A flag identifying this object as a group.

maxSize

maxSize: number

The maximum size of this group, if used as a pool. -1 is no limit.

name

name: string

The name of this group. Empty by default and never populated by Phaser, this is left for developers to use.

physicsType

physicsType: number

The physics type of the Group's members.

removeCallback

removeCallback: GroupCallback

A function to be called when removing group members.

runChildUpdate

runChildUpdate: boolean

Whether to call the update method of any members.

scene

scene: Scene

This scene this group belongs to.

type

type: string

A textual representation of this Game Object. Used internally by Phaser but is available for your own custom classes to populate.

world

world: Physics.Arcade.World

The physics simulation.

Methods

add

add(child: GameObject, addToScene?: boolean): this
Adds a Game Object to this group.

Calls Phaser.GameObjects.Group#createCallback.
Parameters
- child: GameObject
  The Game Object to add.
- OptionaladdToScene: boolean
  Also add the Game Object to the scene. Default false.
Returns this
Inherited from Group.add
- Defined in types/phaser.d.ts:24654

addCollidesWith

addCollidesWith(category: number): this
Adds the given Collision Category to the list of those that this Arcade Physics Body will collide with.
Parameters
- category: number
  The collision category to add.
Returns this
Implementation of Collision.addCollidesWith
- Defined in types/phaser.d.ts:88911

addListener

addListener(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from Group.addListener
- Defined in types/phaser.d.ts:9645

addMultiple

addMultiple(children: GameObject[], addToScene?: boolean): this
Adds several Game Objects to this group.

Calls Phaser.GameObjects.Group#createCallback.
Parameters
- children: GameObject[]
  The Game Objects to add.
- OptionaladdToScene: boolean
  Also add the Game Objects to the scene. Default false.
Returns this
Inherited from Group.addMultiple
- Defined in types/phaser.d.ts:24663

angle

angle(value: number, step?: number): this
Sets the angle of each group member.
Parameters
- value: number
  The amount to set the angle to, in degrees.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.angle
- Defined in types/phaser.d.ts:24953

clear

clear(removeFromScene?: boolean, destroyChild?: boolean): this
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
- OptionalremoveFromScene: boolean
  Optionally remove each Group member from the Scene. Default false.
- OptionaldestroyChild: boolean
  Optionally call destroy on the removed Group members. Default false.
Returns this
Inherited from Group.clear
- Defined in types/phaser.d.ts:24682

contains

contains(child: GameObject): boolean
Tests if a Game Object is a member of this group.
Parameters
- child: GameObject
  A Game Object.
Returns boolean
Inherited from Group.contains
- Defined in types/phaser.d.ts:24688

countActive

countActive(value?: boolean): number
Counts the number of active (or inactive) group members.
Parameters
- Optionalvalue: boolean
  Count active (true) or inactive (false) group members. Default true.
Returns number
Inherited from Group.countActive
- Defined in types/phaser.d.ts:24843

create

create(
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
    active?: boolean,
): any
Creates a new Game Object and adds it to this group, unless the group is full.

Calls Phaser.GameObjects.Group#createCallback.
Parameters
- Optionalx: number
  The horizontal position of the new Game Object in the world. Default 0.
- Optionaly: number
  The vertical position of the new Game Object in the world. Default 0.
- Optionalkey: string
  The texture key of the new Game Object. Default defaultKey.
- Optionalframe: string | number
  The texture frame of the new Game Object. Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of the new Game Object. Default true.
- Optionalactive: boolean
  The Phaser.GameObjects.GameObject#active state of the new Game Object. Default true.
Returns any
Inherited from Group.create
- Defined in types/phaser.d.ts:24622

createCallbackHandler

createCallbackHandler(child: GameObject): void
Enables a Game Object's Body and assigns defaults. Called when a Group member is added or created.
Parameters
- child: GameObject
  The Game Object being added.
Returns void
- Defined in types/phaser.d.ts:88857

createFromConfig

createFromConfig(options: GroupCreateConfig): any[]
A helper for Phaser.GameObjects.Group#createMultiple.
Parameters
- options: GroupCreateConfig
  Creation settings.
Returns any[]
Inherited from Group.createFromConfig
- Defined in types/phaser.d.ts:24638

createMultiple

createMultiple(config: GroupCreateConfig | GroupCreateConfig[]): any[]
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
- config: GroupCreateConfig | GroupCreateConfig[]
  Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.
Returns any[]
Inherited from Group.createMultiple
- Defined in types/phaser.d.ts:24632

destroy

destroy(destroyChildren?: boolean, removeFromScene?: boolean): void
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
- OptionaldestroyChildren: boolean
  Also Phaser.GameObjects.GameObject#destroy each Group member. Default false.
- OptionalremoveFromScene: boolean
  Optionally remove each Group member from the Scene. Default false.
Returns void
Inherited from Group.destroy
- Defined in types/phaser.d.ts:25088

emit

emit(event: string | symbol, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
- ...args: any[]
  Additional arguments that will be passed to the event handler.
Returns boolean
Inherited from Group.emit
- Defined in types/phaser.d.ts:9629

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from Group.eventNames
- Defined in types/phaser.d.ts:9610

get

get(
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.get
- Defined in types/phaser.d.ts:24794

getChildren

getChildren(): GameObject[]
All members of the group.

Returns GameObject[]
Inherited from Group.getChildren
- Defined in types/phaser.d.ts:24693

getFirst

getFirst(
    state?: boolean,
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- Optionalstate: boolean
  The Phaser.GameObjects.GameObject#active value to match. Default false.
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getFirst
- Defined in types/phaser.d.ts:24729

getFirstAlive

getFirstAlive(
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getFirstAlive
- Defined in types/phaser.d.ts:24809

getFirstDead

getFirstDead(
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getFirstDead
- Defined in types/phaser.d.ts:24825

getFirstNth

getFirstNth(
    nth: number,
    state?: boolean,
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- nth: number
  The nth matching Group member to search for.
- Optionalstate: boolean
  The Phaser.GameObjects.GameObject#active value to match. Default false.
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getFirstNth
- Defined in types/phaser.d.ts:24746

getLast

getLast(
    state?: boolean,
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- Optionalstate: boolean
  The Phaser.GameObjects.GameObject#active value to match. Default false.
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getLast
- Defined in types/phaser.d.ts:24762

getLastNth

getLastNth(
    nth: number,
    state?: boolean,
    createIfNull?: boolean,
    x?: number,
    y?: number,
    key?: string,
    frame?: string | number,
    visible?: boolean,
): any
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
- nth: number
  The nth matching Group member to search for.
- Optionalstate: boolean
  The Phaser.GameObjects.GameObject#active value to match. Default false.
- OptionalcreateIfNull: boolean
  Create a new Game Object if no matching members are found, using the following arguments. Default false.
- Optionalx: number
  The horizontal position of the Game Object in the world.
- Optionaly: number
  The vertical position of the Game Object in the world.
- Optionalkey: string
  The texture key assigned to a new Game Object (if one is created). Default defaultKey.
- Optionalframe: string | number
  A texture frame assigned to a new Game Object (if one is created). Default defaultFrame.
- Optionalvisible: boolean
  The Phaser.GameObjects.Components.Visible#visible state of a new Game Object (if one is created). Default true.
Returns any
Inherited from Group.getLastNth
- Defined in types/phaser.d.ts:24779

getLength

getLength(): number
The number of members of the group.

Returns number
Inherited from Group.getLength
- Defined in types/phaser.d.ts:24698

getMatching

getMatching(
    property?: string,
    value?: any,
    startIndex?: number,
    endIndex?: number,
): any[]
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
- Optionalproperty: string
  The property to test on each array element.
- Optionalvalue: any
  The value to test the property against. Must pass a strict (===) comparison check.
- OptionalstartIndex: number
  An optional start index to search from.
- OptionalendIndex: number
  An optional end index to search to.
Returns any[]
Inherited from Group.getMatching
- Defined in types/phaser.d.ts:24713

getTotalFree

getTotalFree(): number
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 number
Inherited from Group.getTotalFree
- Defined in types/phaser.d.ts:24855

getTotalUsed

getTotalUsed(): number
Counts the number of in-use (active) group members.

Returns number
Inherited from Group.getTotalUsed
- Defined in types/phaser.d.ts:24848

incX

incX(value: number, step?: number): this
Adds the given value to the x of each group member.
Parameters
- value: number
  The amount to be added to the x property.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.incX
- Defined in types/phaser.d.ts:24919

incXY

incXY(x: number, y?: number, stepX?: number, stepY?: number): this
Adds the given value to the x, y of each group member.
Parameters
- x: number
  The amount to be added to the x property.
- Optionaly: number
  The amount to be added to the y property. If undefined or null it uses the x value. Default x.
- OptionalstepX: number
  This is added to the x amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the y amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.incXY
- Defined in types/phaser.d.ts:24935

incY

incY(value: number, step?: number): this
Adds the given value to the y of each group member.
Parameters
- value: number
  The amount to be added to the y property.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.incY
- Defined in types/phaser.d.ts:24926

isFull

isFull(): boolean
Whether this group's size at its maximum.

Returns boolean
Inherited from Group.isFull
- Defined in types/phaser.d.ts:24837

kill

kill(gameObject: GameObject): void
Deactivates a member of this group.
Parameters
- gameObject: GameObject
  A member of this group.
Returns void
Inherited from Group.kill
- Defined in types/phaser.d.ts:25054

killAndHide

killAndHide(gameObject: GameObject): void
Deactivates and hides a member of this group.
Parameters
- gameObject: GameObject
  A member of this group.
Returns void
Inherited from Group.killAndHide
- Defined in types/phaser.d.ts:25060

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
  The event name.
Returns number
Inherited from Group.listenerCount
- Defined in types/phaser.d.ts:9622

listeners

listeners(event: string | symbol): Function[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
Returns Function[]
Inherited from Group.listeners
- Defined in types/phaser.d.ts:9616

off

off(event: string | symbol, fn?: Function, context?: any, once?: boolean): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
Inherited from Group.off
- Defined in types/phaser.d.ts:9671

on

on(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from Group.on
- Defined in types/phaser.d.ts:9637

once

once(event: string | symbol, fn: Function, context?: any): this
Add a one-time listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from Group.once
- Defined in types/phaser.d.ts:9653

playAnimation

playAnimation(key: string, startFrame?: string): this
Plays an animation for all members of this group.
Parameters
- key: string
  The string-based key of the animation to play.
- OptionalstartFrame: string
  Optionally start the animation playing from this frame index. Default 0.
Returns this
Inherited from Group.playAnimation
- Defined in types/phaser.d.ts:24832

preUpdate

preUpdate(time: number, delta: number): void
Updates any group members, if Phaser.GameObjects.Group#runChildUpdate is enabled.
Parameters
- time: number
  The current timestamp.
- delta: number
  The delta time elapsed since the last frame.
Returns void
Inherited from Group.preUpdate
- Defined in types/phaser.d.ts:24645

propertyValueInc

propertyValueInc(
    key: string,
    value: number,
    step?: number,
    index?: number,
    direction?: number,
): this
Adds the given value to the property as defined in key of each group member.
Parameters
- key: string
  The property to be updated.
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
- Optionalindex: number
  An optional offset to start searching from within the items array. Default 0.
- Optionaldirection: number
  The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. Default 1.
Returns this
Inherited from Group.propertyValueInc
- Defined in types/phaser.d.ts:24889

propertyValueSet

propertyValueSet(
    key: string,
    value: number,
    step?: number,
    index?: number,
    direction?: number,
): this
Sets the property as defined in key of each group member to the given value.
Parameters
- key: string
  The property to be updated.
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
- Optionalindex: number
  An optional offset to start searching from within the items array. Default 0.
- Optionaldirection: number
  The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. Default 1.
Returns this
Inherited from Group.propertyValueSet
- Defined in types/phaser.d.ts:24879

remove

remove(
    child: GameObject,
    removeFromScene?: boolean,
    destroyChild?: boolean,
): this
Removes a member of this Group and optionally removes it from the Scene and / or destroys it.

Calls Phaser.GameObjects.Group#removeCallback.
Parameters
- child: GameObject
  The Game Object to remove.
- OptionalremoveFromScene: boolean
  Optionally remove the Group member from the Scene it belongs to. Default false.
- OptionaldestroyChild: boolean
  Optionally call destroy on the removed Group member. Default false.
Returns this
Inherited from Group.remove
- Defined in types/phaser.d.ts:24673

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
  The event name.
Returns this
Inherited from Group.removeAllListeners
- Defined in types/phaser.d.ts:9677

removeCallbackHandler

removeCallbackHandler(child: GameObject): void
Disables a Game Object's Body. Called when a Group member is removed.
Parameters
- child: GameObject
  The Game Object being removed.
Returns void
- Defined in types/phaser.d.ts:88863

removeCollidesWith

removeCollidesWith(category: number): this
Removes the given Collision Category from the list of those that this Arcade Physics Body will collide with.
Parameters
- category: number
  The collision category to add.
Returns this
Implementation of Collision.removeCollidesWith
- Defined in types/phaser.d.ts:88918

removeListener

removeListener(
    event: string | symbol,
    fn?: Function,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
Inherited from Group.removeListener
- Defined in types/phaser.d.ts:9662

resetCollisionCategory

resetCollisionCategory(): this
Resets the Collision Category and Mask back to the defaults, which is to collide with everything.

Returns this
Implementation of Collision.resetCollisionCategory
- Defined in types/phaser.d.ts:88941

rotate

rotate(value: number, step?: number): this
Sets the rotation of each group member.
Parameters
- value: number
  The amount to set the rotation to, in radians.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.rotate
- Defined in types/phaser.d.ts:24960

rotateAround

rotateAround(point: Vector2Like, angle: number): this
Rotates each group member around the given point by the given angle.
Parameters
- point: Vector2Like
  Any object with public x and y properties.
- angle: number
  The angle to rotate by, in radians.
Returns this
Inherited from Group.rotateAround
- Defined in types/phaser.d.ts:24967

rotateAroundDistance

rotateAroundDistance(point: Vector2Like, angle: number, distance: number): this
Rotates each group member around the given point by the given angle and distance.
Parameters
- point: Vector2Like
  Any object with public x and y properties.
- angle: number
  The angle to rotate by, in radians.
- distance: number
  The distance from the point of rotation in pixels.
Returns this
Inherited from Group.rotateAroundDistance
- Defined in types/phaser.d.ts:24975

scaleX

scaleX(value: number, step?: number): this
Sets the scaleX of each group member.
Parameters
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.scaleX
- Defined in types/phaser.d.ts:25007

scaleXY

scaleXY(scaleX: number, scaleY?: number, stepX?: number, stepY?: number): this
Sets the scaleX, scaleY of each group member.
Parameters
- scaleX: number
  The amount to be added to the scaleX property.
- OptionalscaleY: number
  The amount to be added to the scaleY property. If undefined or null it uses the scaleX value.
- OptionalstepX: number
  This is added to the scaleX amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the scaleY amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.scaleXY
- Defined in types/phaser.d.ts:25023

scaleY

scaleY(value: number, step?: number): this
Sets the scaleY of each group member.
Parameters
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.scaleY
- Defined in types/phaser.d.ts:25014

setActive

setActive(value: boolean): this
Sets the active property of this Group. When active, this Group runs its preUpdate method.
Parameters
- value: boolean
  True if this Group should be set as active, false if not.
Returns this
Inherited from Group.setActive
- Defined in types/phaser.d.ts:24862

setAlpha

setAlpha(value: number, step?: number): this
Sets the alpha of each group member.
Parameters
- value: number
  The amount to set the alpha to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setAlpha
- Defined in types/phaser.d.ts:24982

setBlendMode

setBlendMode(value: number): this
Sets the blendMode of each group member.
Parameters
- value: number
  The amount to set the property to.
Returns this
Inherited from Group.setBlendMode
- Defined in types/phaser.d.ts:25036

setCollidesWith

setCollidesWith(categories: number | number[]): this
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
- categories: number | number[]
  The collision category to collide with, or an array of them.
Returns this
Implementation of Collision.setCollidesWith
- Defined in types/phaser.d.ts:88935

setCollisionCategory

setCollisionCategory(category: number): this
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
- category: number
  The collision category.
Returns this
Implementation of Collision.setCollisionCategory
- Defined in types/phaser.d.ts:88897

setDepth

setDepth(value: number, step?: number): this
Sets the depth of each group member.
Parameters
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setDepth
- Defined in types/phaser.d.ts:25030

setHitArea

setHitArea(hitArea: any, hitAreaCallback: HitAreaCallback): this
Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.
Parameters
- hitArea: any
  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: 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 this
Inherited from Group.setHitArea
- Defined in types/phaser.d.ts:25043

setName

setName(value: string): this
Sets the name property of this Group. The name property is not populated by Phaser and is presented for your own use.
Parameters
- value: string
  The name to be given to this Group.
Returns this
Inherited from Group.setName
- Defined in types/phaser.d.ts:24869

setOrigin

setOrigin(
    originX: number,
    originY?: number,
    stepX?: number,
    stepY?: number,
): this
Sets the originX, originY of each group member.
Parameters
- originX: number
  The amount to set the originX property to.
- OptionaloriginY: number
  The amount to set the originY property to. If undefined or null it uses the originX value.
- OptionalstepX: number
  This is added to the originX amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the originY amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setOrigin
- Defined in types/phaser.d.ts:25000

setTint

setTint(
    topLeft: number,
    topRight?: number,
    bottomLeft?: number,
    bottomRight?: number,
): this
Sets the tint of each group member.
Parameters
- 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.
- OptionaltopRight: number
  The tint to be applied to top-right corner of item.
- OptionalbottomLeft: number
  The tint to be applied to the bottom-left corner of item.
- OptionalbottomRight: number
  The tint to be applied to the bottom-right corner of item.
Returns this
Inherited from Group.setTint
- Defined in types/phaser.d.ts:24991

setVelocity

setVelocity(x: number, y: number, step?: number): Physics.Arcade.Group
Sets the velocity of each Group member.
Parameters
- x: number
  The horizontal velocity.
- y: number
  The vertical velocity.
- Optionalstep: number
  The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on. Default 0.
Returns Physics.Arcade.Group
- Defined in types/phaser.d.ts:88871

setVelocityX

setVelocityX(value: number, step?: number): Physics.Arcade.Group
Sets the horizontal velocity of each Group member.
Parameters
- value: number
  The velocity value.
- Optionalstep: number
  The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on. Default 0.
Returns Physics.Arcade.Group
- Defined in types/phaser.d.ts:88878

setVelocityY

setVelocityY(value: number, step?: number): Physics.Arcade.Group
Sets the vertical velocity of each Group member.
Parameters
- value: number
  The velocity value.
- Optionalstep: number
  The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on. Default 0.
Returns Physics.Arcade.Group
- Defined in types/phaser.d.ts:88885

setVisible

setVisible(value: boolean, index?: number, direction?: number): this
Sets the visible of each group member.
Parameters
- value: boolean
  The value to set the property to.
- Optionalindex: number
  An optional offset to start searching from within the items array. Default 0.
- Optionaldirection: number
  The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. Default 1.
Returns this
Inherited from Group.setVisible
- Defined in types/phaser.d.ts:25068

setX

setX(value: number, step?: number): this
Sets the x of each group member.
Parameters
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setX
- Defined in types/phaser.d.ts:24896

setXY

setXY(x: number, y?: number, stepX?: number, stepY?: number): this
Sets the x, y of each group member.
Parameters
- x: number
  The amount to set the x property to.
- Optionaly: number
  The amount to set the y property to. If undefined or null it uses the x value. Default x.
- OptionalstepX: number
  This is added to the x amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the y amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setXY
- Defined in types/phaser.d.ts:24912

setY

setY(value: number, step?: number): this
Sets the y of each group member.
Parameters
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value amount, multiplied by the iteration counter. Default 0.
Returns this
Inherited from Group.setY
- Defined in types/phaser.d.ts:24903

shiftPosition

shiftPosition(x: number, y: number, direction?: number): this
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
- 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.
- Optionaldirection: number
  The iteration direction. 0 = first to last and 1 = last to first. Default 0.
Returns this
Inherited from Group.shiftPosition
- Defined in types/phaser.d.ts:24946

shuffle

shuffle(): this
Shuffles the group members in place.

Returns this
Inherited from Group.shuffle
- Defined in types/phaser.d.ts:25048

shutdown

shutdown(): void
Removes all listeners.

Returns void
Inherited from Group.shutdown
- Defined in types/phaser.d.ts:9600

toggleVisible

toggleVisible(): this
Toggles (flips) the visible state of each member of this group.

Returns this
Inherited from Group.toggleVisible
- Defined in types/phaser.d.ts:25073

willCollideWith

willCollideWith(category: number): boolean
Checks to see if the given Collision Category will collide with this Arcade Physics object or not.
Parameters
- category: number
  Collision category value to test.
Returns boolean
Implementation of Collision.willCollideWith
- Defined in types/phaser.d.ts:88904

Class Group

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Physics.Arcade.Group

Properties

active

children

classType

collisionCategory

collisionMask

createCallback

createMultipleCallback

defaultFrame

defaultKey

defaults

isParent

maxSize

name

physicsType

removeCallback

runChildUpdate

scene

type

world

Methods

add

Parameters

Returns this

addCollidesWith

Parameters

Returns this

addListener

Parameters

Returns this

addMultiple

Parameters

Returns this

angle

Parameters

Returns this

clear

Parameters

Returns this

contains

Parameters

Returns boolean

countActive

Parameters

Returns number

create

Parameters

Returns any

createCallbackHandler

Parameters

Returns void

createFromConfig

Parameters

Returns any[]

createMultiple

Parameters

Returns any[]

destroy

Parameters

Returns void

emit

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

get

Parameters

Returns any

getChildren