mwg API
    Preparing search index...

    Interface Emit

    What a hook may ask the engine to do. This is the whole command surface.

    interface Emit {
        attack(attacker: string, defender: string, weapon?: string): void;
        endTurn(): void;
        gold(side: string, delta: number): void;
        kill(unit: string): void;
        lose(side: string): void;
        message(speaker: string, text: string): void;
        move(unit: string, x: number, y: number): void;
        setVariable(name: string, value: MwlValue): void;
        spawn(type: string, side: string, x: number, y: number): void;
        win(side: string): void;
    }
    Index
    attack endTurn gold kill lose message move setVariable spawn win

    • Parameters

      • attacker: string
      • defender: string
      • Optionalweapon: string

      Returns void

    • Parameters

      • side: string
      • delta: number

      Returns void

    • Parameters

      • speaker: string
      • text: string

      Returns void

    • Parameters

      • unit: string
      • x: number
      • y: number

      Returns void

    • Writes one variable by path (party[0].name, stored_naga.hitpoints), the write HookWorld.variableAt reads back. Do not write world.variables directly.

      Parameters

      Returns void

    • Parameters

      • type: string
      • side: string
      • x: number
      • y: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods