Class Sprite

Hierarchy

  • Sprite
    • Sprite

Implements

Constructors

constructor

Properties

_accessibleActive? _accessibleDiv? _anchor _bounds _boundsDirty _filterEffect? _internalEventMode _localBoundsCacheData _localBoundsCacheId _maskEffect? _maskOptions? _onRender _renderId? _texture _zIndex accessible? accessibleChildren? accessibleHint? accessiblePointerEvents? accessibleTitle? accessibleType? boundsArea children cullable? cullableChildren? cullArea? cursor? depthOfChildModified destroy$ destroyed effects? eventMode? filterArea? filters gameObject groupAlpha groupColor groupColorAlpha groupTransform hitArea? interactive? interactiveChildren? isInteractive label localAlpha localColor localTransform mask name onclick? onglobalmousemove? onglobalpointermove? onglobaltouchmove? onmousedown? onmouseenter? onmouseleave? onmousemove? onmouseout? onmouseover? onmouseup? onmouseupoutside? onpointercancel? onpointerdown? onpointerenter? onpointerleave? onpointermove? onpointerout? onpointerover? onpointertap? onpointerup? onpointerupoutside? onRender onrightclick? onrightdown? onrightup? onrightupoutside? ontap? ontouchcancel? ontouchend? ontouchendoutside? ontouchmove? ontouchstart? onwheel? parent relativeGroupTransform setMask sortableChildren sortChildren sortDirty tabIndex? uid update$ zIndex prefixed

Accessors

_didChangeId alpha anchor angle blendMode bounds height isRenderable isRenderGroup pivot position renderable rotation roundPixels scale skew sourceBounds texture tint visible width worldTransform x y

Methods

_setHeight _setWidth addBounds addChild addChildAt addEffect addEventListener addListener containsPoint destroy disableRenderGroup dispatchEvent emit enableRenderGroup eventNames getBounds getChildAt getChildByLabel getChildByName getChildIndex getChildrenByLabel getGlobalPosition getLocalBounds getSize listenerCount listeners off on once removeAllListeners removeChild removeChildAt removeChildren removeEffect removeEventListener removeFromParent removeListener reparentChild reparentChildAt setChildIndex setFromMatrix setSize swapChildren toGlobal toLocal update updateLocalTransform updateTransform from mixin

Constructors

constructor

Properties

Optional_accessibleActive

_accessibleActive?: boolean

Optional_accessibleDiv

_accessibleDiv?: AccessibleHTMLElement

Readonly_anchor

_anchor: ObservablePoint

Protected_bounds

_bounds: Bounds

Protected_boundsDirty

_boundsDirty: boolean

Optional_filterEffect

_filterEffect?: FilterEffect

_internalEventMode

_internalEventMode: EventMode

_localBoundsCacheData

_localBoundsCacheData: LocalBoundsCacheData

_localBoundsCacheId

_localBoundsCacheId: number

Optional_maskEffect

_maskEffect?: MaskEffect

Optional_maskOptions

_maskOptions?: MaskOptions

_onRender

_onRender: (() => void)

Optional_renderId

_renderId?: number

_texture

_texture: Texture<TextureSource<any>>

_zIndex

_zIndex: number

Optionalaccessible

accessible?: boolean

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Default 

false

OptionalaccessibleChildren

accessibleChildren?: boolean

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default 

true

OptionalaccessibleHint

accessibleHint?: string

Sets the aria-label attribute of the shadow div

OptionalaccessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Specify the pointer-events the accessible div will use Defaults to auto.

Default 

'auto'

OptionalaccessibleTitle

accessibleTitle?: string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'

Member

OptionalaccessibleType

accessibleType?: string

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default 

'button'

boundsArea

boundsArea: Rectangle

An optional bounds area for this container. Setting this rectangle will stop the renderer from recursively measuring the bounds of each children and instead use this single boundArea. This is great for optimisation! If for example you have a 1000 spinning particles and you know they all sit within a specific bounds, then setting it will mean the renderer will not need to measure the 1000 children to find the bounds. Instead it will just use the bounds you set.

Readonlychildren

children: ContainerChild[]

The array of children of this container.

Optionalcullable

cullable?: boolean

Should this object be rendered if the bounds of this object are out of frame?

Culling has no effect on whether updateTransform is called.

Default 

false

Memberof

scene.Container#

OptionalcullableChildren

cullableChildren?: boolean

Determines if the children to the container can be culled Setting this to false allows PixiJS to bypass a recursive culling function Which can help to optimize very complex scenes

Default 

true

Memberof

scene.Container#

OptionalcullArea

cullArea?: Rectangle

If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.

Memberof

scene.Container#

Optionalcursor

cursor?: string

The cursor preferred when the mouse pointer is hovering over.

depthOfChildModified

depthOfChildModified: (() => void)

Readonlydestroy$

destroy$: Subject<void> = ...

When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.

destroyed

destroyed: boolean

If the object has been destroyed via destroy(). If true, it should not be used.

Optionaleffects

effects?: Effect[]

OptionaleventMode

eventMode?: EventMode

The mode of interaction for this object

OptionalfilterArea

filterArea?: Rectangle

filters

filters: Filter | Filter[]

gameObject

gameObject: LifecycleParent

Parent GameObject is assigned at creation.

groupAlpha

groupAlpha: number

groupColor

groupColor: number

groupColorAlpha

groupColorAlpha: number

ReadonlygroupTransform

groupTransform: Matrix

The group transform is a transform relative to the render group it belongs too. If this container is render group then this will be an identity matrix. other wise it will be the same as the relativeGroupTransform. Use this value when actually rendering things to the screen

OptionalhitArea

hitArea?: IHitArea

The hit-area specifies the area for which pointer events should be captured by this event target.

Optionalinteractive

interactive?: boolean

Whether this event target should fire UI events.

OptionalinteractiveChildren

interactiveChildren?: boolean

Whether this event target has any children that need UI events. This can be used optimize event propagation.

isInteractive

isInteractive: (() => boolean)

Returns true if the Container has interactive 'static' or 'dynamic'

label

label: string = 'Sprite'

Each Lifecycle Object has label for pixi debugging.

localAlpha

localAlpha: number

localColor

localColor: number

ReadonlylocalTransform

localTransform: Matrix

Current transform of the object based on local factors: position, scale, other stuff.

mask

mask: Mask

name

name: string

Deprecated

since 8.0.0

See

Container#label

Optionalonclick

onclick?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'click' event

Optionalonglobalmousemove

onglobalmousemove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'globalmousemove' event

Optionalonglobalpointermove

onglobalpointermove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'globalpointermove' event

Optionalonglobaltouchmove

onglobaltouchmove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'globaltouchmove' event

Optionalonmousedown

onmousedown?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mousedown' event

Optionalonmouseenter

onmouseenter?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseenter' event

Optionalonmouseleave

onmouseleave?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseleave' event

Optionalonmousemove

onmousemove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mousemove' event

Optionalonmouseout

onmouseout?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseout' event

Optionalonmouseover

onmouseover?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseover' event

Optionalonmouseup

onmouseup?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseup' event

Optionalonmouseupoutside

onmouseupoutside?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseupoutside' event

Optionalonpointercancel

onpointercancel?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointercancel' event

Optionalonpointerdown

onpointerdown?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerdown' event

Optionalonpointerenter

onpointerenter?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerenter' event

Optionalonpointerleave

onpointerleave?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerleave' event

Optionalonpointermove

onpointermove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointermove' event

Optionalonpointerout

onpointerout?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerout' event

Optionalonpointerover

onpointerover?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerover' event

Optionalonpointertap

onpointertap?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointertap' event

Optionalonpointerup

onpointerup?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerup' event

Optionalonpointerupoutside

onpointerupoutside?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerupoutside' event

onRender

onRender: (() => void)

Optionalonrightclick

onrightclick?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightclick' event

Optionalonrightdown

onrightdown?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightdown' event

Optionalonrightup

onrightup?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightup' event

Optionalonrightupoutside

onrightupoutside?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightupoutside' event

Optionalontap

ontap?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'tap' event

Optionalontouchcancel

ontouchcancel?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchcancel' event

Optionalontouchend

ontouchend?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchend' event

Optionalontouchendoutside

ontouchendoutside?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchendoutside' event

Optionalontouchmove

ontouchmove?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchmove' event

Optionalontouchstart

ontouchstart?: FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchstart' event

Optionalonwheel

onwheel?: FederatedEventHandler<FederatedWheelEvent>

Handler for 'wheel' event

parent

parent: Container<ContainerChild>

The display object container that contains this display object.

ReadonlyrelativeGroupTransform

relativeGroupTransform: Matrix

The relative group transform is a transform relative to the render group it belongs too. It will include all parent transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested). If this container is is self a render group matrix will be relative to its parent render group

setMask

setMask: ((options: Partial<MaskOptions>) => void)

sortableChildren

sortableChildren: boolean

sortChildren

sortChildren: (() => void)

sortDirty

sortDirty: boolean

OptionaltabIndex

tabIndex?: number

Default 

0

Readonlyuid

uid: number

unique id for this container

Readonlyupdate$

update$: Subject<number> = ...

When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.

zIndex

zIndex: number

Staticprefixed

prefixed: string | boolean

Accessors

_didChangeId

  • get _didChangeId(): number

  • Returns number

alpha

  • get alpha(): number

  • The opacity of the object.

    Returns number

  • set alpha(value): void

  • Parameters

    • value: number

    Returns void

anchor

  • get anchor(): ObservablePoint

  • The anchor sets the origin point of the sprite. The default value is taken from the Texture and passed to the constructor.

    The default is (0,0), this means the sprite's origin is the top left.

    Setting the anchor to (0.5,0.5) means the sprite's origin is centered.

    Setting the anchor to (1,1) would mean the sprite's origin point will be the bottom right corner.

    If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

    Returns ObservablePoint

    Example 

    import { Sprite } from 'pixi.js';

    const sprite = new Sprite({texture: Texture.WHITE});
    sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
  • set anchor(value): void

  • Parameters

    • value: number | PointData

    Returns void

angle

  • get angle(): number

  • The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    Returns number

  • set angle(value): void

  • Parameters

    • value: number

    Returns void

blendMode

  • get blendMode(): BLEND_MODES

  • The blend mode to be applied to the sprite. Apply a value of 'normal' to reset the blend mode.

    Returns BLEND_MODES

    Default 

    'normal'
  • set blendMode(value): void

  • Parameters

    • value: BLEND_MODES

    Returns void

bounds

  • get bounds(): Bounds

  • The local bounds of the sprite.

    Returns Bounds

height

  • get height(): number

  • The height of the sprite, setting this will actually modify the scale to achieve the value set.

    Returns number

  • set height(value): void

  • The height of the Container, setting this will actually modify the scale to achieve the value set.

    Parameters

    • value: number

    Returns void

    Memberof

    scene.Container#

isRenderable

  • get isRenderable(): boolean

  • Whether or not the object should be rendered.

    Returns boolean

isRenderGroup

  • get isRenderGroup(): boolean

  • Returns true if this container is a render group. This means that it will be rendered as a separate pass, with its own set of instructions

    Returns boolean

  • set isRenderGroup(value): void

  • Parameters

    • value: boolean

    Returns void

pivot

  • get pivot(): ObservablePoint

  • The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

    By default, the pivot is the origin (0, 0).

    Returns ObservablePoint

    Since

    4.0.0

  • set pivot(value): void

  • Parameters

    • value: number | PointData

    Returns void

position

  • get position(): ObservablePoint

  • The coordinate of the object relative to the local coordinates of the parent.

    Returns ObservablePoint

    Since

    4.0.0

  • set position(value): void

  • Parameters

    • value: PointData

    Returns void

renderable

  • get renderable(): boolean

  • Can this object be rendered, if false the object will not be drawn but the transform will still be updated.

    Returns boolean

  • set renderable(value): void

  • Parameters

    • value: boolean

    Returns void

rotation

  • get rotation(): number

  • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    Returns number

  • set rotation(value): void

  • Parameters

    • value: number

    Returns void

roundPixels

  • get roundPixels(): boolean

  • Whether or not to round the x/y position of the sprite.

    Returns boolean

  • set roundPixels(value): void

  • Whether or not to round the x/y position of the object.

    Parameters

    • value: boolean

    Returns void

scale

  • get scale(): ObservablePoint

  • The scale factors of this object along the local coordinate axes.

    The default scale is (1, 1).

    Returns ObservablePoint

    Since

    4.0.0

  • set scale(value): void

  • Parameters

    • value: number | PointData

    Returns void

skew

  • get skew(): ObservablePoint

  • The skew factor for the object in radians.

    Returns ObservablePoint

    Since

    4.0.0

  • set skew(value): void

  • Parameters

    • value: PointData

    Returns void

sourceBounds

  • get sourceBounds(): BoundsData

  • The bounds of the sprite, taking the texture's trim into account.

    Returns BoundsData

texture

  • get texture(): Texture<TextureSource<any>>

  • The texture that the sprite is using.

    Returns Texture<TextureSource<any>>

  • set texture(value): void

  • Parameters

    • value: Texture<TextureSource<any>>

    Returns void

tint

  • get tint(): number

  • The tint applied to the sprite. This is a hex value.

    A value of 0xFFFFFF will remove any tint effect.

    Returns number

    Default 

    0xFFFFFF
  • set tint(value): void

  • Parameters

    • value: ColorSource

    Returns void

visible

  • get visible(): boolean

  • The visibility of the object. If false the object will not be drawn, and the transform will not be updated.

    Returns boolean

  • set visible(value): void

  • Parameters

    • value: boolean

    Returns void

width

  • get width(): number

  • The width of the sprite, setting this will actually modify the scale to achieve the value set.

    Returns number

  • set width(value): void

  • The width of the Container, setting this will actually modify the scale to achieve the value set.

    Parameters

    • value: number

    Returns void

    Memberof

    scene.Container#

worldTransform

  • get worldTransform(): Matrix

  • Current transform of the object based on world (parent) factors.

    Returns Matrix

x

  • get x(): number

  • The position of the container on the x axis relative to the local coordinates of the parent. An alias to position.x

    Returns number

  • set x(value): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • The position of the container on the y axis relative to the local coordinates of the parent. An alias to position.y

    Returns number

  • set y(value): void

  • Parameters

    • value: number

    Returns void

Methods

_setHeight

  • _setHeight(height, localHeight): void

  • Parameters

    • height: number
    • localHeight: number

    Returns void

_setWidth

  • _setWidth(width, localWidth): void

  • Parameters

    • width: number
    • localWidth: number

    Returns void

addBounds

  • addBounds(bounds): void

  • Adds the bounds of this object to the bounds object.

    Parameters

    • bounds: Bounds

      The output bounds object.

    Returns void

addChild

  • addChild<U>(...children): U[0]

  • Adds one or more children to the container.

    Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

    Type Parameters

    • U extends ContainerChild[]

    Parameters

    • Rest...children: U

      The Container(s) to add to the container

    Returns U[0]

    • The first child that was added.

addChildAt

  • addChildAt<U>(child, index): U

  • Type Parameters

    • U extends ContainerChild

    Parameters

    • child: U
    • index: number

    Returns U

addEffect

  • addEffect(effect): void

  • Parameters

    • effect: Effect

    Returns void

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

    Parameters

    • type: K
    • listener: ((e: AllFederatedEventMap[K]) => any)
        • (e): any

        • Parameters

          • e: AllFederatedEventMap[K]

          Returns any

    • Optionaloptions: AddListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: AddListenerOptions

    Returns void

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • fn: ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)
        • (...args): void

        • Parameters

          • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

          Returns void

    • Optionalcontext: any

    Returns this

containsPoint

  • containsPoint(point): boolean

  • Checks if the object contains the given point.

    Parameters

    • point: PointData

      The point to check

    Returns boolean

destroy

disableRenderGroup

  • disableRenderGroup(): void

  • This will disable the render group for this container.

    Returns void

dispatchEvent

  • dispatchEvent(e): boolean

  • Parameters

    • e: FederatedEvent<UIEvent | PixiTouch>

    Returns boolean

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

    Returns boolean

enableRenderGroup

  • enableRenderGroup(): void

  • Calling this enables a render group for this container. This means it will be rendered as a separate set of instructions. The transform of the container will also be handled on the GPU rather than the CPU.

    Returns void

eventNames

  • eventNames(): ((keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent))[]

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

    Returns ((keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent))[]

getBounds

  • getBounds(skipUpdate?, bounds?): Bounds

  • Parameters

    • OptionalskipUpdate: boolean
    • Optionalbounds: Bounds

    Returns Bounds

getChildAt

  • getChildAt<U>(index): U

  • Type Parameters

    • U extends ContainerChild

    Parameters

    • index: number

    Returns U

getChildByLabel

  • getChildByLabel(label, deep?): Container<ContainerChild>

  • Parameters

    • label: string | RegExp
    • Optionaldeep: boolean

    Returns Container<ContainerChild>

getChildByName

  • getChildByName(label, deep?): Container<ContainerChild>

  • Parameters

    • label: string | RegExp
    • Optionaldeep: boolean

    Returns Container<ContainerChild>

getChildIndex

  • getChildIndex(child): number

  • Parameters

    • child: ContainerChild

    Returns number

getChildrenByLabel

  • getChildrenByLabel(label, deep?, out?): Container<ContainerChild>[]

  • Parameters

    • label: string | RegExp
    • Optionaldeep: boolean
    • Optionalout: Container<ContainerChild>[]

    Returns Container<ContainerChild>[]

getGlobalPosition

  • getGlobalPosition(point?, skipUpdate?): Point

  • Parameters

    • Optionalpoint: Point
    • OptionalskipUpdate: boolean

    Returns Point

getLocalBounds

  • getLocalBounds(bounds?): Bounds

  • Parameters

    • Optionalbounds: Bounds

    Returns Bounds

getSize

  • getSize(out?): Size

  • Retrieves the size of the Sprite as a [Size]Size object. This is faster than get the width and height separately.

    Parameters

    • Optionalout: Size

      Optional object to store the size in.

    Returns Size

    • The size of the Sprite.

listenerCount

  • listenerCount(event): number

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

    Parameters

    • event: (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Returns number

listeners

  • listeners<T>(event): ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T

    Returns ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • Optionalfn: ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)
        • (...args): void

        • Parameters

          • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • fn: ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)
        • (...args): void

        • Parameters

          • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

          Returns void

    • Optionalcontext: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • fn: ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)
        • (...args): void

        • Parameters

          • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

          Returns void

    • Optionalcontext: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

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

    Parameters

    • Optionalevent: (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Returns this

removeChild

  • removeChild<U>(...children): U[0]

  • Removes one or more children from the container.

    Type Parameters

    • U extends ContainerChild[]

    Parameters

    • Rest...children: U

      The Container(s) to remove

    Returns U[0]

    The first child that was removed.

removeChildAt

  • removeChildAt<U>(index): U

  • Type Parameters

    • U extends ContainerChild

    Parameters

    • index: number

    Returns U

removeChildren

  • removeChildren(beginIndex?, endIndex?): ContainerChild[]

  • Parameters

    • OptionalbeginIndex: number
    • OptionalendIndex: number

    Returns ContainerChild[]

removeEffect

  • removeEffect(effect): void

  • Parameters

    • effect: Effect

    Returns void

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

    Parameters

    • type: K
    • listener: ((e: AllFederatedEventMap[K]) => any)
        • (e): any

        • Parameters

          • e: AllFederatedEventMap[K]

          Returns any

    • Optionaloptions: RemoveListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: RemoveListenerOptions

    Returns void

removeFromParent

  • removeFromParent(): void

  • Returns void

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)

    Parameters

    • event: T
    • Optionalfn: ((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]) => void)
        • (...args): void

        • Parameters

          • Rest...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof ContainerEvents<ContainerChild>) | (keyof AnyEvent)>]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

reparentChild

  • reparentChild<U>(...child): U[0]

  • Type Parameters

    • U extends ContainerChild[]

    Parameters

    • Rest...child: U

    Returns U[0]

reparentChildAt

  • reparentChildAt<U>(child, index): U

  • Type Parameters

    • U extends ContainerChild

    Parameters

    • child: U
    • index: number

    Returns U

setChildIndex

  • setChildIndex(child, index): void

  • Parameters

    • child: ContainerChild
    • index: number

    Returns void

setFromMatrix

  • setFromMatrix(matrix): void

  • Updates the local transform using the given matrix.

    Parameters

    • matrix: Matrix

      The matrix to use for updating the transform.

    Returns void

setSize

  • setSize(value, height?): void

  • Sets the size of the Sprite to the specified width and height. This is faster than setting the width and height separately.

    Parameters

    • value: number | Optional<Size, "height">

      This can be either a number or a [Size]Size object.

    • Optionalheight: number

      The height to set. Defaults to the value of width if not provided.

    Returns void

swapChildren

  • swapChildren<U>(child, child2): void

  • Type Parameters

    • U extends ContainerChild

    Parameters

    • child: U
    • child2: U

    Returns void

toGlobal

  • toGlobal<P>(position, point?, skipUpdate?): P

  • Type Parameters

    • P extends PointData = Point

    Parameters

    • position: PointData
    • Optionalpoint: P
    • OptionalskipUpdate: boolean

    Returns P

toLocal

  • toLocal<P>(position, from?, point?, skipUpdate?): P

  • Type Parameters

    • P extends PointData = Point

    Parameters

    • position: PointData
    • Optionalfrom: Container<ContainerChild>
    • Optionalpoint: P
    • OptionalskipUpdate: boolean

    Returns P

update

updateLocalTransform

  • updateLocalTransform(): void

  • Updates the local transform.

    Returns void

updateTransform

  • updateTransform(opts): this

  • Updates the transform properties of the container (accepts partial values).

    Parameters

    • opts: Partial<UpdateTransformOptions>

      The options for updating the transform.

    Returns this

Staticfrom

  • from(source, skipCache?): Sprite

  • Helper function that creates a new sprite based on the source you provide. The source can be - frame id, image, video, canvas element, video element, texture

    Parameters

    • source: Texture<TextureSource<any>> | TextureSourceLike

      Source to create texture from

    • OptionalskipCache: boolean

      Whether to skip the cache or not

    Returns Sprite

    The newly created sprite

Staticmixin

  • mixin(source): void

  • Mixes all enumerable properties and methods from a source object to Container.

    Parameters

    • source: Dict<any>

      The source of properties and methods to mix in.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
_accessibleActive _accessibleDiv _anchor _bounds _boundsDirty _filterEffect _internalEventMode _localBoundsCacheData _localBoundsCacheId _maskEffect _maskOptions _onRender _renderId _texture _zIndex accessible accessibleChildren accessibleHint accessiblePointerEvents accessibleTitle accessibleType boundsArea children cullable cullableChildren cullArea cursor depthOfChildModified destroy$ destroyed effects eventMode filterArea filters gameObject groupAlpha groupColor groupColorAlpha groupTransform hitArea interactive interactiveChildren isInteractive label localAlpha localColor localTransform mask name onclick onglobalmousemove onglobalpointermove onglobaltouchmove onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onmouseupoutside onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointertap onpointerup onpointerupoutside onRender onrightclick onrightdown onrightup onrightupoutside ontap ontouchcancel ontouchend ontouchendoutside ontouchmove ontouchstart onwheel parent relativeGroupTransform setMask sortableChildren sortChildren sortDirty tabIndex uid update$ zIndex prefixed
Accessors
Methods