Pixi’VN
indexClasses

Class: EventSuppressor

pixi-vn on GitHub

Defined in: src/canvas/components/EventSuppressor.ts:32

Emits the savable events of a canvas component (e.g. "complete" of an AnimatedSprite, "ended" of a VideoSprite) and silences them while the component is loading or restoring a save, so the listeners don't run again. Other events (e.g. pointer events) are not affected.

Silencing is counted: nested and concurrent run calls keep the events silenced until the last one finishes, even if one of them throws.

Example

class MyComponent extends Sprite {
    private readonly eventSuppressor = new EventSuppressor();
    protected onSomething() {
        this.eventSuppressor.emit(this, "something");
    }
    override async setMemory(memory: SpriteMemory) {
        await this.eventSuppressor.run(() => super.setMemory(memory));
    }
}

Constructors

Constructor

> new EventSuppressor(): EventSuppressor

Returns

EventSuppressor

Accessors

silent

Get Signature

> get silent(): boolean

Defined in: src/canvas/components/EventSuppressor.ts:37

true while at least one run call is in progress.

Returns

boolean

Methods

emit()

> emit<Event, Args>(target, event, ...args): boolean

Defined in: src/canvas/components/EventSuppressor.ts:56

Emit event on target with args, unless the events are silenced.

Type Parameters

Event

Event extends string | symbol

Args

Args extends unknown[]

Parameters

target

EventSuppressorTarget<NoInfer<Event>, NoInfer<Args>>

event

Event

args

...Args

Returns

boolean

true if the event was emitted.


run()

> run<T>(fn): Promise<T>

Defined in: src/canvas/components/EventSuppressor.ts:44

Run fn with the events silenced until it (and its returned promise) settles.

Type Parameters

T

T

Parameters

fn

() => T | Promise<T>

Returns

Promise<T>

The result of fn.

On this page