Interface: ContainerEvents<C>

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:59

Events that can be emitted by a Container. These events provide lifecycle hooks and notifications for container state changes.

Example

import { Container, Sprite } from 'pixi.js';

// Setup container with event listeners
const container = new Container();

// Listen for child additions
container.on('childAdded', (child, container, index) => {
    console.log(`Child added at index ${index}:`, child);
});

// Listen for child removals
container.on('childRemoved', (child, container, index) => {
    console.log(`Child removed from index ${index}:`, child);
});

// Listen for when container is added to parent
container.on('added', (parent) => {
    console.log('Added to parent:', parent);
});

// Listen for when container is removed from parent
container.on('removed', (parent) => {
    console.log('Removed from parent:', parent);
});

// Listen for container destruction
container.on('destroyed', (container) => {
    console.log('Container destroyed:', container);
});

Standard

Extends

• ContainerEvents

Type Parameters

C

C extends ContainerChild

Properties

added

> added: [Container<ContainerChild>]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:73

Emitted when this container is added to a new container. Useful for setting up parent-specific behaviors.

Param

The parent container this was added to

Example

const child = new Container();
child.on('added', (parent) => {
    console.log('Child added to parent:', parent.label);
});
parentContainer.addChild(child);

childAdded

> childAdded: [C, Container<ContainerChild>, number]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:88

Emitted when a child is added to this container. Useful for tracking container composition changes.

Param

The child that was added

Param

The container the child was added to (this container)

Param

The index at which the child was added

Example

const parent = new Container();
parent.on('childAdded', (child, container, index) => {
    console.log(`New child at index ${index}:`, child);
});

childRemoved

> childRemoved: [C, Container<ContainerChild>, number]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:116

Emitted when a child is removed from this container. Useful for cleanup and maintaining container state.

Param

The child that was removed

Param

The container the child was removed from (this container)

Param

The index from which the child was removed

Example

const parent = new Container();
parent.on('childRemoved', (child, container, index) => {
    console.log(`Child removed from index ${index}:`, child);
});

click

> click: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.click

clickcapture

> clickcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.clickcapture

destroyed

> destroyed: [Container<ContainerChild>]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:129

Emitted when the container is destroyed. Useful for final cleanup and resource management.

Param

The container that was destroyed

Example

const container = new Container();
container.on('destroyed', (container) => {
    console.log('Container destroyed:', container.label);
});

globalmousemove

> globalmousemove: [FederatedPointerEvent]

Defined in: node_modules/pixi.js/lib/events/FederatedEventMap.d.ts:46

Inherited from

PixiMixins.ContainerEvents.globalmousemove

globalpointermove

> globalpointermove: [FederatedPointerEvent]

Defined in: node_modules/pixi.js/lib/events/FederatedEventMap.d.ts:47

Inherited from

PixiMixins.ContainerEvents.globalpointermove

globaltouchmove

> globaltouchmove: [FederatedPointerEvent]

Defined in: node_modules/pixi.js/lib/events/FederatedEventMap.d.ts:48

Inherited from

PixiMixins.ContainerEvents.globaltouchmove

mousedown

> mousedown: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mousedown

mousedowncapture

> mousedowncapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mousedowncapture

mouseenter

> mouseenter: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseenter

mouseentercapture

> mouseentercapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseentercapture

mouseleave

> mouseleave: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseleave

mouseleavecapture

> mouseleavecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseleavecapture

mousemove

> mousemove: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mousemove

mousemovecapture

> mousemovecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mousemovecapture

mouseout

> mouseout: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseout

mouseoutcapture

> mouseoutcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseoutcapture

mouseover

> mouseover: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseover

mouseovercapture

> mouseovercapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseovercapture

mouseup

> mouseup: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseup

mouseupcapture

> mouseupcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseupcapture

mouseupoutside

> mouseupoutside: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseupoutside

mouseupoutsidecapture

> mouseupoutsidecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.mouseupoutsidecapture

pointercancel

> pointercancel: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointercancel

pointercancelcapture

> pointercancelcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointercancelcapture

pointerdown

> pointerdown: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerdown

pointerdowncapture

> pointerdowncapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerdowncapture

pointerenter

> pointerenter: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerenter

pointerentercapture

> pointerentercapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerentercapture

pointerleave

> pointerleave: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerleave

pointerleavecapture

> pointerleavecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerleavecapture

pointermove

> pointermove: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointermove

pointermovecapture

> pointermovecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointermovecapture

pointerout

> pointerout: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerout

pointeroutcapture

> pointeroutcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointeroutcapture

pointerover

> pointerover: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerover

pointerovercapture

> pointerovercapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerovercapture

pointertap

> pointertap: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointertap

pointertapcapture

> pointertapcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointertapcapture

pointerup

> pointerup: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerup

pointerupcapture

> pointerupcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerupcapture

pointerupoutside

> pointerupoutside: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerupoutside

pointerupoutsidecapture

> pointerupoutsidecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.pointerupoutsidecapture

removed

> removed: [Container<ContainerChild>]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:101

Emitted when this container is removed from its parent. Useful for cleanup and state management.

Param

The parent container this was removed from

Example

const child = new Container();
child.on('removed', (oldParent) => {
    console.log('Child removed from parent:', oldParent.label);
});

rightclick

> rightclick: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightclick

rightclickcapture

> rightclickcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightclickcapture

rightdown

> rightdown: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightdown

rightdowncapture

> rightdowncapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightdowncapture

rightup

> rightup: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightup

rightupcapture

> rightupcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightupcapture

rightupoutside

> rightupoutside: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightupoutside

rightupoutsidecapture

> rightupoutsidecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.rightupoutsidecapture

tap

> tap: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.tap

tapcapture

> tapcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.tapcapture

touchcancel

> touchcancel: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchcancel

touchcancelcapture

> touchcancelcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchcancelcapture

touchend

> touchend: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchend

touchendcapture

> touchendcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchendcapture

touchendoutside

> touchendoutside: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchendoutside

touchendoutsidecapture

> touchendoutsidecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchendoutsidecapture

touchmove

> touchmove: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchmove

touchmovecapture

> touchmovecapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchmovecapture

touchstart

> touchstart: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchstart

touchstartcapture

> touchstartcapture: [FederatedPointerEvent]

Inherited from

PixiMixins.ContainerEvents.touchstartcapture

visibleChanged

> visibleChanged: [boolean]

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:142

Emitted when the visible property on the container is changed. Useful for tracking visibility changes and triggering related behaviors.

Param

The new visibility state of the container

Example

const container = new Container();
container.on('visibleChanged', (visible) => {
    console.log('Container visibility changed:', visible);
});

wheel

> wheel: [FederatedWheelEvent]

Inherited from

PixiMixins.ContainerEvents.wheel

wheelcapture

> wheelcapture: [FederatedWheelEvent]

Inherited from

PixiMixins.ContainerEvents.wheelcapture