soulfire.bot_connect.BotService

class soulfire.bot_connect.BotService[source]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
async set_bots_desired_state(request: soulfire.bot_pb2.SetBotsDesiredStateRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.SetBotsDesiredStateRequest, soulfire.bot_pb2.SetBotsDesiredStateResponse]) → soulfire.bot_pb2.SetBotsDesiredStateResponse[source]
async restart_bots(request: soulfire.bot_pb2.RestartBotsRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.RestartBotsRequest, soulfire.bot_pb2.RestartBotsResponse]) → soulfire.bot_pb2.RestartBotsResponse[source]
watch_bot_statuses(request: soulfire.bot_pb2.WatchBotStatusesRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.WatchBotStatusesRequest, soulfire.bot_pb2.WatchBotStatusesResponse]) → collections.abc.AsyncIterator[soulfire.bot_pb2.WatchBotStatusesResponse][source]
async get_bot_list(request: soulfire.bot_pb2.BotListRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotListRequest, soulfire.bot_pb2.BotListResponse]) → soulfire.bot_pb2.BotListResponse[source]
async get_bot_info(request: soulfire.bot_pb2.BotInfoRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotInfoRequest, soulfire.bot_pb2.BotInfoResponse]) → soulfire.bot_pb2.BotInfoResponse[source]
async update_bot_config_entry(request: soulfire.bot_pb2.BotUpdateConfigEntryRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotUpdateConfigEntryRequest, soulfire.bot_pb2.BotUpdateConfigEntryResponse]) → soulfire.bot_pb2.BotUpdateConfigEntryResponse[source]
async render_bot_pov(request: soulfire.bot_pb2.BotRenderPovRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotRenderPovRequest, soulfire.bot_pb2.BotRenderPovResponse]) → soulfire.bot_pb2.BotRenderPovResponse[source]
watch_bot_pov(request: soulfire.bot_pb2.BotWatchPovRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotWatchPovRequest, soulfire.bot_pb2.BotPovFrame]) → collections.abc.AsyncIterator[soulfire.bot_pb2.BotPovFrame][source]
async get_bot_world_map(request: soulfire.bot_pb2.BotWorldMapRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotWorldMapRequest, soulfire.bot_pb2.BotWorldMapResponse]) → soulfire.bot_pb2.BotWorldMapResponse[source]
async click_inventory_slot(request: soulfire.bot_pb2.BotInventoryClickRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotInventoryClickRequest, soulfire.bot_pb2.BotInventoryClickResponse]) → soulfire.bot_pb2.BotInventoryClickResponse[source]
async get_inventory_state(request: soulfire.bot_pb2.BotInventoryStateRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotInventoryStateRequest, soulfire.bot_pb2.BotInventoryStateResponse]) → soulfire.bot_pb2.BotInventoryStateResponse[source]
async close_container(request: soulfire.bot_pb2.BotCloseContainerRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotCloseContainerRequest, soulfire.bot_pb2.BotCloseContainerResponse]) → soulfire.bot_pb2.BotCloseContainerResponse[source]
async open_inventory(request: soulfire.bot_pb2.BotOpenInventoryRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotOpenInventoryRequest, soulfire.bot_pb2.BotOpenInventoryResponse]) → soulfire.bot_pb2.BotOpenInventoryResponse[source]
async mouse_click(request: soulfire.bot_pb2.BotMouseClickRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotMouseClickRequest, soulfire.bot_pb2.BotMouseClickResponse]) → soulfire.bot_pb2.BotMouseClickResponse[source]
async click_container_button(request: soulfire.bot_pb2.BotContainerButtonClickRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotContainerButtonClickRequest, soulfire.bot_pb2.BotContainerButtonClickResponse]) → soulfire.bot_pb2.BotContainerButtonClickResponse[source]
async set_container_text(request: soulfire.bot_pb2.BotSetContainerTextRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotSetContainerTextRequest, soulfire.bot_pb2.BotSetContainerTextResponse]) → soulfire.bot_pb2.BotSetContainerTextResponse[source]
async set_hotbar_slot(request: soulfire.bot_pb2.BotSetHotbarSlotRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotSetHotbarSlotRequest, soulfire.bot_pb2.BotSetHotbarSlotResponse]) → soulfire.bot_pb2.BotSetHotbarSlotResponse[source]
async set_movement_state(request: soulfire.bot_pb2.BotSetMovementStateRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotSetMovementStateRequest, soulfire.bot_pb2.BotSetMovementStateResponse]) → soulfire.bot_pb2.BotSetMovementStateResponse[source]
async reset_movement(request: soulfire.bot_pb2.BotResetMovementRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotResetMovementRequest, soulfire.bot_pb2.BotResetMovementResponse]) → soulfire.bot_pb2.BotResetMovementResponse[source]
async set_rotation(request: soulfire.bot_pb2.BotSetRotationRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotSetRotationRequest, soulfire.bot_pb2.BotSetRotationResponse]) → soulfire.bot_pb2.BotSetRotationResponse[source]
async get_dialog(request: soulfire.bot_pb2.BotGetDialogRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotGetDialogRequest, soulfire.bot_pb2.BotGetDialogResponse]) → soulfire.bot_pb2.BotGetDialogResponse[source]
async submit_dialog(request: soulfire.bot_pb2.BotSubmitDialogRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotSubmitDialogRequest, soulfire.bot_pb2.BotSubmitDialogResponse]) → soulfire.bot_pb2.BotSubmitDialogResponse[source]
async click_dialog_button(request: soulfire.bot_pb2.BotClickDialogButtonRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotClickDialogButtonRequest, soulfire.bot_pb2.BotClickDialogButtonResponse]) → soulfire.bot_pb2.BotClickDialogButtonResponse[source]
async close_dialog(request: soulfire.bot_pb2.BotCloseDialogRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_pb2.BotCloseDialogRequest, soulfire.bot_pb2.BotCloseDialogResponse]) → soulfire.bot_pb2.BotCloseDialogResponse[source]