Small World Engine API Reference - v0.46.1
    Preparing search index...

    Interface Events

    Interface for event dispatching and listening.

    interface Events {
        addEventListener(type: string, listener: EventHandler): void;
        dispatchEvent(type: string, eventData?: Record<string, unknown>): void;
        removeEventListener(type: string, listener: EventHandler): void;
    }

    Implemented by

    Index

    Methods

    • Dispatches an event.

      Parameters

      • type: string

        The event type.

      • OptionaleventData: Record<string, unknown>

        Optional data associated with the event.

      Returns void

    • Removes a registered event listener.

      Parameters

      • type: string

        The event type.

      • listener: EventHandler

        The callback function to remove.

      Returns void