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
OptionalaccessibleOptionalaccessibleSets the text content of the shadow div
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.
Legacy property for backwards compatibility with PixiJS v7 and
below. Use cacheAsTexture instead.
Caches this container as a texture. This allows the container to be rendered as a single texture, which can improve performance for complex static containers.
If true, enables caching with default options. If false, disables caching. Can also pass options object to configure caching behavior.
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.
ReadonlyisWhether this container is currently cached as a texture.
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.
ReadonlyparentThe RenderLayer this container belongs to, if any. If it belongs to a RenderLayer, it will be rendered from the RenderLayer's position in the scene.
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.
Updates the cached texture of this container. This will flag the container's cached texture to be redrawn on the next render.
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.
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
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.
Reference to inner State Machine's state.
Reference to inner State Machine's state$ Subject.
The visibility of the object. If false the object will not be drawn, and the transform will not be updated.
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
Recursively calculates the global bounds for the container and its children. This method is used internally by getFastGlobalBounds to traverse the scene graph.
A flag indicating whether to consider render layers in the calculation.
The bounds object to update with the calculated values.
The current render layer being processed.
Collects all renderables from the container and its children, adding them to the instruction set. This method decides whether to use a simple or advanced collection method based on the container's properties.
The set of instructions to which the renderables will be added.
The renderer responsible for rendering the scene.
The current render layer being processed.
Collects renderables using a simple method, suitable for containers marked as simple. This method iterates over the container's children and adds their renderables to the instruction set.
The set of instructions to which the renderables will be added.
The renderer responsible for rendering the scene.
The current render layer being processed.
Collects renderables using an advanced method, suitable for containers with complex processing needs. This method handles additional effects and transformations that may be applied to the renderables.
The set of instructions to which the renderables will be added.
The renderer responsible for rendering the scene.
The current render layer being processed.
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
if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
Only used for children with textures e.g. Sprites. If options.children is set to true it should destroy the texture of the child sprite
Only used for children with textures e.g. Sprites. If options.children is set to true it should destroy the texture source of the child sprite
Only used for children with graphicsContexts e.g. Graphics. If options.children is set to true it should destroy the context of the child graphics
This will disable the render group for this container.
Calls each of the listeners registered for a given event.
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.
Return an array listing the events for which the emitter has registered listeners.
OptionalskipUpdate:
boolean
Optionalbounds:
Bounds
Optionaldeep:
boolean
Optionaldeep:
boolean
ProtectedgetComputes an approximate global bounding box for the container and its children. This method is optimized for speed by using axis-aligned bounding boxes (AABBs), and uses the last render results from when it updated the transforms. This function does not update them. which may result in slightly larger bounds but never smaller than the actual bounds.
for accurate (but less performant) results use
container.getGlobalBounds
OptionalfactorRenderLayers:
boolean
A flag indicating whether to consider render layers in the calculation.
Optionalbounds:
Bounds
The output bounds object to store the result. If not provided, a new one is created.
The computed bounds.
ProtectedgetOptionalpoint:
Point
OptionalskipUpdate:
boolean
OptionalskipUpdate:
boolean
Optionalbounds:
Bounds
Retrieves the size of the container as a [Size]Size object. This is faster than get the width and height separately.
Optionalout:
Size
Optional object to store the size in.
Return the number of listeners listening to a given event.
Return the listeners registered for a given event.
Add a listener for a given event.
Add a one-time listener for a given event.
OptionalbeginIndex:
number
OptionalendIndex:
number
Remove the listeners of a given event.
Updates the local transform using the given matrix.
The matrix to use for updating the transform.
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.
= 1.0 for 60FPS
Updates the local transform.
Updates the transform properties of the container (accepts partial values).
The options for updating the transform.
The x position of the container.
The y position of the container.
The scale factor on the x-axis.
The scale factor on the y-axis.
The rotation of the container, in radians.
The skew factor on the x-axis.
The skew factor on the y-axis.
The x coordinate of the pivot point.
The y coordinate of the pivot point.
Staticmixin
Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set