PokéRogue
    Preparing search index...

    Class Layer

    A Layer Game Object.

    A Layer is a special type of Game Object that acts as a Display List. You can add any type of Game Object to a Layer, just as you would to a Scene. Layers can be used to visually group together 'layers' of Game Objects:

    const spaceman = this.add.sprite(150, 300, 'spaceman');
    const bunny = this.add.sprite(400, 300, 'bunny');
    const elephant = this.add.sprite(650, 300, 'elephant');

    const layer = this.add.layer();

    layer.add([ spaceman, bunny, elephant ]);

    The 3 sprites in the example above will now be managed by the Layer they were added to. Therefore, if you then set layer.setVisible(false) they would all vanish from the display.

    You can also control the depth of the Game Objects within the Layer. For example, calling the setDepth method of a child of a Layer will allow you to adjust the depth of that child within the Layer itself, rather than the whole Scene. The Layer, too, can have its depth set as well.

    The Layer class also offers many different methods for manipulating the list, such as the methods moveUp, moveDown, sendToBack, bringToTop and so on. These allow you to change the display list position of the Layers children, causing it to adjust the order in which they are rendered. Using setDepth on a child allows you to override this.

    Layers have no position or size within the Scene. This means you cannot enable a Layer for physics or input, or change the position, rotation or scale of a Layer. They also have no scroll factor, texture, tint, origin, crop or bounds.

    If you need those kind of features then you should use a Container instead. Containers can be added to Layers, but Layers cannot be added to Containers.

    However, you can set the Alpha, Blend Mode, Depth, Mask and Visible state of a Layer. These settings will impact all children being rendered by the Layer.

    Layers should always be the topmost elements of any scene hierarchy. They can be children of layers, but not of anything else.

    Until Phaser version 4.1.0, Layer was not a true GameObject. It is now a true GameObject.

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    _sortKey active addCallback alpha blendMode body cameraFilter data depth displayList events filterCamera filters filtersAutoFocus filtersFocusContext filtersForceComposite first ignoreDestroy input isDestroyed last length list mask maxFilterSize name next parent parentContainer position previous removeCallback renderFilters renderFlags scene sortChildrenFlag state systems tabIndex type vertexRoundMode visible RENDER_MASK
    add addAt addedToScene addListener addRenderStep addToDisplayList addToUpdateList bringToTop clearAlpha clearMask count createGeometryMask depthSort destroy disableInteractive each emit enableFilters eventNames exists focusFilters focusFiltersOnCamera focusFiltersOverride getAll getAt getByName getChildren getData getDisplayList getFirst getIndex getIndexList getRandom incData listenerCount listeners moveAbove moveBelow moveDown moveTo moveUp off on once queueDepthSort remove removeAll removeAllListeners removeAt removeBetween removedFromScene removeFromDisplayList removeFromUpdateList removeInteractive removeListener renderWebGLFilters renderWebGLStep replace reverse sendToBack setAbove setActive setAll setAlpha setBelow setBlendMode setData setDataEnabled setDepth setFiltersAutoFocus setFiltersFocusContext setFiltersForceComposite setFilterSize setInteractive setMask setName setRenderFilters setState setToBack setToTop setVertexRoundMode setVisible shuffle shutdown sort sortByDepth swap toggleData toJSON update willRender willRenderFilters willRoundVertices

    • Parameters

      • scene: Scene

        The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.

      • Optionalchildren: GameObject[]

        An optional array of Game Objects to add to this Layer.

      Returns Layer

    _sortKey

    _sortKey: string

    The property key to sort by.

    active: boolean

    The active state of this Game Object. A Game Object with an active state of true is processed by the Scenes UpdateList, if added to it. An active object is one which is having its logic and internal systems updated.

    addCallback: Function

    A callback that is invoked every time a child is added to this list.

    alpha: number

    The alpha value of the Game Object.

    This is a global value, impacting the entire Game Object, not just a region of it. The value is clamped to the range [0, 1]. Setting alpha to 0 also clears the render flag, preventing the Game Object from being drawn until the alpha is raised above 0 again.

    blendMode: string | number | BlendModes

    Sets the Blend Mode being used by this Game Object.

    This can be a const, such as Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)

    Under WebGL only the following Blend Modes are available:

    • NORMAL
    • ADD
    • MULTIPLY
    • SCREEN
    • ERASE

    Canvas has more available depending on browser support.

    You can also create your own custom Blend Modes in WebGL.

    Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency with which blend modes are used.

    body

    body: Body | StaticBody | BodyType | null

    If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.

    cameraFilter: number

    A bitmask that controls if this Game Object is drawn by a Camera or not. Not usually set directly, instead call Camera.ignore, however you can set this property directly using the Camera.id property:

    data: DataManager

    A Data Manager. It allows you to store, query and get key/value paired information specific to this Game Object. null by default. Automatically created if you use getData or setData or setDataEnabled.

    depth: number

    The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.

    The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.

    The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.

    Setting the depth will queue a depth sort event within the Scene.

    displayList: DisplayList | Layer

    Holds a reference to the Display List that contains this Game Object.

    This is set automatically when this Game Object is added to a Scene or Layer.

    You should treat this property as being read-only.

    events: EventEmitter

    A reference to the Scene Event Emitter.

    filterCamera: Camera

    The Camera used for filters. You can use this to alter the perspective of filters. It is not necessary to use this camera for ordinary rendering.

    This is only available if you use the enableFilters method.

    filters: FiltersInternalExternal | null

    The filter lists for this Game Object. This is an object with internal and external properties. Each list is a Phaser.GameObjects.Components.FilterList object.

    This is only available if you use the enableFilters method.

    filtersAutoFocus: boolean

    Whether filterCamera should update every frame to focus on the Game Object. Disable this if you want to manually control the camera.

    filtersFocusContext: boolean

    Whether the filters should focus on the context, rather than attempt to focus on the Game Object. This is enabled automatically when enabling filters on objects which don't have well-defined bounds.

    This effectively sets the internal filters to render the same way as the external filters.

    This is only used if filtersAutoFocus is enabled.

    The "context" is the framebuffer to which the Game Object is rendered. This is usually the main framebuffer, but might be another framebuffer. It can even be several different framebuffers if the Game Object is rendered multiple times.

    filtersForceComposite: boolean

    Whether the Filters component should always draw to a framebuffer, even if there are no active filters.

    first: GameObject | null

    The first item in the List or null for an empty List.

    ignoreDestroy: boolean

    This Game Object will ignore all calls made to its destroy method if this flag is set to true. This includes calls that may come from a Group, Container or the Scene itself. While it allows you to persist a Game Object across Scenes, please understand you are entirely responsible for managing references to and from this Game Object.

    input: InteractiveObject | null

    If this Game Object is enabled for input then this property will contain an InteractiveObject instance. Not usually set directly. Instead call GameObject.setInteractive().

    isDestroyed: boolean

    Whether this Game Object has been destroyed. Check this property to avoid bugs caused by calling methods on a destroyed Game Object, e.g. in a Tween or Timer.

    This is a read-only property that is automatically set to true when the Game Object is destroyed. You should not set this property directly. It is set before preDestroy is called or the DESTROY event is emitted.

    last: GameObject | null

    The last item in the List, or null for an empty List.

    length: number

    The number of items inside the List.

    list: GameObject[]

    The objects that belong to this collection.

    mask: GeometryMask

    The Mask this Game Object is using during render, or null if no mask has been set.

    maxFilterSize: Vector2

    The maximum size of the base filter texture. Filters may use a larger texture after the base texture is rendered. The maximum texture size is at least 4096 in WebGL, based on the hardware. You may set this lower to save memory or prevent resizing.

    name: string

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

    next: GameObject | null

    The next item in the List, or null if the entire List has been traversed.

    This property can be read successively after reading #first or manually setting the #position to iterate the List.

    parent: any

    The parent of this list.

    parentContainer: Container

    The parent Container of this Game Object, if it has one.

    position: number

    The index of the current element.

    This is used internally when iterating through the list with the #first, #last, #next, and #previous properties.

    previous: GameObject | null

    The previous item in the List, or null if the entire List has been traversed.

    This property can be read successively after reading #last or manually setting the #position to iterate the List backwards.

    removeCallback: Function

    A callback that is invoked every time a child is removed from this list.

    renderFilters: boolean

    Whether any filters should be rendered on this Game Object. This is true by default, even if there are no filters yet. Disable this to skip filter rendering.

    Use willRenderFilters() to see if there are any active filters.

    renderFlags: number

    The flags that are compared against RENDER_MASK to determine if this Game Object will render or not. The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively. If those components are not used by your custom class then you can use this bitmask as you wish.

    scene: Scene

    A reference to the Scene to which this Game Object belongs.

    Game Objects can only belong to one Scene.

    You should consider this property as being read-only. You cannot move a Game Object to another Scene by simply changing it.

    sortChildrenFlag: boolean

    The flag that determines whether Game Objects should be sorted when depthSort() is called.

    state: string | number

    The current state of this Game Object.

    Phaser itself will never modify this value, although plugins may do so.

    Use this property to track the state of a Game Object during its lifetime. For example, it could change from a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons. If you need to store complex data about your Game Object, look at using the Data Component instead.

    systems: Systems

    A reference to the Scene Systems.

    tabIndex: number

    The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.

    type: string

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

    vertexRoundMode: string

    The current vertex rounding mode of this Game Object. This is used by the WebGL Renderer to determine how to round the vertex positions. It can have several values:

    • off - No rounding is applied.
    • safe - Rounding is applied if the object is 'safe'.
    • safeAuto - Rounding is applied if the object is 'safe' and the camera has roundPixels enabled.
    • full - Rounding is always applied.
    • fullAuto - Rounding is always applied if the camera has roundPixels enabled.

    A 'safe' object is one that is not rotated or scaled by any transform matrix while rendering. The effective transform is a simple translation. In such cases, rounding will affect all vertices the same way.

    Using full rounding can cause vertices to wobble, because they might not be aligned to the pixel grid. Full rounding gives a janky look like PS1 games.

    You can use other values if you want to create your own custom rounding modes.

    visible: boolean

    The visible state of the Game Object.

    An invisible Game Object will skip rendering, but will still process update logic.

    RENDER_MASK: number

    The bitmask that GameObject.renderFlags is compared against to determine if the Game Object will render or not.

    • Adds the given item to the end of the list. Each item must be unique.

      Parameters

      • child: GameObject | GameObject[]

        The item, or array of items, to add to the list.

      • OptionalskipCallback: boolean

        Skip calling the List.addCallback if this child is added successfully. Default false.

      Returns any

      The list's underlying array.

    • Adds an item to list, starting at a specified index. Each item must be unique within the list.

      Parameters

      • child: GameObject | GameObject[]

        The item, or array of items, to add to the list.

      • Optionalindex: number

        The index in the list at which the element(s) will be inserted. Default 0.

      • OptionalskipCallback: boolean

        Skip calling the List.addCallback if this child is added successfully. Default false.

      Returns GameObject[]

      The List's underlying array.

    • This callback is invoked when this Game Object is added to a Scene.

      Can be overridden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to add themselves into the Update List.

      You can also listen for the ADDED_TO_SCENE event from this Game Object.

      Returns void

    • 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

      This Layer instance.

    • Adds a render step function to this Game Object's WebGL render pipeline.

      The first render step in _renderSteps is run first. It should call the next render step in the list. This allows render steps to control the rendering flow.

      Parameters

      • fn: RenderWebGLStep

        The render step function to add.

      • Optionalindex: number

        The index in the render list to add the step to. Omit to add to the end.

      Returns this

      This Game Object instance.

    • Adds this Game Object to the given Display List.

      If no Display List is specified, it will default to the Display List owned by the Scene to which this Game Object belongs.

      A Game Object can only exist on one Display List at any given time, but may move freely between them.

      If this Game Object is already on another Display List when this method is called, it will first be removed from it, before being added to the new list.

      You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList property.

      If a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarily disable it from rendering, consider using the setVisible method, instead.

      Parameters

      • OptionaldisplayList: DisplayList | Layer

        The Display List to add to. Defaults to the Scene Display List.

      Returns this

      This Game Object.

    • Adds this Game Object to the Update List belonging to the Scene.

      When a Game Object is added to the Update List it will have its preUpdate method called every game frame. This method is passed two parameters: time and delta.

      If you wish to run your own logic within preUpdate then you should always call super.preUpdate(time, delta) within it, or it may fail to process required operations, such as Sprite animations.undefined

      Returns this

      This Game Object.

    • Brings the given child to the top of this List.

      Parameters

      • child: GameObject

        The item to bring to the top of the List.

      Returns GameObject

      The item which was moved.

    • Clears the alpha value associated with this Game Object.

      Immediately sets the alpha back to 1 (fully opaque).undefined

      Returns this

      This Game Object instance.

    • Clears the mask that this Game Object was using.

      This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      Parameters

      • OptionaldestroyMask: boolean

        Destroy the mask before clearing it? Default false.

      Returns this

      This Game Object instance.

    • Returns the total number of items in the List which have a property matching the given value.

      Parameters

      • property: string

        The property to test on each item.

      • value: GameObject

        The value to test the property against.

      Returns number

      The total number of matching elements.

    • Creates and returns a Geometry Mask. This mask can be used by any Game Object, including this one.

      To create the mask you need to pass in a reference to a Graphics Game Object.

      If you do not provide a graphics object, and this Game Object is an instance of a Graphics object, then it will use itself to create the mask.

      This means you can call this method to create a Geometry Mask from any Graphics Game Object.

      This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      Type Parameters

      Parameters

      • Optionalgraphics: Shape | Graphics

        A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.

      Returns GeometryMask

      This Geometry Mask that was created.

    • Immediately sorts the display list if the flag is set.

      Returns void

    • Destroys this Layer removing it from the Display List and Update List and severing all ties to parent resources.

      Also destroys all children of this Layer. If you do not wish for the children to be destroyed, you should move them from this Layer first.

      Use this to remove this Layer from your game if you don't ever plan to use it again. As long as no reference to it exists within your own code it should become free for garbage collection by the browser.

      If you just want to temporarily disable an object then look at using the Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.

      Parameters

      • OptionalfromScene: boolean

        True if this Game Object is being destroyed by the Scene, false if not. Default false.

      Returns void

    • A Layer cannot be enabled for input.

      This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.undefined

      Returns this

      This GameObject.

    • Passes all children to the given callback.

      Parameters

      • callback: EachListCallback<GameObject>

        The function to call.

      • Optionalcontext: any

        Value to use as this when executing callback.

      • ...args: any[]

        Additional arguments that will be passed to the callback, after the child.

      Returns void

    • 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

      true if the event had listeners, else false.

    • Enable this Game Object to have filters.

      You need to call this method if you want to use the filterCamera and filters properties. It sets up the necessary data structures. You may disable filter rendering with the renderFilters property.

      This is a WebGL only feature. It will return early if not available.undefined

      Returns this

      undefined

    • Return an array listing the events for which the emitter has registered listeners.undefined

      Returns (string | symbol)[]

      undefined

    • Checks if an item exists within the List.

      Parameters

      • child: GameObject

        The item to check for the existence of.

      Returns boolean

      true if the item is found in the list, otherwise false.

    • Focus the filter camera. This sets the size and position of the filter camera to match the GameObject. This is called automatically on render if filtersAutoFocus is enabled.

      This will focus on the GameObject's raw dimensions if available. If the GameObject has no dimensions, this will focus on the context: the camera belonging to the DrawingContext used to render the GameObject. Context focus occurs during rendering, as the context is not known until then.undefined

      Returns this

      undefined

    • Focus the filter camera on a specific camera. This is used internally when filtersFocusContext is enabled.

      Parameters

      • camera: Camera

        The camera to focus on.

      Returns this

      undefined

    • Manually override the focus of the filter camera. This allows you to set the size and position of the filter camera manually. It deactivates filtersAutoFocus when called.

      The camera will set scroll to place the game object at the given position within a rectangle of the given width and height. For example, calling focusFiltersOverride(400, 200, 800, 600) will focus the camera to place the object's center 100 pixels above the center of the camera (which is at 400x300).

      Parameters

      • Optionalx: number

        The x-coordinate of the focus point, relative to the filter size. Default is the center.

      • Optionaly: number

        The y-coordinate of the focus point, relative to the filter size. Default is the center.

      • Optionalwidth: number

        The width of the focus area. Default is the filter width.

      • Optionalheight: number

        The height of the focus area. Default is the filter height.

      Returns this

      undefined

    • Returns all children in this List.

      You can optionally specify a matching criteria using the property and value arguments.

      For example: getAll('parent') would return only children that have a property called parent.

      You can also specify a value to compare the property to:

      getAll('visible', true) would return only children that have their visible property set to true.

      Optionally you can specify a start and end index. For example if this List had 100 children, and you set startIndex to 0 and endIndex to 50, it would return matches from only the first 50 children in the List.

      Parameters

      • Optionalproperty: string

        An optional property to test against the value argument.

      • Optionalvalue: any

        If property is set then Child.property must strictly equal this value to be included in the results.

      • OptionalstartIndex: number

        The first child index to start the search from.

      • OptionalendIndex: number

        The last child index to search up until.

      Returns GameObject[]

      All items of the List which match the given criterion, if any.

    • Retrieves the item at a given position inside the List.

      Parameters

      • index: number

        The index of the item.

      Returns GameObject | undefined

      The retrieved item, or undefined if it's outside the List's bounds.

    • Searches for the first instance of a child with its name property matching the given argument. Should more than one child have the same name only the first is returned.

      Parameters

      • name: string

        The name to search for.

      Returns GameObject | null

      The first child with a matching name, or null if none were found.

    • Returns a reference to the array which contains all Game Objects in this Layer.

      This is a reference, not a copy of it, so be very careful not to mutate it.undefined

      Returns GameObject[]

      An array of Game Objects within this Layer.

    • Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.

      You can also access values via the values object. For example, if you had a key called gold you can do either:

      sprite.getData('gold');

      Or access the value directly:

      sprite.data.values.gold;

      You can also pass in an array of keys, in which case an array of values will be returned:

      sprite.getData([ 'gold', 'armor', 'health' ]);

      This approach is useful for destructuring arrays in ES6.

      Parameters

      • key: string | string[]

        The key of the value to retrieve, or an array of keys.

      Returns any

      The value belonging to the given key, or an array of values, the order of which will match the input array.

    • Returns a reference to the underlying display list array that contains this Game Object, which will be either the Scene's Display List or the internal list belonging to its parent Container, if it has one.

      If this Game Object is not on a display list or in a container, it will return null.

      You should be very careful with this method, and understand that it returns a direct reference to the internal array used by the Display List. Mutating this array directly can cause all kinds of subtle and difficult to debug issues in your game.undefined

      Returns GameObject[] | null

      The internal Display List array of Game Objects, or null.

    • Returns the first element in a given part of the List which matches a specific criterion.

      Parameters

      • property: string

        The name of the property to test or a falsey value to have no criterion.

      • value: GameObject | undefined

        The value to test the property against, or undefined to allow any value and only check for existence.

      • OptionalstartIndex: number

        The position in the List to start the search at. Default 0.

      • OptionalendIndex: number

        The position in the List to optionally stop the search at. It won't be checked.

      Returns GameObject | null

      The first item which matches the given criterion, or null if no such item exists.

    • Locates an item within the List and returns its index.

      Parameters

      Returns number

      The index of the item within the List, or -1 if it's not in the List.

    • Returns an array containing the display list index of either this Game Object, or if it has one, its parent Container. It then iterates up through all of the parent containers until it hits the root of the display list (which is index 0 in the returned array).

      Used internally by the InputPlugin but also useful if you wish to find out the display depth of this Game Object and all of its ancestors.undefined

      Returns number[]

      An array of display list position indexes.

    • Returns a random child from the list.

      Parameters

      • OptionalstartIndex: number

        Offset from the front of the list (lowest child). Default 0.

      • Optionallength: number

        Restriction on the number of values you want to randomly select from. Default (to top).

      Returns GameObject | null

      A random child of this List.

    • Increase a value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.

      If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled before setting the value.

      If the key doesn't already exist in the Data Manager then it is created.

      When the value is first set, a setdata event is emitted from this Game Object.

      Parameters

      • key: string

        The key to change the value for.

      • Optionalamount: number

        The amount to increase the given key by. Pass a negative value to decrease the key. Default 1.

      Returns this

      This GameObject.

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

        The event name.

      Returns number

      The number of listeners.

    • Return the listeners registered for a given event.

      Parameters

      • event: string | symbol

        The event name.

      Returns Function[]

      The registered listeners.

    • Moves an item above another one in the List. If the given item is already above the other, it isn't moved. Above means toward the end of the List.

      Parameters

      Returns void

    • Moves an item below another one in the List. If the given item is already below the other, it isn't moved. Below means toward the start of the List.

      Parameters

      Returns void

    • Moves the given child down one place in this List unless it's already at the bottom.

      Parameters

      Returns GameObject

      The item which was moved.

    • Moves an item in the List to a new position.

      Parameters

      • child: GameObject

        The item to move.

      • index: number

        The new position to move the item to.

      Returns GameObject

      The item that was moved.

    • Moves the given child up one place in this List unless it's already at the top.

      Parameters

      Returns GameObject

      The item which was moved.

    • 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

      This Layer instance.

    • 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

      This Layer instance.

    • 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

      This Layer instance.

    • Force a sort of the display list on the next call to depthSort.

      Returns void

    • Removes one or many items from the List.

      Parameters

      • child: GameObject | GameObject[]

        The item, or array of items, to remove.

      • OptionalskipCallback: boolean

        Skip calling the List.removeCallback. Default false.

      Returns GameObject | GameObject[]

      The item, or array of items, which were successfully removed from the List.

    • Removes all the items.

      Parameters

      • OptionalskipCallback: boolean

        Skip calling the List.removeCallback. Default false.

      Returns this

      This List object.

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: string | symbol

        The event name.

      Returns this

      This Layer instance.

    • Removes the item at the given position in the List.

      Parameters

      • index: number

        The position to remove the item from.

      • OptionalskipCallback: boolean

        Skip calling the List.removeCallback. Default false.

      Returns GameObject

      The item that was removed.

    • Removes the items within the given range in the List.

      Parameters

      • OptionalstartIndex: number

        The index to start removing from. Default 0.

      • OptionalendIndex: number

        The position to stop removing at. The item at this position won't be removed.

      • OptionalskipCallback: boolean

        Skip calling the List.removeCallback. Default false.

      Returns GameObject[]

      An array of the items which were removed.

    • This callback is invoked when this Game Object is removed from a Scene.

      Can be overridden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to remove themselves from the Update List.

      You can also listen for the REMOVED_FROM_SCENE event from this Game Object.

      Returns void

    • Removes this Game Object from the Display List it is currently on.

      A Game Object can only exist on one Display List at any given time, but may be freely removed and added back at a later stage.

      You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList property.

      If a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarily disable it from rendering, consider using the setVisible method, instead.undefined

      Returns this

      This Game Object.

    • Removes this Game Object from the Scene's Update List.

      When a Game Object is on the Update List, it will have its preUpdate method called every game frame. Calling this method will remove it from the list, preventing this.

      Removing a Game Object from the Update List will stop most internal functions working. For example, removing a Sprite from the Update List will prevent it from being able to run animations.undefined

      Returns this

      This Game Object.

    • A Layer cannot be enabled for input.

      This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.undefined

      Returns this

      This GameObject.

    • 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

      This Layer instance.

    • Render this object using filters.

      This function's scope is not guaranteed, so it doesn't refer to this.

      Parameters

      • renderer: WebGLRenderer

        The WebGL Renderer instance to render with.

      • gameObject: GameObject

        The Game Object being rendered.

      • drawingContext: DrawingContext

        The current drawing context.

      • OptionalparentMatrix: TransformMatrix

        The parent matrix of the Game Object, if it has one.

      • OptionalrenderStep: number

        The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions. Default 0.

      Returns RenderWebGLStep

      undefined

    • Run a step in the render process. This is called automatically by the Render module.

      In most cases, it just runs the renderWebGL function.

      When _renderSteps has more than one entry, such as when Filters are enabled for this object, it allows those processes to defer renderWebGL and otherwise manage the flow of rendering.

      Parameters

      • renderer: WebGLRenderer

        The WebGL Renderer instance to render with.

      • gameObject: GameObject

        The Game Object being rendered.

      • drawingContext: DrawingContext

        The current drawing context.

      • OptionalparentMatrix: TransformMatrix

        The parent matrix of the Game Object, if it has one.

      • OptionalrenderStep: number

        Which step of the rendering process should be run? Default 0.

      • OptionaldisplayList: GameObject[]

        The display list which is currently being rendered. If not provided, it will be created with the Game Object.

      • OptionaldisplayListIndex: number

        The index of the Game Object within the display list. Default 0.

      Returns void

    • Replaces a child of this List with the given newChild. The newChild cannot be a member of this List.

      Parameters

      • oldChild: GameObject

        The child in this List that will be replaced.

      • newChild: GameObject

        The child to be inserted into this List.

      Returns GameObject

      Returns the oldChild that was replaced within this List.

    • Reverses the order of all children in this List.undefined

      Returns Layer

      This List object.

    • Sends the given child to the bottom of this List.

      Parameters

      • child: GameObject

        The item to send to the back of the list.

      Returns GameObject

      The item which was moved.

    • Move this Game Object so that it appears above the given Game Object.

      This means it will render immediately after the other object in the display list.

      Both objects must belong to the same display list, or parent container.

      This method does not change this Game Objects depth value, it simply alters its list position.

      Parameters

      • gameObject: GameObject

        The Game Object that this Game Object will be moved to be above.

      Returns this

      This Game Object instance.

    • Sets the active property of this Game Object and returns this Game Object for further chaining. A Game Object with its active property set to true will be updated by the Scenes UpdateList.

      Parameters

      • value: boolean

        True if this Game Object should be set as active, false if not.

      Returns this

      This GameObject.

    • Sets the property key to the given value on all members of this List.

      Parameters

      • property: string

        The name of the property to set.

      • value: any

        The value to set the property to.

      • OptionalstartIndex: number

        The first child index to start the search from.

      • OptionalendIndex: number

        The last child index to search up until.

      Returns void

    • Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

      Parameters

      • Optionalvalue: number

        The alpha value applied across the whole Game Object. Default 1.

      Returns this

      This Game Object instance.

    • Move this Game Object so that it appears below the given Game Object.

      This means it will render immediately under the other object in the display list.

      Both objects must belong to the same display list, or parent container.

      This method does not change this Game Objects depth value, it simply alters its list position.

      Parameters

      • gameObject: GameObject

        The Game Object that this Game Object will be moved to be below.

      Returns this

      This Game Object instance.

    • Sets the Blend Mode being used by this Game Object.

      This can be a const, such as Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)

      Under WebGL only the following Blend Modes are available:

      • NORMAL
      • ADD
      • MULTIPLY
      • SCREEN
      • ERASE (only works when rendering to a framebuffer, like a Render Texture)

      Canvas has more available depending on browser support.

      You can also create your own custom Blend Modes in WebGL.

      Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency with which blend modes are used.

      Parameters

      • value: string | number | BlendModes

        The BlendMode value. Either a string, a CONST or a number.

      Returns this

      This Game Object instance.

    • Allows you to store a key value pair within this Game Objects Data Manager.

      If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled before setting the value.

      If the key doesn't already exist in the Data Manager then it is created.

      sprite.setData('name', 'Red Gem Stone');

      You can also pass in an object of key value pairs as the first argument:

      sprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });

      To get a value back again you can call getData:

      sprite.getData('gold');

      Or you can access the value directly via the values property, where it works like any other variable:

      sprite.data.values.gold += 50;

      When the value is first set, a setdata event is emitted from this Game Object.

      If the key already exists, a changedata event is emitted instead, along an event named after the key. For example, if you updated an existing key called PlayerLives then it would emit the event changedata-PlayerLives. These events will be emitted regardless if you use this method to set the value, or the direct values setter.

      Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings. This means the keys gold and Gold are treated as two unique values within the Data Manager.

      Type Parameters

      • T extends unknown

      Parameters

      • key: string | T

        The key to set the value for. Or an object of key value pairs. If an object the data argument is ignored.

      • Optionalvalue: any

        The value to set for the given key. If an object is provided as the key this argument is ignored.

      Returns this

      This GameObject.

    • Adds a Data Manager component to this Game Object.undefined

      Returns this

      This GameObject.

    • Sets the depth of this Game Object. If the value argument is not provided, the depth defaults to 0.

      The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.

      A Game Object with a higher depth value will always render in front of one with a lower value.

      Setting the depth will queue a depth sort event within the Scene.

      Parameters

      • value: number

        The depth of this Game Object. Ensure this value is only ever a number data-type.

      Returns this

      This Game Object instance.

    • Sets whether the filter camera should automatically re-focus on the Game Object every frame. Sets the filtersAutoFocus property.

      Parameters

      • value: boolean

        Whether filters should be updated every frame.

      Returns this

      undefined

    • Set whether the filters should focus on the context. Sets the filtersFocusContext property.

      Parameters

      • value: boolean

        Whether the filters should focus on the context.

      Returns this

      undefined

    • Set whether the filters should always draw to a framebuffer. Sets the filtersForceComposite property.

      Parameters

      • value: boolean

        Whether the object should always draw to a framebuffer, even if there are no active filters.

      Returns this

      undefined

    • Set the base size of the filter camera. This is the size of the texture that internal filters will be drawn to. External filters are drawn to the size of the context (usually the game canvas).

      This is typically the size of the GameObject. It is set automatically when the Game Object is rendered and filtersAutoFocus is enabled. Turn off auto focus to set it manually.

      Technically, larger framebuffers may be used to provide padding. This is the size of the final framebuffer used for "internal" rendering.

      Parameters

      • width: number

        Base width of the filter texture.

      • height: number

        Base height of the filter texture.

      Returns this

      undefined

    • A Layer cannot be enabled for input.

      This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.undefined

      Returns this

      This GameObject.

    • Sets the mask that this Game Object will use to render with.

      The mask must have been previously created and must be a GeometryMask. This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      If a mask is already set on this Game Object it will be immediately replaced.

      Masks are positioned in global space and are not relative to the Game Object to which they are applied. The reason for this is that multiple Game Objects can all share the same mask.

      Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.

      Parameters

      • mask: GeometryMask

        The mask this Game Object will use when rendering.

      Returns this

      This Game Object instance.

    • Sets the name property of this Game Object and returns this Game Object for further chaining. 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 Game Object.

      Returns this

      This GameObject.

    • Set whether the filters should be rendered. Sets the renderFilters property.

      Parameters

      • value: boolean

        Whether the filters should be rendered.

      Returns this

      undefined

    • Sets the current state of this Game Object.

      Phaser itself will never modify the State of a Game Object, although plugins may do so.

      For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'. The state value should typically be an integer (ideally mapped to a constant in your game code), but could also be a string. It is recommended to keep it light and simple. If you need to store complex data about your Game Object, look at using the Data Component instead.

      Parameters

      • value: string | number

        The state of the Game Object.

      Returns this

      This GameObject.

    • Sets this Game Object to the back of the display list, or the back of its parent container.

      Being at the back means it will render below everything else.

      This method does not change this Game Objects depth value, it simply alters its list position.undefined

      Returns this

      This Game Object instance.

    • Sets this Game Object to be at the top of the display list, or the top of its parent container.

      Being at the top means it will render on top of everything else.

      This method does not change this Game Objects depth value, it simply alters its list position.undefined

      Returns this

      This Game Object instance.

    • Sets the vertex round mode of this Game Object. This is used by the WebGL Renderer to determine how to round the vertex positions.

      Parameters

      • mode: string

        The vertex round mode to set. Can be 'off', 'safe', 'safeAuto', 'full' or 'fullAuto'.

      Returns this

      This GameObject.

    • Sets the visibility of this Game Object.

      An invisible Game Object will skip rendering, but will still process update logic.

      Parameters

      • value: boolean

        The visible state of the Game Object.

      Returns this

      This Game Object instance.

    • Shuffles the items in the list.undefined

      Returns Layer

      This List object.

    • Clears the List and recreates its internal array.

      Returns void

    • Sort the contents of this List so the items are in order based on the given property. For example, sort('alpha') would sort the List contents based on the value of their alpha property.

      Parameters

      • property: string

        The property to lexically sort by.

      • Optionalhandler: Function

        Provide your own custom handler function. Will receive 2 children which it should compare and return a number (negative if the first should come before the second, positive if after, zero if equal).

      Returns Layer

      This List object.

    • Compare the depth of two Game Objects.

      Parameters

      Returns number

      The difference between the depths of each Game Object.

    • Swaps the positions of two items in the list.

      Parameters

      Returns void

    • Toggle a boolean value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of false before being toggled to true.

      If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled before setting the value.

      If the key doesn't already exist in the Data Manager then it is created.

      When the value is first set, a setdata event is emitted from this Game Object.

      Parameters

      • key: string

        The key to toggle the value for.

      Returns this

      This GameObject.

    • Returns a JSON representation of the Game Object.undefined

      Returns JSONGameObject

      A JSON representation of the Game Object.

    • Override this method in your own custom Game Objects to perform per-frame update logic. This method is called by the Scene's Update List on every game frame, if the Game Object is on that list. It is not called automatically — the Game Object must be added to the Update List via addToUpdateList or by having a preUpdate method.

      This base implementation is intentionally empty, allowing Game Objects to be used in an Object Pool without requiring any update logic.

      Parameters

      • ...args: any[]

        Any arguments that are passed to the update method.

      Returns void

    • Compares the renderMask with the renderFlags to see if this Game Object will render or not. Also checks the Game Object against the given Cameras exclusion list.

      Parameters

      • camera: Camera

        The Camera to check against this Game Object.

      Returns boolean

      True if the Game Object should be rendered, otherwise false.

    • Whether this Game Object will render filters. This is true if it has active filters, and if the renderFilters property is also true.undefined

      Returns boolean

      Whether the Game Object will render filters.

    • Checks if this Game Object should round its vertices, based on the given Camera and the vertexRoundMode of this Game Object. This is used by the WebGL Renderer to determine how to round the vertex positions.

      You can override this method in your own custom Game Object classes to provide custom logic for vertex rounding.

      Parameters

      • camera: Camera

        The Camera to check against this Game Object.

      • onlyTranslated: boolean

        If true, the object is only translated, not scaled or rotated.

      Returns boolean

      True if the Game Object should be rounded, otherwise false.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    addaddAtaddedToSceneaddListeneraddRenderStepaddToDisplayListaddToUpdateListbringToTopclearAlphaclearMaskcountcreateGeometryMaskdepthSortdestroydisableInteractiveeachemitenableFilterseventNamesexistsfocusFiltersfocusFiltersOnCamerafocusFiltersOverridegetAllgetAtgetByNamegetChildrengetDatagetDisplayListgetFirstgetIndexgetIndexListgetRandomincDatalistenerCountlistenersmoveAbovemoveBelowmoveDownmoveTomoveUpoffononcequeueDepthSortremoveremoveAllremoveAllListenersremoveAtremoveBetweenremovedFromSceneremoveFromDisplayListremoveFromUpdateListremoveInteractiveremoveListenerrenderWebGLFiltersrenderWebGLStepreplacereversesendToBacksetAbovesetActivesetAllsetAlphasetBelowsetBlendModesetDatasetDataEnabledsetDepthsetFiltersAutoFocussetFiltersFocusContextsetFiltersForceCompositesetFilterSizesetInteractivesetMasksetNamesetRenderFilterssetStatesetToBacksetToTopsetVertexRoundModesetVisibleshuffleshutdownsortsortByDepthswaptoggleDatatoJSONupdatewillRenderwillRenderFilterswillRoundVertices