screeps-api
    Preparing search index...

    Interface UserConsoleEvent

    WebSocket event for console output.

    When subscribed, the server sends one event per tick with console logs, return values of commands, etc.

    interface UserConsoleEvent {
        data: UserConsoleEventData;
        id?: string;
        path: "console";
        type: "user";
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    The event payload. Extensions of this interface should specify a more precise type.

    id?: string

    ID of the entity the event is reporting on. Undefined when type is server.

    Examples:

    • User ID for user events
    • Room name (shard0/W0N0, W0N0, etc) for room events
    path: "console"

    When non-empty, indicates that the event concerns a property or aspect of type.

    Examples:

    • /resources for user-type events indicates an update to resource counts
    type: "user"