phantasmal-world/src/quest_editor/scripting/vm/io.ts

import { AsmToken } from "../instructions";

/**
 * The virtual machine calls these methods when it requires input.
 */
export interface VirtualMachineInput {
    /**
     * End the current message and move to the next message.
     */
    advance_msg(): Promise<any>;
}

/**
 * The virtual machine calls these methods when it outputs something.
 */
export interface VirtualMachineOutput {
    window_msg(msg: string): void;
    message(msg: string): void;
    add_msg(msg: string): void;
    winend(): void;
    mesend(): void;
}

/**
 * Methods that are outside of the context of the game.
 */
export interface VirtualMachineMetaIO {
    /**
     * The virtual machine emits warning messages about suspicious execution
     * patterns that could possibly cause problems or have unintended effects.
     */
    warning(msg: string, srcloc?: AsmToken): void;
    error(msg: string, srcloc?: AsmToken): void;
}

/**
 * Handles input/output to/from the virtual machine.
 */
export interface VirtualMachineIO
    extends VirtualMachineInput,
        VirtualMachineOutput,
        VirtualMachineMetaIO {}