Interface Plugin<TPluginApi>

Plugin interface — transforms a base world into an enhanced world. Can optionally include lifecycle hooks that fire after world operations.

interface Plugin<TPluginApi extends object = object> {
    onChat?: (world: MolrooWorld, result: ChatResult) => Promise<void>;
    onEvent?: (world: MolrooWorld, result: EventResult) => Promise<void>;
    onPhaseChange?: (
        world: MolrooWorld,
        from: string,
        to: string,
    ) => Promise<void>;
    onTick?: (
        world: MolrooWorld,
        seconds: number,
        result: TickResult,
    ) => Promise<void>;
    (world: MolrooWorld): MolrooWorld & TPluginApi;
}

Properties

onChat?: (world: MolrooWorld, result: ChatResult) => Promise<void>

onEvent?: (world: MolrooWorld, result: EventResult) => Promise<void>

onPhaseChange?: (world: MolrooWorld, from: string, to: string) => Promise<void>

onTick?: (
    world: MolrooWorld,
    seconds: number,
    result: TickResult,
) => Promise<void>