Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
SoulFire Python SDK 2.10.3
SoulFire Python SDK 2.10.3

SDK concepts

  • Connection and bot lifecycle
  • Task execution and ownership

API reference

  • Client and setup
  • Instances
  • Bots
  • Task execution
  • Task handles
  • All modules, RPCs, and protocol types
    • soulfire
      • soulfire.actions
      • soulfire.admin
        • soulfire.admin.SoulFireAdmin
      • soulfire.api_docs_pb2
        • soulfire.api_docs_pb2.ApiMethodDocs
        • soulfire.api_docs_pb2.ApiFieldDocs
      • soulfire.behaviors
        • soulfire.behaviors.SoulFireBehaviorError
        • soulfire.behaviors.SoulFireBehaviorTimeoutError
        • soulfire.behaviors.BotBehavior
        • soulfire.behaviors.FunctionBehavior
        • soulfire.behaviors.CollectBlocks
        • soulfire.behaviors.FollowEntity
        • soulfire.behaviors.AttackNearest
        • soulfire.behaviors.AutoEat
        • soulfire.behaviors.AutoRespawn
        • soulfire.behaviors.AutoTotem
        • soulfire.behaviors.AutoArmor
        • soulfire.behaviors.BuildPlacement
        • soulfire.behaviors.Build
      • soulfire.bot
        • soulfire.bot.SoulFireBot
        • soulfire.bot.SoulFireBotControlLease
      • soulfire.bot_connect
        • soulfire.bot_connect.BotService
        • soulfire.bot_connect.BotServiceASGIApplication
        • soulfire.bot_connect.BotServiceClient
        • soulfire.bot_connect.BotServiceSync
        • soulfire.bot_connect.BotServiceWSGIApplication
        • soulfire.bot_connect.BotServiceClientSync
      • soulfire.bot_live_connect
        • soulfire.bot_live_connect.BotLiveService
        • soulfire.bot_live_connect.BotLiveServiceASGIApplication
        • soulfire.bot_live_connect.BotLiveServiceClient
        • soulfire.bot_live_connect.BotLiveServiceSync
        • soulfire.bot_live_connect.BotLiveServiceWSGIApplication
        • soulfire.bot_live_connect.BotLiveServiceClientSync
      • soulfire.bot_live_pb2
        • soulfire.bot_live_pb2.BlockFace
        • soulfire.bot_live_pb2.Hand
        • soulfire.bot_live_pb2.ChatSource
        • soulfire.bot_live_pb2.BotLifecycleKind
        • soulfire.bot_live_pb2.EntityEventKind
        • soulfire.bot_live_pb2.WeatherEventKind
        • soulfire.bot_live_pb2.PlayerListEventKind
        • soulfire.bot_live_pb2.BossBarEventKind
        • soulfire.bot_live_pb2.SoundEventKind
        • soulfire.bot_live_pb2.ScoreboardEventKind
        • soulfire.bot_live_pb2.ResourcePackEventKind
        • soulfire.bot_live_pb2.TitleEventKind
        • soulfire.bot_live_pb2.ChunkEventKind
        • soulfire.bot_live_pb2.BotActionStatus
        • soulfire.bot_live_pb2.ResourcePackResponse
        • soulfire.bot_live_pb2.PathfindSearchMode
        • soulfire.bot_live_pb2.PathfindStatus
        • soulfire.bot_live_pb2.BlockState
          • soulfire.bot_live_pb2.BlockState.PropertiesEntry
        • soulfire.bot_live_pb2.NearbyEntity
        • soulfire.bot_live_pb2.BotEventFilter
        • soulfire.bot_live_pb2.WatchBotEventsRequest
        • soulfire.bot_live_pb2.BotStateDelta
        • soulfire.bot_live_pb2.BotChatEvent
        • soulfire.bot_live_pb2.BotLifecycleEvent
        • soulfire.bot_live_pb2.BotEntityEvent
        • soulfire.bot_live_pb2.BotBlockUpdateEvent
        • soulfire.bot_live_pb2.BotInventoryEvent
        • soulfire.bot_live_pb2.BotDamageEvent
        • soulfire.bot_live_pb2.ClockSnapshot
        • soulfire.bot_live_pb2.BotTimeEvent
        • soulfire.bot_live_pb2.BotWeatherEvent
        • soulfire.bot_live_pb2.BotGameEvent
        • soulfire.bot_live_pb2.BotEnvironmentEvent
        • soulfire.bot_live_pb2.PlayerListEntrySnapshot
        • soulfire.bot_live_pb2.BotPlayerListEvent
        • soulfire.bot_live_pb2.BotBossBarEvent
        • soulfire.bot_live_pb2.BotSoundEvent
        • soulfire.bot_live_pb2.BotParticleEvent
        • soulfire.bot_live_pb2.BotScoreboardEvent
        • soulfire.bot_live_pb2.BotResourcePackEvent
        • soulfire.bot_live_pb2.BotTitleEvent
        • soulfire.bot_live_pb2.BotChunkEvent
        • soulfire.bot_live_pb2.BotEventEnvelope
        • soulfire.bot_live_pb2.BotResyncRequired
        • soulfire.bot_live_pb2.BotHeartbeat
        • soulfire.bot_live_pb2.BotEvent
        • soulfire.bot_live_pb2.BotActionResult
        • soulfire.bot_live_pb2.SendChatRequest
        • soulfire.bot_live_pb2.SendChatResponse
        • soulfire.bot_live_pb2.GetBlockRequest
        • soulfire.bot_live_pb2.GetBlockResponse
        • soulfire.bot_live_pb2.FindBlocksRequest
        • soulfire.bot_live_pb2.FindBlocksResponse
        • soulfire.bot_live_pb2.ListNearbyEntitiesRequest
        • soulfire.bot_live_pb2.ListNearbyEntitiesResponse
        • soulfire.bot_live_pb2.DigBlockRequest
        • soulfire.bot_live_pb2.DigBlockResponse
        • soulfire.bot_live_pb2.PlaceBlockRequest
        • soulfire.bot_live_pb2.PlaceBlockResponse
        • soulfire.bot_live_pb2.InteractBlockRequest
        • soulfire.bot_live_pb2.InteractBlockResponse
        • soulfire.bot_live_pb2.UseItemRequest
        • soulfire.bot_live_pb2.UseItemResponse
        • soulfire.bot_live_pb2.ReleaseItemRequest
        • soulfire.bot_live_pb2.ReleaseItemResponse
        • soulfire.bot_live_pb2.AttackEntityRequest
        • soulfire.bot_live_pb2.AttackEntityResponse
        • soulfire.bot_live_pb2.InteractEntityRequest
        • soulfire.bot_live_pb2.InteractEntityResponse
        • soulfire.bot_live_pb2.SwingArmRequest
        • soulfire.bot_live_pb2.SwingArmResponse
        • soulfire.bot_live_pb2.RespawnRequest
        • soulfire.bot_live_pb2.RespawnResponse
        • soulfire.bot_live_pb2.SleepRequest
        • soulfire.bot_live_pb2.SleepResponse
        • soulfire.bot_live_pb2.WakeRequest
        • soulfire.bot_live_pb2.WakeResponse
        • soulfire.bot_live_pb2.MountEntityRequest
        • soulfire.bot_live_pb2.MountEntityResponse
        • soulfire.bot_live_pb2.DismountRequest
        • soulfire.bot_live_pb2.DismountResponse
        • soulfire.bot_live_pb2.SetVehicleControlRequest
        • soulfire.bot_live_pb2.SetVehicleControlResponse
        • soulfire.bot_live_pb2.UpdateSignRequest
        • soulfire.bot_live_pb2.UpdateSignResponse
        • soulfire.bot_live_pb2.WriteBookRequest
        • soulfire.bot_live_pb2.WriteBookResponse
        • soulfire.bot_live_pb2.RespondResourcePackRequest
        • soulfire.bot_live_pb2.RespondResourcePackResponse
        • soulfire.bot_live_pb2.SetFlyingRequest
        • soulfire.bot_live_pb2.SetFlyingResponse
        • soulfire.bot_live_pb2.StartElytraFlightRequest
        • soulfire.bot_live_pb2.StartElytraFlightResponse
        • soulfire.bot_live_pb2.CreativeItemStack
        • soulfire.bot_live_pb2.SetCreativeSlotRequest
        • soulfire.bot_live_pb2.SetCreativeSlotResponse
        • soulfire.bot_live_pb2.WaitForChunksRequest
        • soulfire.bot_live_pb2.WaitForChunksResponse
        • soulfire.bot_live_pb2.PathfindGoal
          • soulfire.bot_live_pb2.PathfindGoal.BlockGoal
          • soulfire.bot_live_pb2.PathfindGoal.NearGoal
          • soulfire.bot_live_pb2.PathfindGoal.EntityGoal
          • soulfire.bot_live_pb2.PathfindGoal.XZGoal
          • soulfire.bot_live_pb2.PathfindGoal.YGoal
          • soulfire.bot_live_pb2.PathfindGoal.BreakBlockGoal
          • soulfire.bot_live_pb2.PathfindGoal.PlaceBlockGoal
          • soulfire.bot_live_pb2.PathfindGoal.AwayFromPositionGoal
          • soulfire.bot_live_pb2.PathfindGoal.AwayFromEntityGoal
          • soulfire.bot_live_pb2.PathfindGoal.AnyGoal
        • soulfire.bot_live_pb2.PathfindOptions
        • soulfire.bot_live_pb2.GoToRequest
        • soulfire.bot_live_pb2.PathfindProgress
        • soulfire.bot_live_pb2.StopPathfindingRequest
        • soulfire.bot_live_pb2.StopPathfindingResponse
        • soulfire.bot_live_pb2.AcquireBotControlRequest
        • soulfire.bot_live_pb2.BotControlLease
        • soulfire.bot_live_pb2.AcquireBotControlResponse
        • soulfire.bot_live_pb2.RenewBotControlRequest
        • soulfire.bot_live_pb2.RenewBotControlResponse
        • soulfire.bot_live_pb2.ReleaseBotControlRequest
        • soulfire.bot_live_pb2.ReleaseBotControlResponse
      • soulfire.bot_pb2
        • soulfire.bot_pb2.BotDesiredState
        • soulfire.bot_pb2.BotRuntimeState
        • soulfire.bot_pb2.BotConnectionPhase
        • soulfire.bot_pb2.GameMode
        • soulfire.bot_pb2.ClickType
        • soulfire.bot_pb2.SlotRegionType
        • soulfire.bot_pb2.MouseButton
        • soulfire.bot_pb2.DialogType
        • soulfire.bot_pb2.DialogAfterAction
        • soulfire.bot_pb2.BotInfoRequest
        • soulfire.bot_pb2.BotListRequest
        • soulfire.bot_pb2.BotStatus
        • soulfire.bot_pb2.BotFleetSummary
        • soulfire.bot_pb2.SetBotsDesiredStateRequest
        • soulfire.bot_pb2.SetBotsDesiredStateResponse
        • soulfire.bot_pb2.RestartBotsRequest
        • soulfire.bot_pb2.RestartBotsResponse
        • soulfire.bot_pb2.WatchBotStatusesRequest
        • soulfire.bot_pb2.BotStatusSnapshot
        • soulfire.bot_pb2.WatchBotStatusesResponse
        • soulfire.bot_pb2.BotListEntry
        • soulfire.bot_pb2.BotListResponse
        • soulfire.bot_pb2.InventorySlot
        • soulfire.bot_pb2.BotLiveState
        • soulfire.bot_pb2.BotProxyInfo
        • soulfire.bot_pb2.BotConnectionInfo
        • soulfire.bot_pb2.BotInfoResponse
        • soulfire.bot_pb2.BotUpdateConfigEntryRequest
        • soulfire.bot_pb2.BotUpdateConfigEntryResponse
        • soulfire.bot_pb2.BotRenderPovRequest
        • soulfire.bot_pb2.BotRenderPovResponse
        • soulfire.bot_pb2.BotRenderPovMetadata
        • soulfire.bot_pb2.BotRenderPovDebugTrace
        • soulfire.bot_pb2.BotRenderPovTextSubmission
        • soulfire.bot_pb2.BotWatchPovRequest
        • soulfire.bot_pb2.BotPovFrame
        • soulfire.bot_pb2.BotWorldMapRequest
        • soulfire.bot_pb2.BotWorldMapColumn
        • soulfire.bot_pb2.BotWorldMapEntity
        • soulfire.bot_pb2.BotWorldMapResponse
        • soulfire.bot_pb2.BotInventoryClickRequest
        • soulfire.bot_pb2.BotInventoryClickResponse
        • soulfire.bot_pb2.BotInventoryStateRequest
        • soulfire.bot_pb2.SlotRegion
        • soulfire.bot_pb2.ContainerButton
        • soulfire.bot_pb2.ContainerTextInput
        • soulfire.bot_pb2.BookPage
        • soulfire.bot_pb2.ContainerLayout
        • soulfire.bot_pb2.BotInventoryStateResponse
        • soulfire.bot_pb2.BotCloseContainerRequest
        • soulfire.bot_pb2.BotCloseContainerResponse
        • soulfire.bot_pb2.BotOpenInventoryRequest
        • soulfire.bot_pb2.BotOpenInventoryResponse
        • soulfire.bot_pb2.BotMouseClickRequest
        • soulfire.bot_pb2.BotMouseClickResponse
        • soulfire.bot_pb2.BotContainerButtonClickRequest
        • soulfire.bot_pb2.BotContainerButtonClickResponse
        • soulfire.bot_pb2.BotSetContainerTextRequest
        • soulfire.bot_pb2.BotSetContainerTextResponse
        • soulfire.bot_pb2.BotSetHotbarSlotRequest
        • soulfire.bot_pb2.BotSetHotbarSlotResponse
        • soulfire.bot_pb2.BotSetMovementStateRequest
        • soulfire.bot_pb2.BotSetMovementStateResponse
        • soulfire.bot_pb2.BotResetMovementRequest
        • soulfire.bot_pb2.BotResetMovementResponse
        • soulfire.bot_pb2.BotSetRotationRequest
        • soulfire.bot_pb2.BotSetRotationResponse
        • soulfire.bot_pb2.DialogBodyElement
        • soulfire.bot_pb2.DialogPlainMessage
        • soulfire.bot_pb2.DialogItem
        • soulfire.bot_pb2.DialogInput
        • soulfire.bot_pb2.DialogTextInput
        • soulfire.bot_pb2.DialogBooleanInput
        • soulfire.bot_pb2.DialogSingleOptionInput
        • soulfire.bot_pb2.DialogOption
        • soulfire.bot_pb2.DialogNumberRangeInput
        • soulfire.bot_pb2.DialogAction
        • soulfire.bot_pb2.DialogOpenUrlAction
        • soulfire.bot_pb2.DialogRunCommandAction
        • soulfire.bot_pb2.DialogSuggestCommandAction
        • soulfire.bot_pb2.DialogCopyToClipboardAction
        • soulfire.bot_pb2.DialogShowDialogAction
        • soulfire.bot_pb2.DialogCustomAction
        • soulfire.bot_pb2.DialogDynamicRunCommandAction
        • soulfire.bot_pb2.DialogDynamicCustomAction
        • soulfire.bot_pb2.DialogButton
        • soulfire.bot_pb2.ServerDialog
        • soulfire.bot_pb2.BotGetDialogRequest
        • soulfire.bot_pb2.BotGetDialogResponse
        • soulfire.bot_pb2.BotSubmitDialogRequest
          • soulfire.bot_pb2.BotSubmitDialogRequest.InputValuesEntry
        • soulfire.bot_pb2.BotSubmitDialogResponse
        • soulfire.bot_pb2.BotClickDialogButtonRequest
        • soulfire.bot_pb2.BotClickDialogButtonResponse
        • soulfire.bot_pb2.BotCloseDialogRequest
        • soulfire.bot_pb2.BotCloseDialogResponse
      • soulfire.camera
        • soulfire.camera.CameraRenderOptions
        • soulfire.camera.WorldMapOptions
        • soulfire.camera.SoulFireCamera
      • soulfire.chat_connect
        • soulfire.chat_connect.ChatService
        • soulfire.chat_connect.ChatServiceASGIApplication
        • soulfire.chat_connect.ChatServiceClient
        • soulfire.chat_connect.ChatServiceSync
        • soulfire.chat_connect.ChatServiceWSGIApplication
        • soulfire.chat_connect.ChatServiceClientSync
      • soulfire.chat_pb2
        • soulfire.chat_pb2.ChatScope
        • soulfire.chat_pb2.SendPublicChatRequest
        • soulfire.chat_pb2.SendCommandRequest
        • soulfire.chat_pb2.SendWhisperRequest
        • soulfire.chat_pb2.ChatActionResponse
        • soulfire.chat_pb2.TabCompleteRequest
        • soulfire.chat_pb2.TabSuggestion
        • soulfire.chat_pb2.TabCompleteResponse
      • soulfire.client
        • soulfire.client.ManagedInstallOptions
        • soulfire.client.SoulFire
        • soulfire.client.SoulFireInstance
        • soulfire.client.SoulFireService
      • soulfire.client_connect
        • soulfire.client_connect.ClientService
        • soulfire.client_connect.ClientServiceASGIApplication
        • soulfire.client_connect.ClientServiceClient
        • soulfire.client_connect.ClientServiceSync
        • soulfire.client_connect.ClientServiceWSGIApplication
        • soulfire.client_connect.ClientServiceClientSync
      • soulfire.client_pb2
        • soulfire.client_pb2.ClientDataRequest
        • soulfire.client_pb2.GlobalPermissionState
        • soulfire.client_pb2.ServerInfo
        • soulfire.client_pb2.ClientDataResponse
        • soulfire.client_pb2.GenerateWebDAVTokenRequest
        • soulfire.client_pb2.GenerateWebDAVTokenResponse
        • soulfire.client_pb2.GenerateAPITokenRequest
        • soulfire.client_pb2.GenerateAPITokenResponse
        • soulfire.client_pb2.UpdateSelfUsernameRequest
        • soulfire.client_pb2.UpdateSelfUsernameResponse
        • soulfire.client_pb2.UpdateSelfEmailRequest
        • soulfire.client_pb2.UpdateSelfEmailResponse
        • soulfire.client_pb2.InvalidateSelfSessionsRequest
        • soulfire.client_pb2.InvalidateSelfSessionsResponse
      • soulfire.command_connect
        • soulfire.command_connect.CommandService
        • soulfire.command_connect.CommandServiceASGIApplication
        • soulfire.command_connect.CommandServiceClient
        • soulfire.command_connect.CommandServiceSync
        • soulfire.command_connect.CommandServiceWSGIApplication
        • soulfire.command_connect.CommandServiceClientSync
      • soulfire.command_pb2
        • soulfire.command_pb2.GlobalCommandScope
        • soulfire.command_pb2.InstanceCommandScope
        • soulfire.command_pb2.BotCommandScope
        • soulfire.command_pb2.CommandScope
        • soulfire.command_pb2.CommandRequest
        • soulfire.command_pb2.CommandResponse
        • soulfire.command_pb2.CommandCompletionRequest
        • soulfire.command_pb2.CommandCompletion
        • soulfire.command_pb2.CommandCompletionResponse
      • soulfire.common_pb2
        • soulfire.common_pb2.AccountTypeCredentials
        • soulfire.common_pb2.AccountTypeDeviceCode
        • soulfire.common_pb2.GlobalPermission
        • soulfire.common_pb2.InstancePermission
        • soulfire.common_pb2.UserRole
        • soulfire.common_pb2.SettingsPageEntryScopeType
        • soulfire.common_pb2.BlockPosition
        • soulfire.common_pb2.WorldPosition
        • soulfire.common_pb2.ProxyProto
          • soulfire.common_pb2.ProxyProto.Type
        • soulfire.common_pb2.MinecraftAccountProto
          • soulfire.common_pb2.MinecraftAccountProto.AccountTypeProto
          • soulfire.common_pb2.MinecraftAccountProto.OnlineChainJavaData
          • soulfire.common_pb2.MinecraftAccountProto.OfflineJavaData
          • soulfire.common_pb2.MinecraftAccountProto.OnlineSimpleJavaData
          • soulfire.common_pb2.MinecraftAccountProto.TheAlteningJavaData
          • soulfire.common_pb2.MinecraftAccountProto.BedrockData
        • soulfire.common_pb2.SettingsNamespace
          • soulfire.common_pb2.SettingsNamespace.SettingsEntry
        • soulfire.common_pb2.SettingsEntryIdentifier
        • soulfire.common_pb2.StringSetting
          • soulfire.common_pb2.StringSetting.InputType
        • soulfire.common_pb2.IntSetting
        • soulfire.common_pb2.DoubleSetting
        • soulfire.common_pb2.BoolSetting
        • soulfire.common_pb2.ComboSetting
          • soulfire.common_pb2.ComboSetting.Option
        • soulfire.common_pb2.StringListSetting
        • soulfire.common_pb2.MinMaxSetting
          • soulfire.common_pb2.MinMaxSetting.Entry
        • soulfire.common_pb2.SettingsDefinition
        • soulfire.common_pb2.SettingsPage
        • soulfire.common_pb2.ServerPlugin
      • soulfire.concurrency
      • soulfire.connection
        • soulfire.connection.RequiredPlugin
        • soulfire.connection.ServerMetadata
        • soulfire.connection.CapabilitySet
        • soulfire.connection.ConnectionMetadata
      • soulfire.domain_pb2
        • soulfire.domain_pb2.EntityCategory
        • soulfire.domain_pb2.Vec3
        • soulfire.domain_pb2.Rotation
        • soulfire.domain_pb2.BoundingBox
        • soulfire.domain_pb2.TextComponent
        • soulfire.domain_pb2.EnchantmentSnapshot
        • soulfire.domain_pb2.EffectSnapshot
        • soulfire.domain_pb2.AttributeModifierSnapshot
        • soulfire.domain_pb2.AttributeSnapshot
        • soulfire.domain_pb2.FoodProperties
        • soulfire.domain_pb2.ToolProperties
        • soulfire.domain_pb2.ArmorProperties
        • soulfire.domain_pb2.PotionProperties
        • soulfire.domain_pb2.ItemStackSnapshot
        • soulfire.domain_pb2.EntityReference
        • soulfire.domain_pb2.EntitySnapshot
          • soulfire.domain_pb2.EntitySnapshot.EquipmentEntry
        • soulfire.domain_pb2.FluidSnapshot
        • soulfire.domain_pb2.VoxelShape
        • soulfire.domain_pb2.BlockSnapshot
          • soulfire.domain_pb2.BlockSnapshot.PropertiesEntry
        • soulfire.domain_pb2.PlayerAbilitiesSnapshot
        • soulfire.domain_pb2.ExperienceSnapshot
        • soulfire.domain_pb2.PlayerSnapshot
          • soulfire.domain_pb2.PlayerSnapshot.EquipmentEntry
      • soulfire.download_connect
        • soulfire.download_connect.DownloadService
        • soulfire.download_connect.DownloadServiceASGIApplication
        • soulfire.download_connect.DownloadServiceClient
        • soulfire.download_connect.DownloadServiceSync
        • soulfire.download_connect.DownloadServiceWSGIApplication
        • soulfire.download_connect.DownloadServiceClientSync
      • soulfire.download_pb2
        • soulfire.download_pb2.HeaderPair
        • soulfire.download_pb2.DownloadRequest
        • soulfire.download_pb2.DownloadResponse
      • soulfire.errors
        • soulfire.errors.SoulFireRpcError
        • soulfire.errors.SoulFireActionError
        • soulfire.errors.SoulFireCompatibilityError
        • soulfire.errors.SoulFireCapabilityError
        • soulfire.errors.SoulFireTaskError
        • soulfire.errors.SoulFirePluginNotFoundError
        • soulfire.errors.SoulFirePluginCompatibilityError
        • soulfire.errors.SoulFirePluginDescriptorError
        • soulfire.errors.SoulFireContainerClosedError
        • soulfire.errors.SoulFireValidationError
        • soulfire.errors.SoulFireStateError
        • soulfire.errors.SoulFireInstallError
        • soulfire.errors.SoulFireTimeoutError
        • soulfire.errors.RpcFailureContext
        • soulfire.errors.RpcErrorInterceptor
        • soulfire.errors.RpcErrorInterceptorSync
      • soulfire.example_plugin
        • soulfire.example_plugin.ExamplePluginClient
      • soulfire.fleet
        • soulfire.fleet.FleetTaskGroupError
        • soulfire.fleet.FleetPoint
        • soulfire.fleet.FleetRadius
        • soulfire.fleet.FleetMetadataSelector
        • soulfire.fleet.FleetBot
        • soulfire.fleet.FleetSelector
        • soulfire.fleet.FleetAssignment
        • soulfire.fleet.FleetTaskStartFailure
        • soulfire.fleet.FleetTaskMember
        • soulfire.fleet.FleetTaskStreamEvent
        • soulfire.fleet.FleetTaskOutcome
        • soulfire.fleet.FleetTaskReport
        • soulfire.fleet.FleetOperationOutcome
        • soulfire.fleet.FleetOperationReport
        • soulfire.fleet.FleetTaskStartOptions
        • soulfire.fleet.SoulFireFleetTaskGroup
        • soulfire.fleet.SoulFireFleet
      • soulfire.instance_connect
        • soulfire.instance_connect.InstanceService
        • soulfire.instance_connect.InstanceServiceASGIApplication
        • soulfire.instance_connect.InstanceServiceClient
        • soulfire.instance_connect.InstanceServiceSync
        • soulfire.instance_connect.InstanceServiceWSGIApplication
        • soulfire.instance_connect.InstanceServiceClientSync
      • soulfire.instance_live_connect
        • soulfire.instance_live_connect.InstanceLiveService
        • soulfire.instance_live_connect.InstanceLiveServiceASGIApplication
        • soulfire.instance_live_connect.InstanceLiveServiceClient
        • soulfire.instance_live_connect.InstanceLiveServiceSync
        • soulfire.instance_live_connect.InstanceLiveServiceWSGIApplication
        • soulfire.instance_live_connect.InstanceLiveServiceClientSync
      • soulfire.instance_live_pb2
        • soulfire.instance_live_pb2.InstanceEventFilter
        • soulfire.instance_live_pb2.WatchInstanceEventsRequest
        • soulfire.instance_live_pb2.InstanceEvent
      • soulfire.instance_pb2
        • soulfire.instance_pb2.BotAuthentication
        • soulfire.instance_pb2.InstanceUser
        • soulfire.instance_pb2.InstanceConfig
        • soulfire.instance_pb2.InstanceCreateRequest
        • soulfire.instance_pb2.InstanceCreateResponse
        • soulfire.instance_pb2.InstanceGetOrCreateRequest
        • soulfire.instance_pb2.InstanceGetOrCreateResponse
        • soulfire.instance_pb2.InstanceGetOrCreateBotRequest
        • soulfire.instance_pb2.InstanceGetOrCreateBotResponse
        • soulfire.instance_pb2.InstanceDeleteRequest
        • soulfire.instance_pb2.InstanceDeleteResponse
        • soulfire.instance_pb2.InstanceListRequest
        • soulfire.instance_pb2.InstanceListResponse
          • soulfire.instance_pb2.InstanceListResponse.Instance
        • soulfire.instance_pb2.InstancePermissionState
        • soulfire.instance_pb2.InstanceInfoRequest
        • soulfire.instance_pb2.InstanceInfo
        • soulfire.instance_pb2.InstanceNotModified
        • soulfire.instance_pb2.InstanceInfoResponse
        • soulfire.instance_pb2.InstanceUpdateMetaRequest
        • soulfire.instance_pb2.InstanceUpdateMetaResponse
        • soulfire.instance_pb2.InstanceUpdateConfigRequest
        • soulfire.instance_pb2.InstanceUpdateConfigResponse
        • soulfire.instance_pb2.InstanceUpdateConfigEntryRequest
        • soulfire.instance_pb2.InstanceUpdateConfigEntryResponse
        • soulfire.instance_pb2.InstanceAddAccountRequest
        • soulfire.instance_pb2.InstanceAddAccountResponse
        • soulfire.instance_pb2.InstanceRemoveAccountRequest
        • soulfire.instance_pb2.InstanceRemoveAccountResponse
        • soulfire.instance_pb2.InstanceUpdateAccountRequest
        • soulfire.instance_pb2.InstanceUpdateAccountResponse
        • soulfire.instance_pb2.InstanceAddAccountsBatchRequest
        • soulfire.instance_pb2.InstanceAddAccountsBatchResponse
        • soulfire.instance_pb2.InstanceRemoveAccountsBatchRequest
        • soulfire.instance_pb2.InstanceRemoveAccountsBatchResponse
        • soulfire.instance_pb2.InstanceAddProxyRequest
        • soulfire.instance_pb2.InstanceAddProxyResponse
        • soulfire.instance_pb2.InstanceRemoveProxyRequest
        • soulfire.instance_pb2.InstanceRemoveProxyResponse
        • soulfire.instance_pb2.InstanceUpdateProxyRequest
        • soulfire.instance_pb2.InstanceUpdateProxyResponse
        • soulfire.instance_pb2.InstanceAddProxiesBatchRequest
        • soulfire.instance_pb2.InstanceAddProxiesBatchResponse
        • soulfire.instance_pb2.InstanceRemoveProxiesBatchRequest
        • soulfire.instance_pb2.InstanceRemoveProxiesBatchResponse
        • soulfire.instance_pb2.InstanceAuditLogRequest
        • soulfire.instance_pb2.GetAccountMetadataRequest
        • soulfire.instance_pb2.GetAccountMetadataResponse
        • soulfire.instance_pb2.SetAccountMetadataEntryRequest
        • soulfire.instance_pb2.SetAccountMetadataEntryResponse
        • soulfire.instance_pb2.DeleteAccountMetadataEntryRequest
        • soulfire.instance_pb2.DeleteAccountMetadataEntryResponse
        • soulfire.instance_pb2.GetInstanceMetadataRequest
        • soulfire.instance_pb2.GetInstanceMetadataResponse
        • soulfire.instance_pb2.SetInstanceMetadataEntryRequest
        • soulfire.instance_pb2.SetInstanceMetadataEntryResponse
        • soulfire.instance_pb2.DeleteInstanceMetadataEntryRequest
        • soulfire.instance_pb2.DeleteInstanceMetadataEntryResponse
        • soulfire.instance_pb2.InstanceAuditLogResponse
          • soulfire.instance_pb2.InstanceAuditLogResponse.AuditLogEntryType
          • soulfire.instance_pb2.InstanceAuditLogResponse.AuditLogEntry
      • soulfire.inventory_connect
        • soulfire.inventory_connect.InventoryService
        • soulfire.inventory_connect.InventoryServiceASGIApplication
        • soulfire.inventory_connect.InventoryServiceClient
        • soulfire.inventory_connect.InventoryServiceSync
        • soulfire.inventory_connect.InventoryServiceWSGIApplication
        • soulfire.inventory_connect.InventoryServiceClientSync
      • soulfire.inventory_pb2
        • soulfire.inventory_pb2.InventoryArea
        • soulfire.inventory_pb2.InventoryRecommendationKind
        • soulfire.inventory_pb2.ItemSelector
        • soulfire.inventory_pb2.InventorySlotSnapshot
        • soulfire.inventory_pb2.ContainerSnapshot
        • soulfire.inventory_pb2.InventoryScope
        • soulfire.inventory_pb2.GetContainerSnapshotRequest
        • soulfire.inventory_pb2.GetContainerSnapshotResponse
        • soulfire.inventory_pb2.CountItemsRequest
        • soulfire.inventory_pb2.CountItemsResponse
        • soulfire.inventory_pb2.FindInventorySlotsRequest
        • soulfire.inventory_pb2.FindInventorySlotsResponse
        • soulfire.inventory_pb2.InventoryItemScoreFactor
        • soulfire.inventory_pb2.InventoryItemRecommendation
        • soulfire.inventory_pb2.RankInventoryItemsRequest
        • soulfire.inventory_pb2.RankInventoryItemsResponse
        • soulfire.inventory_pb2.MoveInventoryItemRequest
        • soulfire.inventory_pb2.TransferItemsRequest
        • soulfire.inventory_pb2.TossItemsRequest
        • soulfire.inventory_pb2.SelectHotbarItemRequest
        • soulfire.inventory_pb2.EquipItemRequest
        • soulfire.inventory_pb2.UnequipItemRequest
        • soulfire.inventory_pb2.InventoryMutationResponse
        • soulfire.inventory_pb2.OpenBlockContainerRequest
        • soulfire.inventory_pb2.CloseSemanticContainerRequest
      • soulfire.login_connect
        • soulfire.login_connect.LoginService
        • soulfire.login_connect.LoginServiceASGIApplication
        • soulfire.login_connect.LoginServiceClient
        • soulfire.login_connect.LoginServiceSync
        • soulfire.login_connect.LoginServiceWSGIApplication
        • soulfire.login_connect.LoginServiceClientSync
      • soulfire.login_pb2
        • soulfire.login_pb2.LoginRequest
        • soulfire.login_pb2.NextAuthFlowResponse
          • soulfire.login_pb2.NextAuthFlowResponse.EmailCode
          • soulfire.login_pb2.NextAuthFlowResponse.Success
          • soulfire.login_pb2.NextAuthFlowResponse.Failure
            • soulfire.login_pb2.NextAuthFlowResponse.Failure.Reason
        • soulfire.login_pb2.EmailCodeRequest
      • soulfire.logs_connect
        • soulfire.logs_connect.LogsService
        • soulfire.logs_connect.LogsServiceASGIApplication
        • soulfire.logs_connect.LogsServiceClient
        • soulfire.logs_connect.LogsServiceSync
        • soulfire.logs_connect.LogsServiceWSGIApplication
        • soulfire.logs_connect.LogsServiceClientSync
      • soulfire.logs_pb2
        • soulfire.logs_pb2.LogString
        • soulfire.logs_pb2.GlobalLogScope
        • soulfire.logs_pb2.InstanceLogScope
        • soulfire.logs_pb2.BotLogScope
        • soulfire.logs_pb2.InstanceScriptLogScope
        • soulfire.logs_pb2.PersonalLogScope
        • soulfire.logs_pb2.LogScope
        • soulfire.logs_pb2.PreviousLogRequest
        • soulfire.logs_pb2.PreviousLogResponse
        • soulfire.logs_pb2.LogRequest
        • soulfire.logs_pb2.LogResponse
      • soulfire.mc_auth_connect
        • soulfire.mc_auth_connect.MCAuthService
        • soulfire.mc_auth_connect.MCAuthServiceASGIApplication
        • soulfire.mc_auth_connect.MCAuthServiceClient
        • soulfire.mc_auth_connect.MCAuthServiceSync
        • soulfire.mc_auth_connect.MCAuthServiceWSGIApplication
        • soulfire.mc_auth_connect.MCAuthServiceClientSync
      • soulfire.mc_auth_pb2
        • soulfire.mc_auth_pb2.CredentialsAuthRequest
        • soulfire.mc_auth_pb2.CredentialsAuthOneSuccess
        • soulfire.mc_auth_pb2.CredentialsAuthOneFailure
        • soulfire.mc_auth_pb2.CredentialsAuthEnd
        • soulfire.mc_auth_pb2.CredentialsAuthResponse
        • soulfire.mc_auth_pb2.DeviceCodeAuthRequest
        • soulfire.mc_auth_pb2.DeviceCode
        • soulfire.mc_auth_pb2.DeviceCodeAuthResponse
        • soulfire.mc_auth_pb2.RefreshRequest
        • soulfire.mc_auth_pb2.RefreshResponse
      • soulfire.metrics_connect
        • soulfire.metrics_connect.MetricsService
        • soulfire.metrics_connect.MetricsServiceASGIApplication
        • soulfire.metrics_connect.MetricsServiceClient
        • soulfire.metrics_connect.MetricsServiceSync
        • soulfire.metrics_connect.MetricsServiceWSGIApplication
        • soulfire.metrics_connect.MetricsServiceClientSync
      • soulfire.metrics_pb2
        • soulfire.metrics_pb2.MetricsSnapshot
        • soulfire.metrics_pb2.MetricsDistributions
          • soulfire.metrics_pb2.MetricsDistributions.DimensionCountsEntry
          • soulfire.metrics_pb2.MetricsDistributions.GameModeCountsEntry
        • soulfire.metrics_pb2.BotPosition
        • soulfire.metrics_pb2.GetInstanceMetricsRequest
        • soulfire.metrics_pb2.GetInstanceMetricsResponse
        • soulfire.metrics_pb2.ServerMetricsSnapshot
        • soulfire.metrics_pb2.GetServerMetricsRequest
        • soulfire.metrics_pb2.GetServerMetricsResponse
      • soulfire.pathfinding
        • soulfire.pathfinding.BlockTarget
        • soulfire.pathfinding.WorldTarget
        • soulfire.pathfinding.EntityTarget
        • soulfire.pathfinding.SoulFirePathfinder
        • soulfire.pathfinding.Goals
      • soulfire.pathfinding_connect
        • soulfire.pathfinding_connect.PathfinderService
        • soulfire.pathfinding_connect.PathfinderServiceASGIApplication
        • soulfire.pathfinding_connect.PathfinderServiceClient
        • soulfire.pathfinding_connect.PathfinderServiceSync
        • soulfire.pathfinding_connect.PathfinderServiceWSGIApplication
        • soulfire.pathfinding_connect.PathfinderServiceClientSync
      • soulfire.pathfinding_pb2
        • soulfire.pathfinding_pb2.PathStepKind
        • soulfire.pathfinding_pb2.PathPlanStatus
        • soulfire.pathfinding_pb2.PathFrontierReason
        • soulfire.pathfinding_pb2.PathRouteCost
        • soulfire.pathfinding_pb2.PathChunk
        • soulfire.pathfinding_pb2.PathStep
        • soulfire.pathfinding_pb2.PathPlan
        • soulfire.pathfinding_pb2.PlanPathRequest
        • soulfire.pathfinding_pb2.PlanPathResponse
      • soulfire.plugin
        • soulfire.plugin.example
          • soulfire.plugin.example.v1
            • soulfire.plugin.example.v1.example_connect
              • soulfire.plugin.example.v1.example_connect.ExamplePluginService
              • soulfire.plugin.example.v1.example_connect.ExamplePluginServiceASGIApplication
              • soulfire.plugin.example.v1.example_connect.ExamplePluginServiceClient
              • soulfire.plugin.example.v1.example_connect.ExamplePluginServiceSync
              • soulfire.plugin.example.v1.example_connect.ExamplePluginServiceWSGIApplication
              • soulfire.plugin.example.v1.example_connect.ExamplePluginServiceClientSync
            • soulfire.plugin.example.v1.example_pb2
              • soulfire.plugin.example.v1.example_pb2.EchoRequest
              • soulfire.plugin.example.v1.example_pb2.EchoResponse
              • soulfire.plugin.example.v1.example_pb2.WatchTicksRequest
              • soulfire.plugin.example.v1.example_pb2.Tick
      • soulfire.plugin_api_connect
        • soulfire.plugin_api_connect.PluginApiService
        • soulfire.plugin_api_connect.PluginApiServiceASGIApplication
        • soulfire.plugin_api_connect.PluginApiServiceClient
        • soulfire.plugin_api_connect.PluginApiServiceSync
        • soulfire.plugin_api_connect.PluginApiServiceWSGIApplication
        • soulfire.plugin_api_connect.PluginApiServiceClientSync
      • soulfire.plugin_api_pb2
        • soulfire.plugin_api_pb2.PluginPermissionScope
        • soulfire.plugin_api_pb2.PluginPermissionRisk
        • soulfire.plugin_api_pb2.PluginPermissionDefault
        • soulfire.plugin_api_pb2.PluginApiStability
        • soulfire.plugin_api_pb2.PluginApiEventKind
        • soulfire.plugin_api_pb2.PluginEventKind
        • soulfire.plugin_api_pb2.PluginPermissionDescriptor
        • soulfire.plugin_api_pb2.PluginRpcMethodDescriptor
        • soulfire.plugin_api_pb2.PluginRpcServiceDescriptor
        • soulfire.plugin_api_pb2.PluginEventTypeDescriptor
        • soulfire.plugin_api_pb2.PluginTaskTypeDescriptor
        • soulfire.plugin_api_pb2.PluginSdkPackages
        • soulfire.plugin_api_pb2.PluginApiDescriptor
        • soulfire.plugin_api_pb2.ListPluginApisRequest
        • soulfire.plugin_api_pb2.ListPluginApisResponse
        • soulfire.plugin_api_pb2.GetPluginApiRequest
        • soulfire.plugin_api_pb2.GetPluginApiResponse
        • soulfire.plugin_api_pb2.GetPluginDescriptorSetRequest
        • soulfire.plugin_api_pb2.GetPluginDescriptorSetResponse
        • soulfire.plugin_api_pb2.WatchPluginApisRequest
        • soulfire.plugin_api_pb2.PluginApiEvent
        • soulfire.plugin_api_pb2.PluginEventScope
        • soulfire.plugin_api_pb2.WatchPluginEventsRequest
        • soulfire.plugin_api_pb2.PluginEvent
      • soulfire.plugin_stats_connect
        • soulfire.plugin_stats_connect.PluginStatsService
        • soulfire.plugin_stats_connect.PluginStatsServiceASGIApplication
        • soulfire.plugin_stats_connect.PluginStatsServiceClient
        • soulfire.plugin_stats_connect.PluginStatsServiceSync
        • soulfire.plugin_stats_connect.PluginStatsServiceWSGIApplication
        • soulfire.plugin_stats_connect.PluginStatsServiceClientSync
      • soulfire.plugin_stats_pb2
        • soulfire.plugin_stats_pb2.PluginMetric
        • soulfire.plugin_stats_pb2.PluginRuntimeStat
        • soulfire.plugin_stats_pb2.GetInstancePluginStatsRequest
        • soulfire.plugin_stats_pb2.GetInstancePluginStatsResponse
      • soulfire.plugins
        • soulfire.plugins.ReflectiveMessage
        • soulfire.plugins.TypedPluginEvent
        • soulfire.plugins.ReflectivePluginEvent
        • soulfire.plugins.ReflectivePlugin
        • soulfire.plugins.ServiceFactory
        • soulfire.plugins.SoulFirePluginModule
        • soulfire.plugins.PluginCatalog
      • soulfire.pov_connect
        • soulfire.pov_connect.PovService
        • soulfire.pov_connect.PovServiceASGIApplication
        • soulfire.pov_connect.PovServiceClient
        • soulfire.pov_connect.PovServiceSync
        • soulfire.pov_connect.PovServiceWSGIApplication
        • soulfire.pov_connect.PovServiceClientSync
      • soulfire.pov_pb2
        • soulfire.pov_pb2.PovWatchRequest
        • soulfire.pov_pb2.PovFrame
          • soulfire.pov_pb2.PovFrame.CursorShape
        • soulfire.pov_pb2.PovInputRequest
        • soulfire.pov_pb2.PovStreamFeedback
        • soulfire.pov_pb2.PovInputResponse
        • soulfire.pov_pb2.PovInputEvent
          • soulfire.pov_pb2.PovInputEvent.Kind
      • soulfire.protocol
        • soulfire.protocol.SoulFireProtocol
      • soulfire.protocol_connect
        • soulfire.protocol_connect.BotProtocolService
        • soulfire.protocol_connect.BotProtocolServiceASGIApplication
        • soulfire.protocol_connect.BotProtocolServiceClient
        • soulfire.protocol_connect.BotProtocolServiceSync
        • soulfire.protocol_connect.BotProtocolServiceWSGIApplication
        • soulfire.protocol_connect.BotProtocolServiceClientSync
      • soulfire.protocol_pb2
        • soulfire.protocol_pb2.PacketDirection
        • soulfire.protocol_pb2.BotProtocolRequest
        • soulfire.protocol_pb2.BotProtocolInfo
        • soulfire.protocol_pb2.ListPacketSchemasRequest
        • soulfire.protocol_pb2.PacketSchema
        • soulfire.protocol_pb2.ListPacketSchemasResponse
        • soulfire.protocol_pb2.WatchPacketsRequest
        • soulfire.protocol_pb2.RawPacketEvent
        • soulfire.protocol_pb2.SendRawPacketRequest
        • soulfire.protocol_pb2.SendRawPacketResponse
      • soulfire.proxy_check_connect
        • soulfire.proxy_check_connect.ProxyCheckService
        • soulfire.proxy_check_connect.ProxyCheckServiceASGIApplication
        • soulfire.proxy_check_connect.ProxyCheckServiceClient
        • soulfire.proxy_check_connect.ProxyCheckServiceSync
        • soulfire.proxy_check_connect.ProxyCheckServiceWSGIApplication
        • soulfire.proxy_check_connect.ProxyCheckServiceClientSync
      • soulfire.proxy_check_pb2
        • soulfire.proxy_check_pb2.ProxyCheckRequest
        • soulfire.proxy_check_pb2.ProxyCheckResponseSingle
        • soulfire.proxy_check_pb2.ProxyCheckEnd
        • soulfire.proxy_check_pb2.ProxyCheckResponse
      • soulfire.recipe_connect
        • soulfire.recipe_connect.RecipeService
        • soulfire.recipe_connect.RecipeServiceASGIApplication
        • soulfire.recipe_connect.RecipeServiceClient
        • soulfire.recipe_connect.RecipeServiceSync
        • soulfire.recipe_connect.RecipeServiceWSGIApplication
        • soulfire.recipe_connect.RecipeServiceClientSync
      • soulfire.recipe_pb2
        • soulfire.recipe_pb2.IngredientChoice
        • soulfire.recipe_pb2.RecipeSnapshot
        • soulfire.recipe_pb2.ListRecipesRequest
        • soulfire.recipe_pb2.ListRecipesResponse
        • soulfire.recipe_pb2.CanCraftRequest
        • soulfire.recipe_pb2.MissingIngredient
        • soulfire.recipe_pb2.CanCraftResponse
        • soulfire.recipe_pb2.CraftTask
        • soulfire.recipe_pb2.CraftTaskResult
        • soulfire.recipe_pb2.SmeltTask
        • soulfire.recipe_pb2.SmeltTaskResult
        • soulfire.recipe_pb2.BrewTask
        • soulfire.recipe_pb2.BrewTaskResult
        • soulfire.recipe_pb2.VillagerTradeOfferSnapshot
        • soulfire.recipe_pb2.ListVillagerTradesRequest
        • soulfire.recipe_pb2.ListVillagerTradesResponse
        • soulfire.recipe_pb2.VillagerTradeTask
        • soulfire.recipe_pb2.VillagerTradeTaskResult
      • soulfire.registry_connect
        • soulfire.registry_connect.RegistryService
        • soulfire.registry_connect.RegistryServiceASGIApplication
        • soulfire.registry_connect.RegistryServiceClient
        • soulfire.registry_connect.RegistryServiceSync
        • soulfire.registry_connect.RegistryServiceWSGIApplication
        • soulfire.registry_connect.RegistryServiceClientSync
      • soulfire.registry_pb2
        • soulfire.registry_pb2.RegistryKind
        • soulfire.registry_pb2.RegistryIdentity
        • soulfire.registry_pb2.MinecraftRegistryEntry
        • soulfire.registry_pb2.GetRegistryIdentityRequest
        • soulfire.registry_pb2.GetRegistryIdentityResponse
        • soulfire.registry_pb2.ListRegistryEntriesRequest
        • soulfire.registry_pb2.ListRegistryEntriesResponse
        • soulfire.registry_pb2.GetRegistryEntryRequest
        • soulfire.registry_pb2.GetRegistryEntryResponse
        • soulfire.registry_pb2.ListRegistryTagsRequest
        • soulfire.registry_pb2.RegistryTag
        • soulfire.registry_pb2.ListRegistryTagsResponse
      • soulfire.resources
      • soulfire.script_connect
        • soulfire.script_connect.ScriptService
        • soulfire.script_connect.ScriptServiceASGIApplication
        • soulfire.script_connect.ScriptServiceClient
        • soulfire.script_connect.ScriptServiceSync
        • soulfire.script_connect.ScriptServiceWSGIApplication
        • soulfire.script_connect.ScriptServiceClientSync
      • soulfire.script_pb2
        • soulfire.script_pb2.EdgeType
        • soulfire.script_pb2.PortType
        • soulfire.script_pb2.LogLevel
        • soulfire.script_pb2.DiagnosticSeverity
        • soulfire.script_pb2.HandleShape
        • soulfire.script_pb2.EdgeStyle
        • soulfire.script_pb2.Position
        • soulfire.script_pb2.TypeDescriptor
        • soulfire.script_pb2.ParameterizedType
        • soulfire.script_pb2.PortDefinition
        • soulfire.script_pb2.NodeTypeDefinition
        • soulfire.script_pb2.ScriptNode
          • soulfire.script_pb2.ScriptNode.DataEntry
        • soulfire.script_pb2.ScriptEdge
        • soulfire.script_pb2.ScriptData
        • soulfire.script_pb2.ScriptQuotas
        • soulfire.script_pb2.ScriptInfo
        • soulfire.script_pb2.ScriptStatus
        • soulfire.script_pb2.ScriptLogEntry
        • soulfire.script_pb2.NodeStarted
        • soulfire.script_pb2.NodeCompleted
          • soulfire.script_pb2.NodeCompleted.OutputsEntry
        • soulfire.script_pb2.ExecutionStats
        • soulfire.script_pb2.NodeError
        • soulfire.script_pb2.ScriptLog
        • soulfire.script_pb2.ScriptStarted
        • soulfire.script_pb2.ScriptCompleted
        • soulfire.script_pb2.ValidationDiagnostic
        • soulfire.script_pb2.ScriptEvent
        • soulfire.script_pb2.CreateScriptRequest
        • soulfire.script_pb2.CreateScriptResponse
        • soulfire.script_pb2.GetScriptRequest
        • soulfire.script_pb2.GetScriptResponse
        • soulfire.script_pb2.UpdateScriptRequest
        • soulfire.script_pb2.UpdateScriptResponse
        • soulfire.script_pb2.DeleteScriptRequest
        • soulfire.script_pb2.DeleteScriptResponse
        • soulfire.script_pb2.ListScriptsRequest
        • soulfire.script_pb2.ListScriptsResponse
        • soulfire.script_pb2.ActivateScriptRequest
        • soulfire.script_pb2.DeactivateScriptRequest
        • soulfire.script_pb2.DeactivateScriptResponse
        • soulfire.script_pb2.GetScriptStatusRequest
        • soulfire.script_pb2.GetScriptStatusResponse
        • soulfire.script_pb2.SubscribeScriptLogsRequest
        • soulfire.script_pb2.GetNodeTypesRequest
        • soulfire.script_pb2.CategoryDefinition
        • soulfire.script_pb2.GetNodeTypesResponse
        • soulfire.script_pb2.PortTypeMetadata
        • soulfire.script_pb2.GetRegistryDataRequest
        • soulfire.script_pb2.RegistryEntry
        • soulfire.script_pb2.ValidateScriptRequest
        • soulfire.script_pb2.ValidateScriptResponse
        • soulfire.script_pb2.DryRunScriptRequest
          • soulfire.script_pb2.DryRunScriptRequest.MockInputsEntry
        • soulfire.script_pb2.GetRegistryDataResponse
      • soulfire.sdk_connect
        • soulfire.sdk_connect.SdkService
        • soulfire.sdk_connect.SdkServiceASGIApplication
        • soulfire.sdk_connect.SdkServiceClient
        • soulfire.sdk_connect.SdkServiceSync
        • soulfire.sdk_connect.SdkServiceWSGIApplication
        • soulfire.sdk_connect.SdkServiceClientSync
      • soulfire.sdk_pb2
        • soulfire.sdk_pb2.SdkTransport
        • soulfire.sdk_pb2.SdkApiVersion
        • soulfire.sdk_pb2.RequiredPlugin
        • soulfire.sdk_pb2.SdkHandshakeRequest
        • soulfire.sdk_pb2.SdkCapability
        • soulfire.sdk_pb2.SdkLimit
        • soulfire.sdk_pb2.SdkIdentity
        • soulfire.sdk_pb2.SdkHandshakeResponse
      • soulfire.selectors
      • soulfire.semantic
        • soulfire.semantic.InventoryRankingOptions
        • soulfire.semantic.ChatMatch
        • soulfire.semantic.SoulFireChat
        • soulfire.semantic.SoulFireWorld
        • soulfire.semantic.SoulFireContainer
        • soulfire.semantic.SoulFireInventory
        • soulfire.semantic.SoulFireRecipes
        • soulfire.semantic.SoulFireRegistry
      • soulfire.server_connect
        • soulfire.server_connect.ServerService
        • soulfire.server_connect.ServerServiceASGIApplication
        • soulfire.server_connect.ServerServiceClient
        • soulfire.server_connect.ServerServiceSync
        • soulfire.server_connect.ServerServiceWSGIApplication
        • soulfire.server_connect.ServerServiceClientSync
      • soulfire.server_pb2
        • soulfire.server_pb2.ServerConfig
        • soulfire.server_pb2.ServerInfoRequest
        • soulfire.server_pb2.ServerInfoResponse
        • soulfire.server_pb2.ServerUpdateConfigRequest
        • soulfire.server_pb2.ServerUpdateConfigResponse
        • soulfire.server_pb2.ServerUpdateConfigEntryRequest
        • soulfire.server_pb2.ServerUpdateConfigEntryResponse
      • soulfire.session
        • soulfire.session.BotSessionState
        • soulfire.session.BotEnvironmentState
        • soulfire.session.BotBossBarState
        • soulfire.session.BotScoreboardObjective
        • soulfire.session.BotScoreboardScore
        • soulfire.session.BotScoreboardTeam
        • soulfire.session.BotScoreboardState
        • soulfire.session.BotSessionOptions
        • soulfire.session.BotEventStreamFactory
        • soulfire.session.BotSession
      • soulfire.streams
        • soulfire.streams.Item
        • soulfire.streams.End
        • soulfire.streams.Cursor
        • soulfire.streams.Stream
      • soulfire.task_connect
        • soulfire.task_connect.BotTaskService
        • soulfire.task_connect.BotTaskServiceASGIApplication
        • soulfire.task_connect.BotTaskServiceClient
        • soulfire.task_connect.BotTaskServiceSync
        • soulfire.task_connect.BotTaskServiceWSGIApplication
        • soulfire.task_connect.BotTaskServiceClientSync
      • soulfire.task_pb2
        • soulfire.task_pb2.BotTaskResource
        • soulfire.task_pb2.BotTaskStatus
        • soulfire.task_pb2.BotTaskConflictPolicy
        • soulfire.task_pb2.BotTaskReconnectPolicy
        • soulfire.task_pb2.BotTaskDisconnectPolicy
        • soulfire.task_pb2.BotTaskPriority
        • soulfire.task_pb2.FollowEntityCompletionReason
        • soulfire.task_pb2.AttackEntityCompletionReason
        • soulfire.task_pb2.AttackNearestCompletionReason
        • soulfire.task_pb2.RangedAttackCompletionReason
        • soulfire.task_pb2.FleeCompletionReason
        • soulfire.task_pb2.GuardCompletionReason
        • soulfire.task_pb2.SleepCompletionReason
        • soulfire.task_pb2.FishCompletionReason
        • soulfire.task_pb2.FarmCompletionReason
        • soulfire.task_pb2.BreedCompletionReason
        • soulfire.task_pb2.ExploreCompletionReason
        • soulfire.task_pb2.ContainerTransferDirection
        • soulfire.task_pb2.ContainerTransferCompletionReason
        • soulfire.task_pb2.AutoEatCompletionReason
        • soulfire.task_pb2.AutoRespawnCompletionReason
        • soulfire.task_pb2.AutoTotemCompletionReason
        • soulfire.task_pb2.AutoArmorCompletionReason
        • soulfire.task_pb2.CollectBlocksCompletionReason
        • soulfire.task_pb2.ExcavateCompletionReason
        • soulfire.task_pb2.BuildRotation
        • soulfire.task_pb2.BuildMirror
        • soulfire.task_pb2.BuildBlockStatus
        • soulfire.task_pb2.BuildCompletionReason
        • soulfire.task_pb2.MaintainLoadoutCompletionReason
        • soulfire.task_pb2.BotTaskProgress
        • soulfire.task_pb2.BotTaskFailure
        • soulfire.task_pb2.BotTask
        • soulfire.task_pb2.StartBotTaskRequest
        • soulfire.task_pb2.GetBotTaskRequest
        • soulfire.task_pb2.ListBotTasksRequest
        • soulfire.task_pb2.ListBotTasksResponse
        • soulfire.task_pb2.WatchBotTaskRequest
        • soulfire.task_pb2.WatchBotTasksRequest
        • soulfire.task_pb2.BotTaskEvent
        • soulfire.task_pb2.CancelBotTaskRequest
        • soulfire.task_pb2.GoToTask
        • soulfire.task_pb2.GoToTaskResult
        • soulfire.task_pb2.FollowEntityTask
        • soulfire.task_pb2.FollowEntityTaskResult
        • soulfire.task_pb2.AttackEntityTask
        • soulfire.task_pb2.AttackEntityTaskResult
        • soulfire.task_pb2.AttackNearestTask
        • soulfire.task_pb2.AttackNearestTaskResult
        • soulfire.task_pb2.RangedAttackTask
        • soulfire.task_pb2.RangedAttackTaskResult
        • soulfire.task_pb2.FleeTask
        • soulfire.task_pb2.FleeTaskResult
        • soulfire.task_pb2.GuardTask
        • soulfire.task_pb2.GuardTaskResult
        • soulfire.task_pb2.SleepTask
        • soulfire.task_pb2.SleepTaskResult
        • soulfire.task_pb2.FishTask
        • soulfire.task_pb2.FishTaskResult
        • soulfire.task_pb2.FarmTask
        • soulfire.task_pb2.FarmTaskResult
        • soulfire.task_pb2.BreedTask
        • soulfire.task_pb2.BreedTaskResult
        • soulfire.task_pb2.ExploreTask
        • soulfire.task_pb2.ExploreTaskResult
        • soulfire.task_pb2.ContainerTransferOperation
        • soulfire.task_pb2.ContainerTransferTask
        • soulfire.task_pb2.ContainerTransferOutcome
        • soulfire.task_pb2.ContainerTransferTaskResult
        • soulfire.task_pb2.AutoEatTask
        • soulfire.task_pb2.AutoEatTaskResult
        • soulfire.task_pb2.AutoRespawnTask
        • soulfire.task_pb2.AutoRespawnTaskResult
        • soulfire.task_pb2.AutoTotemTask
        • soulfire.task_pb2.AutoTotemTaskResult
        • soulfire.task_pb2.AutoArmorTask
        • soulfire.task_pb2.AutoArmorTaskResult
        • soulfire.task_pb2.CollectBlocksTask
        • soulfire.task_pb2.CollectBlocksTaskResult
        • soulfire.task_pb2.CollectBlocksTaskProgressDetail
          • soulfire.task_pb2.CollectBlocksTaskProgressDetail.Phase
          • soulfire.task_pb2.CollectBlocksTaskProgressDetail.FailedApproach
        • soulfire.task_pb2.ExcavateTask
        • soulfire.task_pb2.ExcavateTaskResult
        • soulfire.task_pb2.BuildOffset
        • soulfire.task_pb2.BuildBlock
          • soulfire.task_pb2.BuildBlock.PropertiesEntry
        • soulfire.task_pb2.BuildMaterialSubstitution
        • soulfire.task_pb2.BuildTask
        • soulfire.task_pb2.BuildBlockOutcome
        • soulfire.task_pb2.BuildTaskResult
        • soulfire.task_pb2.LoadoutRequirement
        • soulfire.task_pb2.MaintainLoadoutTask
        • soulfire.task_pb2.LoadoutRequirementResult
        • soulfire.task_pb2.MaintainLoadoutTaskResult
      • soulfire.tasks
        • soulfire.tasks.TaskStartOptions
        • soulfire.tasks.EntityTargetLike
        • soulfire.tasks.ContainerTransferSpec
        • soulfire.tasks.LoadoutRequirementSpec
        • soulfire.tasks.SchematicBlock
        • soulfire.tasks.SoulFireTask
        • soulfire.tasks.SoulFireTasks
      • soulfire.transport
      • soulfire.user_connect
        • soulfire.user_connect.UserService
        • soulfire.user_connect.UserServiceASGIApplication
        • soulfire.user_connect.UserServiceClient
        • soulfire.user_connect.UserServiceSync
        • soulfire.user_connect.UserServiceWSGIApplication
        • soulfire.user_connect.UserServiceClientSync
      • soulfire.user_pb2
        • soulfire.user_pb2.UserCreateRequest
        • soulfire.user_pb2.UserCreateResponse
        • soulfire.user_pb2.UserDeleteRequest
        • soulfire.user_pb2.UserDeleteResponse
        • soulfire.user_pb2.UserListRequest
        • soulfire.user_pb2.UserListResponse
          • soulfire.user_pb2.UserListResponse.User
        • soulfire.user_pb2.UserInfoRequest
        • soulfire.user_pb2.UserInfoResponse
        • soulfire.user_pb2.InvalidateSessionsRequest
        • soulfire.user_pb2.InvalidateSessionsResponse
        • soulfire.user_pb2.UpdateUserRequest
        • soulfire.user_pb2.UpdateUserResponse
        • soulfire.user_pb2.GenerateUserAPITokenRequest
        • soulfire.user_pb2.GenerateUserAPITokenResponse
        • soulfire.user_pb2.UserPluginPermissionGrant
        • soulfire.user_pb2.ListUserPluginPermissionGrantsRequest
        • soulfire.user_pb2.ListUserPluginPermissionGrantsResponse
        • soulfire.user_pb2.SetUserPluginPermissionGrantRequest
        • soulfire.user_pb2.DeleteUserPluginPermissionGrantRequest
        • soulfire.user_pb2.DeleteUserPluginPermissionGrantResponse
      • soulfire.world_connect
        • soulfire.world_connect.WorldService
        • soulfire.world_connect.WorldServiceASGIApplication
        • soulfire.world_connect.WorldServiceClient
        • soulfire.world_connect.WorldServiceSync
        • soulfire.world_connect.WorldServiceWSGIApplication
        • soulfire.world_connect.WorldServiceClientSync
      • soulfire.world_pb2
        • soulfire.world_pb2.QuerySort
        • soulfire.world_pb2.IntRange
        • soulfire.world_pb2.FloatRange
        • soulfire.world_pb2.BlockSelector
          • soulfire.world_pb2.BlockSelector.PropertiesEntry
        • soulfire.world_pb2.EntitySelector
        • soulfire.world_pb2.QueryRegion
        • soulfire.world_pb2.SphereRegion
        • soulfire.world_pb2.BoxRegion
        • soulfire.world_pb2.GetPlayerSnapshotRequest
        • soulfire.world_pb2.GetPlayerSnapshotResponse
        • soulfire.world_pb2.GetWorldBlockRequest
        • soulfire.world_pb2.GetWorldBlockResponse
        • soulfire.world_pb2.QueryBlocksRequest
        • soulfire.world_pb2.QueryBlocksResponse
        • soulfire.world_pb2.GetWorldEntityRequest
        • soulfire.world_pb2.GetWorldEntityResponse
        • soulfire.world_pb2.QueryEntitiesRequest
        • soulfire.world_pb2.QueryEntitiesResponse
        • soulfire.world_pb2.RaycastRequest
        • soulfire.world_pb2.RaycastResponse
        • soulfire.world_pb2.CanSeeBlockRequest
        • soulfire.world_pb2.CanSeeBlockResponse
        • soulfire.world_pb2.EstimateDigTimeRequest
        • soulfire.world_pb2.EstimateDigTimeResponse
        • soulfire.world_pb2.EstimateExplosionDamageRequest
        • soulfire.world_pb2.EstimateExplosionDamageResponse
      • soulfire.SoulFireActionError
      • soulfire.SoulFireBehaviorError
      • soulfire.SoulFireBehaviorTimeoutError
      • soulfire.SoulFireCapabilityError
      • soulfire.SoulFireCompatibilityError
      • soulfire.SoulFireInstallError
      • soulfire.SoulFireRpcError
      • soulfire.SoulFireStateError
      • soulfire.SoulFireTimeoutError
      • soulfire.SoulFireValidationError
      • soulfire.FleetTaskGroupError
      • soulfire.SoulFirePluginCompatibilityError
      • soulfire.SoulFirePluginDescriptorError
      • soulfire.SoulFirePluginNotFoundError
      • soulfire.SoulFireContainerClosedError
      • soulfire.SoulFireTaskError
      • soulfire.LocalSoulFireServer
      • soulfire.SoulFireAdmin
      • soulfire.AttackNearest
      • soulfire.AutoArmor
      • soulfire.AutoEat
      • soulfire.AutoRespawn
      • soulfire.AutoTotem
      • soulfire.BotBehavior
      • soulfire.Build
      • soulfire.BuildPlacement
      • soulfire.CollectBlocks
      • soulfire.FollowEntity
      • soulfire.FunctionBehavior
      • soulfire.SoulFireBot
      • soulfire.SoulFireBotControlLease
      • soulfire.BotChunkEvent
      • soulfire.BotEvent
      • soulfire.BotEventFilter
      • soulfire.BotResourcePackEvent
      • soulfire.BotTitleEvent
      • soulfire.ChunkEventKind
      • soulfire.CreativeItemStack
      • soulfire.ResourcePackEventKind
      • soulfire.ResourcePackResponse
      • soulfire.TitleEventKind
      • soulfire.WaitForChunksResponse
      • soulfire.CameraRenderOptions
      • soulfire.SoulFireCamera
      • soulfire.WorldMapOptions
      • soulfire.ManagedInstallOptions
      • soulfire.SoulFire
      • soulfire.SoulFireInstance
      • soulfire.SoulFireService
      • soulfire.BlockPosition
      • soulfire.WorldPosition
      • soulfire.CapabilitySet
      • soulfire.RequiredPlugin
      • soulfire.ServerMetadata
      • soulfire.BlockSnapshot
        • soulfire.BlockSnapshot.PropertiesEntry
      • soulfire.EntityReference
      • soulfire.EntitySnapshot
        • soulfire.EntitySnapshot.EquipmentEntry
      • soulfire.ItemStackSnapshot
      • soulfire.PlayerSnapshot
        • soulfire.PlayerSnapshot.EquipmentEntry
      • soulfire.TextComponent
      • soulfire.Vec3
      • soulfire.RpcFailureContext
      • soulfire.ExamplePluginClient
      • soulfire.FleetAssignment
      • soulfire.FleetBot
      • soulfire.FleetMetadataSelector
      • soulfire.FleetOperationOutcome
      • soulfire.FleetOperationReport
      • soulfire.FleetPoint
      • soulfire.FleetRadius
      • soulfire.FleetSelector
      • soulfire.FleetTaskMember
      • soulfire.FleetTaskOutcome
      • soulfire.FleetTaskReport
      • soulfire.FleetTaskStartFailure
      • soulfire.FleetTaskStartOptions
      • soulfire.FleetTaskStreamEvent
      • soulfire.SoulFireFleet
      • soulfire.SoulFireFleetTaskGroup
      • soulfire.InstanceEvent
      • soulfire.InstanceEventFilter
      • soulfire.BlockTarget
      • soulfire.EntityTarget
      • soulfire.Goals
      • soulfire.SoulFirePathfinder
      • soulfire.WorldTarget
      • soulfire.PluginPermissionDefault
      • soulfire.PluginPermissionDescriptor
      • soulfire.PluginPermissionRisk
      • soulfire.PluginPermissionScope
      • soulfire.PluginCatalog
      • soulfire.ReflectiveMessage
      • soulfire.ReflectivePlugin
      • soulfire.ReflectivePluginEvent
      • soulfire.SoulFirePluginModule
      • soulfire.TypedPluginEvent
      • soulfire.SoulFireProtocol
      • soulfire.BotProtocolInfo
      • soulfire.PacketDirection
      • soulfire.PacketSchema
      • soulfire.RawPacketEvent
      • soulfire.ChatMatch
      • soulfire.InventoryRankingOptions
      • soulfire.SoulFireChat
      • soulfire.SoulFireContainer
      • soulfire.SoulFireInventory
      • soulfire.SoulFireRecipes
      • soulfire.SoulFireRegistry
      • soulfire.SoulFireWorld
      • soulfire.BotBossBarState
      • soulfire.BotEnvironmentState
      • soulfire.BotScoreboardObjective
      • soulfire.BotScoreboardScore
      • soulfire.BotScoreboardState
      • soulfire.BotScoreboardTeam
      • soulfire.BotSession
      • soulfire.BotSessionOptions
      • soulfire.BotSessionState
      • soulfire.Stream
      • soulfire.ContainerTransferSpec
      • soulfire.LoadoutRequirementSpec
      • soulfire.SchematicBlock
      • soulfire.SoulFireTask
      • soulfire.SoulFireTasks
      • soulfire.UserPluginPermissionGrant
      • soulfire.BlockSelector
        • soulfire.BlockSelector.PropertiesEntry
      • soulfire.BoxRegion
      • soulfire.CanSeeBlockResponse
      • soulfire.EntitySelector
      • soulfire.EstimateDigTimeResponse
      • soulfire.EstimateExplosionDamageResponse
      • soulfire.GetWorldBlockResponse
      • soulfire.GetWorldEntityResponse
      • soulfire.QueryBlocksResponse
      • soulfire.QueryEntitiesResponse
      • soulfire.QueryRegion
      • soulfire.QuerySort
      • soulfire.RaycastResponse
      • soulfire.SphereRegion

Guides

  • Python tutorial
  • SDK recipes
  • TypeScript API
Back to top

soulfire.behaviors.BotBehavior¶

class soulfire.behaviors.BotBehavior[source]¶

Bases: Protocol[A, E, R]

run(bot: soulfire.bot.SoulFireBot) → effect_py.Effect[A, E, R][source]¶
Next
soulfire.behaviors.FunctionBehavior
Previous
soulfire.behaviors.SoulFireBehaviorTimeoutError
Copyright ©
Made with Sphinx and @pradyunsg's Furo
On this page
  • soulfire.behaviors.BotBehavior
    • soulfire.behaviors.BotBehavior
      • soulfire.behaviors.BotBehavior.run()