SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Variable BotServiceConst

    BotService: GenService<
        {
            clickContainerButton: {
                input: typeof BotContainerButtonClickRequestSchema;
                methodKind: "unary";
                output: typeof BotContainerButtonClickResponseSchema;
            };
            clickDialogButton: {
                input: typeof BotClickDialogButtonRequestSchema;
                methodKind: "unary";
                output: typeof BotClickDialogButtonResponseSchema;
            };
            clickInventorySlot: {
                input: typeof BotInventoryClickRequestSchema;
                methodKind: "unary";
                output: typeof BotInventoryClickResponseSchema;
            };
            closeContainer: {
                input: typeof BotCloseContainerRequestSchema;
                methodKind: "unary";
                output: typeof BotCloseContainerResponseSchema;
            };
            closeDialog: {
                input: typeof BotCloseDialogRequestSchema;
                methodKind: "unary";
                output: typeof BotCloseDialogResponseSchema;
            };
            getBotInfo: {
                input: typeof BotInfoRequestSchema;
                methodKind: "unary";
                output: typeof BotInfoResponseSchema;
            };
            getBotList: {
                input: typeof BotListRequestSchema;
                methodKind: "unary";
                output: typeof BotListResponseSchema;
            };
            getBotWorldMap: {
                input: typeof BotWorldMapRequestSchema;
                methodKind: "unary";
                output: typeof BotWorldMapResponseSchema;
            };
            getDialog: {
                input: typeof BotGetDialogRequestSchema;
                methodKind: "unary";
                output: typeof BotGetDialogResponseSchema;
            };
            getInventoryState: {
                input: typeof BotInventoryStateRequestSchema;
                methodKind: "unary";
                output: typeof BotInventoryStateResponseSchema;
            };
            mouseClick: {
                input: typeof BotMouseClickRequestSchema;
                methodKind: "unary";
                output: typeof BotMouseClickResponseSchema;
            };
            openInventory: {
                input: typeof BotOpenInventoryRequestSchema;
                methodKind: "unary";
                output: typeof BotOpenInventoryResponseSchema;
            };
            renderBotPov: {
                input: typeof BotRenderPovRequestSchema;
                methodKind: "unary";
                output: typeof BotRenderPovResponseSchema;
            };
            resetMovement: {
                input: typeof BotResetMovementRequestSchema;
                methodKind: "unary";
                output: typeof BotResetMovementResponseSchema;
            };
            restartBots: {
                input: typeof RestartBotsRequestSchema;
                methodKind: "unary";
                output: typeof RestartBotsResponseSchema;
            };
            setBotsDesiredState: {
                input: typeof SetBotsDesiredStateRequestSchema;
                methodKind: "unary";
                output: typeof SetBotsDesiredStateResponseSchema;
            };
            setContainerText: {
                input: typeof BotSetContainerTextRequestSchema;
                methodKind: "unary";
                output: typeof BotSetContainerTextResponseSchema;
            };
            setHotbarSlot: {
                input: typeof BotSetHotbarSlotRequestSchema;
                methodKind: "unary";
                output: typeof BotSetHotbarSlotResponseSchema;
            };
            setMovementState: {
                input: typeof BotSetMovementStateRequestSchema;
                methodKind: "unary";
                output: typeof BotSetMovementStateResponseSchema;
            };
            setRotation: {
                input: typeof BotSetRotationRequestSchema;
                methodKind: "unary";
                output: typeof BotSetRotationResponseSchema;
            };
            submitDialog: {
                input: typeof BotSubmitDialogRequestSchema;
                methodKind: "unary";
                output: typeof BotSubmitDialogResponseSchema;
            };
            updateBotConfigEntry: {
                input: typeof BotUpdateConfigEntryRequestSchema;
                methodKind: "unary";
                output: typeof BotUpdateConfigEntryResponseSchema;
            };
            watchBotPov: {
                input: typeof BotWatchPovRequestSchema;
                methodKind: "server_streaming";
                output: typeof BotPovFrameSchema;
            };
            watchBotStatuses: {
                input: typeof WatchBotStatusesRequestSchema;
                methodKind: "server_streaming";
                output: typeof WatchBotStatusesResponseSchema;
            };
        },
    > = ...

    Service for managing and controlling Minecraft bots. Provides comprehensive APIs for bot monitoring, movement control, inventory management, and interaction with server dialogs.

    Permissions:

    • READ_BOT_INFO: Required for GetBotList, GetBotInfo, GetInventoryState, RenderBotPov, GetDialog
    • CONTROL_BOTS: Required to start, stop, or restart bots
    • UPDATE_BOT_CONFIG: Required for persistent per-bot setting changes
    • CONTROL_BOT_ACTIONS: Required for live movement, inventory, and dialog actions

    Error Handling:

    • NOT_FOUND: Instance or bot does not exist
    • FAILED_PRECONDITION: Bot is not online or required game state is unavailable
    • INTERNAL: Unexpected server errors (check server logs for details)

    from service soulfire.v1.BotService