SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias CommandCompletionRequest

    CommandCompletionRequest: Message<"soulfire.v1.CommandCompletionRequest"> & {
        command: string;
        cursor: number;
        scope?: CommandScope;
    }

    Request message for getting tab-completion suggestions for a partial command.

    Type Declaration

    • command: string

      The partial command string to complete. May be an incomplete command that the user is typing, e.g., "mov" or "move 100 ".

      from field: string command = 3;

    • cursor: number

      The cursor position within the command string (0-indexed). Completions will be generated for the token at this position. Typically this is the length of the command string for end-of-line completion.

      from field: int32 cursor = 4;

    • Optionalscope?: CommandScope

      The execution scope that determines which instances/bots are visible for completion suggestions. Must be set to one of the scope options.

      from field: soulfire.v1.CommandScope scope = 5;

    from message soulfire.v1.CommandCompletionRequest