Interface: EventSystemOptions

Defined in: node_modules/pixi.js/lib/events/EventSystem.d.ts:39

Options for configuring the PixiJS event system. These options control how the event system handles different types of interactions and event propagation.

Example

// Basic event system configuration
const app = new Application();
await app.init({
    // Configure default interaction mode
    eventMode: 'static',

    // Configure event features
    eventFeatures: {
        move: true,           // Enable pointer movement events
        globalMove: false,    // Disable global move events
        click: true,          // Enable click events
        wheel: true          // Enable wheel/scroll events
    }
});

// Access event system after initialization
const eventSystem = app.renderer.events;
console.log(eventSystem.features); // Check enabled features

See

• EventSystem For the main event system implementation
• EventMode For interaction mode details
• EventSystemFeatures For all available feature options

Advanced

Properties

eventFeatures?

> optional eventFeatures?: Partial<EventSystemFeatures>

Defined in: node_modules/pixi.js/lib/events/EventSystem.d.ts:71

Configuration for enabling/disabling specific event features. Use this to optimize performance by turning off unused functionality.

Example

const app = new Application();
await app.init({
    eventFeatures: {
        // Core interaction events
        move: true,        // Pointer/mouse/touch movement
        click: true,       // Click/tap events
        wheel: true,       // Mouse wheel/scroll events
        // Global tracking
        globalMove: false  // Global pointer movement
    }
});

eventMode?

> optional eventMode?: EventMode

Defined in: node_modules/pixi.js/lib/events/EventSystem.d.ts:52

The default event mode for all display objects. Controls how objects respond to interaction events.

Possible values:

• 'none': No interaction events
• 'passive': Only container's children receive events (default)
• 'auto': Receives events when parent is interactive
• 'static': Standard interaction events
• 'dynamic': Like static but with additional synthetic events

Default

'passive'