Optional_accessibleOptional_accessibleOptional_filterOptional_maskOptional_maskOptional_renderOptionalaccessible
OptionalaccessibleSetting to false will prevent any children inside this container to be accessible. Defaults to true.
OptionalaccessibleSets the aria-label attribute of the shadow div
OptionalaccessibleSpecify the pointer-events the accessible div will use Defaults to auto.
OptionalaccessibleSets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'
OptionalaccessibleSpecify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.
Optionalanimation
Pointer to currently visible animation.
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
The array of children of this container.
Readonlycomplete$
When animation completes, it emits this subject.
Optionalcullable
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
OptionalcullableDetermines 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
OptionalcullIf 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.
Optionalcursor
The cursor preferred when the mouse pointer is hovering over.
Readonlydestroy$
When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.
If the object has been destroyed via destroy(). If true, it should not be used.
Optionaleffects
OptionaleventThe mode of interaction for this object
OptionalfilterParent GameObject is assigned at creation.
ReadonlygroupThe 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
OptionalhitThe hit-area specifies the area for which pointer events should be captured by this event target.
Optionalinteractive
Whether this event target should fire UI events.
OptionalinteractiveWhether this event target has any children that need UI events. This can be used optimize event propagation.
Returns true if the Container has interactive 'static' or 'dynamic'
Each Lifecycle Object has label for pixi debugging.
ReadonlylocalCurrent transform of the object based on local factors: position, scale, other stuff.
Optionalonclick
Handler for 'click' event
Optionalonglobalmousemove
Handler for 'globalmousemove' event
Optionalonglobalpointermove
Handler for 'globalpointermove' event
Optionalonglobaltouchmove
Handler for 'globaltouchmove' event
Optionalonmousedown
Handler for 'mousedown' event
Optionalonmouseenter
Handler for 'mouseenter' event
Optionalonmouseleave
Handler for 'mouseleave' event
Optionalonmousemove
Handler for 'mousemove' event
Optionalonmouseout
Handler for 'mouseout' event
Optionalonmouseover
Handler for 'mouseover' event
Optionalonmouseup
Handler for 'mouseup' event
Optionalonmouseupoutside
Handler for 'mouseupoutside' event
Optionalonpointercancel
Handler for 'pointercancel' event
Optionalonpointerdown
Handler for 'pointerdown' event
Optionalonpointerenter
Handler for 'pointerenter' event
Optionalonpointerleave
Handler for 'pointerleave' event
Optionalonpointermove
Handler for 'pointermove' event
Optionalonpointerout
Handler for 'pointerout' event
Optionalonpointerover
Handler for 'pointerover' event
Optionalonpointertap
Handler for 'pointertap' event
Optionalonpointerup
Handler for 'pointerup' event
Optionalonpointerupoutside
Handler for 'pointerupoutside' event
Optionalonrightclick
Handler for 'rightclick' event
Optionalonrightdown
Handler for 'rightdown' event
Optionalonrightup
Handler for 'rightup' event
Optionalonrightupoutside
Handler for 'rightupoutside' event
Optionalontap
Handler for 'tap' event
Optionalontouchcancel
Handler for 'touchcancel' event
Optionalontouchend
Handler for 'touchend' event
Optionalontouchendoutside
Handler for 'touchendoutside' event
Optionalontouchmove
Handler for 'touchmove' event
Optionalontouchstart
Handler for 'touchstart' event
Optionalonwheel
Handler for 'wheel' event
The display object container that contains this display object.
ReadonlyrelativeThe 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
ReadonlyrenderReadonlysprite
Animator has sprite container for animations.
ReadonlystateInner State Machine Object.
List of possible animations.
OptionaltabReadonlyuid
unique id for this container
Readonlyupdate$
When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.
Staticprefixed
The opacity of the object.
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.
The blend mode to be applied to the sprite. Apply a value
of 'normal' to reset the blend mode.
The height of the Container, setting this will actually modify the scale to achieve the value set.
Whether or not the object should be rendered.
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
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).
The coordinate of the object relative to the local coordinates of the parent.
Can this object be rendered, if false the object will not be drawn but the transform will still be updated.
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.
Reference to inner animation scale.
The skew factor for the object in radians.
Reference to inner State Machine's state.
Reference to inner State Machine's state$ Subject.
The tint applied to the sprite. This is a hex value.
A value of 0xFFFFFF will remove any tint effect.
The visibility of the object. If false the object will not be drawn, and the transform will not be updated.
The width of the Container, setting this will actually modify the scale to achieve the value set.
Current transform of the object based on world (parent) factors.
The position of the container on the x axis relative to the local coordinates of the parent. An alias to position.x
The position of the container on the y axis relative to the local coordinates of the parent. An alias to position.y
Optionaloptions:
AddListenerOptions
Rest...args:
ArgumentMap<ContainerEvents<ContainerChild>
& AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>)
| (keyof AnyEvent)>]
Optionalcontext:
any
Removes all internal references and listeners as well as
removes children from the display list. Do not use a
Container after calling destroy.
Optionaloptions:
DestroyOptions
Options parameter. A boolean will act as if all options have been set to that value
Calls each of the listeners registered for a given event.
ProtectedgetProtectedgetReturn the listeners registered for a given event.
Optionalfn:
((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>) | (keyof
AnyEvent)>]) => void)
Rest...args:
ArgumentMap<ContainerEvents<ContainerChild>
& AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>)
| (keyof AnyEvent)>]
Optionalcontext:
any
Optionalonce:
boolean
Add a listener for a given event.
Rest...args:
ArgumentMap<ContainerEvents<ContainerChild>
& AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>)
| (keyof AnyEvent)>]
Optionalcontext:
any
Add a one-time listener for a given event.
Rest...args:
ArgumentMap<ContainerEvents<ContainerChild>
& AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>)
| (keyof AnyEvent)>]
Optionalcontext:
any
Optionaloptions:
RemoveListenerOptions
Remove the listeners of a given event.
Optionalfn:
((...args: ArgumentMap<ContainerEvents<ContainerChild> & AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>) | (keyof
AnyEvent)>]) => void)
Rest...args:
ArgumentMap<ContainerEvents<ContainerChild>
& AnyEvent>[Extract<T, (keyof
ContainerEvents<ContainerChild>)
| (keyof AnyEvent)>]
Optionalcontext:
any
Optionalonce:
boolean
Sets the size of the container to the specified width and height. This is faster than setting the width and height separately.
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.
Staticmixin
Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set