SpriteBatch#replace()

replace(oldChild, newChild) → {any} Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group. If Group.enableBody is set, then a physics body will be created on the object, so long as one does not already exist. If Group.inputEnableChildren is set, then an Input Handler will be created on the object, so long as one does not already exist. Parameters Name Type Description oldChild any The child in this group that will be replaced. newChild any

SpriteBatch#removeFromHash()

removeFromHash(child) → {boolean} Removes a child of this Group from the hash array.This call will return false if the child is not in the hash. Parameters Name Type Description child DisplayObject The display object to remove from this Groups hash. Must be a member of this Group and in the hash. Returns boolean - True if the child was successfully removed from the hash, otherwise false. Inherited From Phaser.Group#removeFromHash Source code: core/Group.js (Line 464)

SpriteBatch#removeChildren()

removeChildren(beginIndex, endIndex) Removes all children from this container that are within the begin and end indexes. Parameters Name Type Description beginIndex Number The beginning position. Default value is 0. endIndex Number The ending position. Default value is size of the container. Inherited From PIXI.DisplayObjectContainer#removeChildren Source code: pixi/display/DisplayObjectContainer.js (Line 213)

SpriteBatch#removeChildAt()

removeChildAt(index) → {DisplayObject} Removes a child from the specified index position. Parameters Name Type Description index Number The index to get the child from Returns DisplayObject - The child that was removed. Inherited From PIXI.DisplayObjectContainer#removeChildAt Source code: pixi/display/DisplayObjectContainer.js (Line 191)

SpriteBatch#removeChild()

removeChild(child) → {DisplayObject} Removes a child from the container. Parameters Name Type Description child DisplayObject The DisplayObject to remove Returns DisplayObject - The child that was removed. Inherited From PIXI.DisplayObjectContainer#removeChild Source code: pixi/display/DisplayObjectContainer.js (Line 171)

SpriteBatch#removeBetween()

removeBetween(startIndex, endIndex, destroy, silent) Removes all children from this group whose index falls beteen the given startIndex and endIndex values. Parameters Name Type Argument Default Description startIndex integer The index to start removing children from. endIndex integer <optional> The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the group. destroy boolea

SpriteBatch#removeAll()

removeAll(destroy, silent, destroyTexture) Removes all children from this Group, but does not remove the group from its parent. The children can be optionally destroyed as they are removed. You can also optionally also destroy the BaseTexture the Child is using. Be careful if you'vemore than one Game Object sharing the same BaseTexture. Parameters Name Type Argument Default Description destroy boolean <optional> false If true destroy will be invoked on each removed child. silent

SpriteBatch#remove()

remove(child, destroy, silent) → {boolean} Removes the given child from this group. This will dispatch an onRemovedFromGroup event from the child (if it has one), and optionally destroy the child. If the group cursor was referring to the removed child it is updated to refer to the next child. Parameters Name Type Argument Default Description child any The child to remove. destroy boolean <optional> false If true destroy will be invoked on the removed child. silent boolean

SpriteBatch#previous()

previous() → {any} Moves the group cursor to the previous (lower) child in the group. If the cursor is at the start of the group (bottom child) it is moved to the end (top child). Returns any - The child the cursor now points to. Inherited From Phaser.Group#previous Source code: core/Group.js (Line 862)

SpriteBatch#physicsType

[readonly] physicsType : number The const physics body type of this object. Inherited From Phaser.Group#physicsType Source code: core/Group.js (Line 86)