SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface GetOrCreateBotOptions

    Provisioning, authentication, and readiness options for a named bot.

    Unless start is false, the scope owns observation and any SDK-started bot.

    interface GetOrCreateBotOptions {
        auth?: "offline" | "microsoft";
        call?: CallOptions;
        onDeviceCode?: (code: DeviceCode) => Effect<void, SoulFireOperationError>;
        readyTimeoutMs?: number;
        start?: boolean;
        username?: string;
    }
    Index
    auth? call? onDeviceCode? readyTimeoutMs? start? username?
    auth?: "offline" | "microsoft"

    Account authentication, default offline. Microsoft provisioning can require device-code login.

    call?: CallOptions
    onDeviceCode?: (code: DeviceCode) => Effect<void, SoulFireOperationError>

    Effect callback for Microsoft sign-in codes. Without it, the SDK logs the URL and code.

    readyTimeoutMs?: number

    Positive, finite startup and player-snapshot deadline in milliseconds. Defaults to 30,000.

    start?: boolean

    Start and observe the bot by default. False returns an unconnected handle for configuration.

    username?: string

    Minecraft username for a new offline account. Existing conflicting account configuration fails.

    Settings
    Member Visibility

    On This Page
    Properties