gibbon.js/src/events/engine-events.ts

Actor/Component system for use with pixi.js.

import type { Actor } from '../core/actor';
import type { Collider2d } from '../components/collider2d';
import type { Component } from '../core/component';
import type { DisplayObject } from 'pixi.js';
import type EventEmitter from 'eventemitter3';

/**
 * Ensure string|symbol events are converted to { [string]:(EventListener)} format.
 */
export type EventObject<E extends EventEmitter.ValidEventTypes> = E extends string | symbol ? Record<E, EventEmitter.EventListener<E, EventEmitter.EventNames<E>>> : E;


export type CombineEvents<E1 extends EventEmitter.ValidEventTypes, E2 extends EventEmitter.ValidEventTypes> = EventObject<E1> & EventObject<E2>;

export type UnionEmitter = EventEmitter<CombineEvents<GameEvents, string | symbol | object>>;


/**
 * Core GameEvents emitted and used by the system.
 */
export enum EngineEvent {
    ActorDestroyed = 'destroy',

    /**
     * At the point when a component is destroyed,
     * its actor can still be referenced through comp.actor.
     */
    ComponentDestroyed = 'compDestroy',
    ChildAdded = 'addChild',
    ChildRemoved = 'removeChild',
    Collision = 'collision',
    ScreenResized = 'resize',

}

export type GameEvents = {

    [EngineEvent.ActorDestroyed]: (actor: Actor) => void,
    [EngineEvent.ComponentDestroyed]: (comp: Component) => void,
    [EngineEvent.ChildAdded]: <T extends DisplayObject>(actor: Actor<T>) => void;
    [EngineEvent.ChildRemoved]: (actor: Actor<DisplayObject>) => void;
    [EngineEvent.Collision]: (collider: Collider2d, hits: Collider2d[]) => void;


}