SoulFire TypeScript SDK 2.10.3
Guides
Python API
GitHub
Preparing search index...
browser
Module browser
Variables
SoulFire
References
AccountTypeCredentials
→
AccountTypeCredentials
AccountTypeDeviceCode
→
AccountTypeDeviceCode
AttackEntityTarget
→
AttackEntityTarget
AttackEntityTaskOptions
→
AttackEntityTaskOptions
AttackEntityTaskResult
→
AttackEntityTaskResult
attackNearest
→
attackNearest
AttackNearestOptions
→
AttackNearestOptions
AttackNearestTaskOptions
→
AttackNearestTaskOptions
AttackNearestTaskResult
→
AttackNearestTaskResult
autoArmor
→
autoArmor
AutoArmorOptions
→
AutoArmorOptions
AutoArmorTaskOptions
→
AutoArmorTaskOptions
AutoArmorTaskResult
→
AutoArmorTaskResult
autoEat
→
autoEat
AutoEatOptions
→
AutoEatOptions
AutoEatTaskOptions
→
AutoEatTaskOptions
AutoEatTaskResult
→
AutoEatTaskResult
autoRespawn
→
autoRespawn
AutoRespawnOptions
→
AutoRespawnOptions
AutoRespawnTaskOptions
→
AutoRespawnTaskOptions
AutoRespawnTaskResult
→
AutoRespawnTaskResult
autoTotem
→
autoTotem
AutoTotemOptions
→
AutoTotemOptions
AutoTotemTaskOptions
→
AutoTotemTaskOptions
AutoTotemTaskResult
→
AutoTotemTaskResult
BehaviorPredicate
→
BehaviorPredicate
BehaviorResult
→
BehaviorResult
BehaviorResults
→
BehaviorResults
BlockFace
→
BlockFace
BlockPosition
→
BlockPosition
BlockSelector
→
BlockSelector
BlockSnapshot
→
BlockSnapshot
BlockTarget
→
BlockTarget
BotActionResult
→
BotActionResult
BotActionStatus
→
BotActionStatus
BotBehavior
→
BotBehavior
BotBossBarState
→
BotBossBarState
BotChunkEvent
→
BotChunkEvent
BotControlLease
→
BotControlLease
BotDesiredState
→
BotDesiredState
BotEnvironmentState
→
BotEnvironmentState
BotEvent
→
BotEvent
BotEventFilter
→
BotEventFilter
BotEventFilterSchema
→
BotEventFilterSchema
BotFleetSummary
→
BotFleetSummary
BotGetDialogResponse
→
BotGetDialogResponse
BotInfoResponse
→
BotInfoResponse
BotInventoryStateResponse
→
BotInventoryStateResponse
BotLifecycleKind
→
BotLifecycleKind
BotListEntry
→
BotListEntry
BotLiveState
→
BotLiveState
BotMovement
→
BotMovement
BotPredicate
→
BotPredicate
BotProtocolInfo
→
BotProtocolInfo
BotResourcePackEvent
→
BotResourcePackEvent
BotRuntimeState
→
BotRuntimeState
BotScoreboardObjective
→
BotScoreboardObjective
BotScoreboardScore
→
BotScoreboardScore
BotScoreboardState
→
BotScoreboardState
BotScoreboardTeam
→
BotScoreboardTeam
BotSelection
→
BotSelection
BotSession
→
BotSession
BotSessionOptions
→
BotSessionOptions
BotSessionState
→
BotSessionState
BotStatus
→
BotStatus
BotTask
→
BotTask
BotTaskConflictPolicy
→
BotTaskConflictPolicy
BotTaskDisconnectPolicy
→
BotTaskDisconnectPolicy
BotTaskEvent
→
BotTaskEvent
BotTaskPriority
→
BotTaskPriority
BotTaskReconnectPolicy
→
BotTaskReconnectPolicy
BotTaskStatus
→
BotTaskStatus
BotTitleEvent
→
BotTitleEvent
BoxRegion
→
BoxRegion
BreedTaskOptions
→
BreedTaskOptions
BreedTaskResult
→
BreedTaskResult
BrewTaskOptions
→
BrewTaskOptions
BrewTaskResult
→
BrewTaskResult
build
→
build
BuildPlacement
→
BuildPlacement
BuildTaskOptions
→
BuildTaskOptions
BuildTaskResult
→
BuildTaskResult
CameraRenderOptions
→
CameraRenderOptions
CameraStreamOptions
→
CameraStreamOptions
CanSeeBlockResponse
→
CanSeeBlockResponse
CapabilitySet
→
CapabilitySet
ChatMatch
→
ChatMatch
ChatMatcher
→
ChatMatcher
ChatMutationOptions
→
ChatMutationOptions
ChatSource
→
ChatSource
ChunkEventKind
→
ChunkEventKind
cleanup
→
cleanup
ClickType
→
ClickType
collectBlocks
→
collectBlocks
CollectBlocksOptions
→
CollectBlocksOptions
CollectBlocksTaskOptions
→
CollectBlocksTaskOptions
CollectBlocksTaskResult
→
CollectBlocksTaskResult
conditional
→
conditional
ConnectionMetadata
→
ConnectionMetadata
ContainerMutationOptions
→
ContainerMutationOptions
ContainerTransferSpec
→
ContainerTransferSpec
ContainerTransferTaskOptions
→
ContainerTransferTaskOptions
ContainerTransferTaskResult
→
ContainerTransferTaskResult
CraftTaskOptions
→
CraftTaskOptions
CraftTaskResult
→
CraftTaskResult
CreateBotOptions
→
CreateBotOptions
CreativeItemStack
→
CreativeItemStack
CredentialsAuthResponse
→
CredentialsAuthResponse
decodeCameraImage
→
decodeCameraImage
defineBehavior
→
defineBehavior
defineSoulFirePlugin
→
defineSoulFirePlugin
DeviceCodeAuthResponse
→
DeviceCodeAuthResponse
emptyBotSessionState
→
emptyBotSessionState
EntityEventKind
→
EntityEventKind
EntityReference
→
EntityReference
EntitySelector
→
EntitySelector
EntitySnapshot
→
EntitySnapshot
EntityTarget
→
EntityTarget
EstimateDigTimeResponse
→
EstimateDigTimeResponse
EstimateExplosionDamageResponse
→
EstimateExplosionDamageResponse
examplePlugin
→
examplePlugin
ExamplePluginClient
→
ExamplePluginClient
ExcavateTaskOptions
→
ExcavateTaskOptions
ExcavateTaskResult
→
ExcavateTaskResult
ExploreTaskOptions
→
ExploreTaskOptions
ExploreTaskResult
→
ExploreTaskResult
fallback
→
fallback
FarmTaskOptions
→
FarmTaskOptions
FarmTaskResult
→
FarmTaskResult
FishTaskOptions
→
FishTaskOptions
FishTaskResult
→
FishTaskResult
FleeTaskOptions
→
FleeTaskOptions
FleeTaskResult
→
FleeTaskResult
FleetAssignment
→
FleetAssignment
FleetBot
→
FleetBot
FleetDistributionOptions
→
FleetDistributionOptions
FleetMetadataSelector
→
FleetMetadataSelector
FleetPoint
→
FleetPoint
FleetSelector
→
FleetSelector
FleetTaskEvent
→
FleetTaskEvent
FleetTaskGroupError
→
FleetTaskGroupError
FleetTaskMember
→
FleetTaskMember
FleetTaskOutcome
→
FleetTaskOutcome
FleetTaskReport
→
FleetTaskReport
FleetTaskResultValue
→
FleetTaskResultValue
FleetTaskStartFailure
→
FleetTaskStartFailure
FleetTaskStartOptions
→
FleetTaskStartOptions
followEntity
→
followEntity
FollowEntityTarget
→
FollowEntityTarget
FollowEntityTaskOptions
→
FollowEntityTaskOptions
FollowEntityTaskResult
→
FollowEntityTaskResult
GetOrCreateBotOptions
→
GetOrCreateBotOptions
GetOrCreateInstanceOptions
→
GetOrCreateInstanceOptions
GetWorldBlockResponse
→
GetWorldBlockResponse
GetWorldEntityResponse
→
GetWorldEntityResponse
goals
→
goals
GoToTaskOptions
→
GoToTaskOptions
GoToTaskResult
→
GoToTaskResult
GuardTaskOptions
→
GuardTaskOptions
GuardTaskResult
→
GuardTaskResult
Hand
→
Hand
InstanceEvent
→
InstanceEvent
InstanceEventFilter
→
InstanceEventFilter
InstanceEventFilterSchema
→
InstanceEventFilterSchema
InstanceInfo
→
InstanceInfo
InstanceListResponse_Instance
→
InstanceListResponse_Instance
InventoryArea
→
InventoryArea
InventoryItemRecommendation
→
InventoryItemRecommendation
InventoryItemScoreFactor
→
InventoryItemScoreFactor
InventoryRankingOptions
→
InventoryRankingOptions
InventoryRankOptions
→
InventoryRankOptions
InventoryRecommendationKind
→
InventoryRecommendationKind
isTerminalTaskStatus
→
isTerminalTaskStatus
itemSelector
→
itemSelector
ItemSelectorInput
→
ItemSelectorInput
ItemStackSnapshot
→
ItemStackSnapshot
LoadoutRequirementSpec
→
LoadoutRequirementSpec
LocalSoulFireServer
→
LocalSoulFireServer
MaintainLoadoutTaskOptions
→
MaintainLoadoutTaskOptions
MaintainLoadoutTaskResult
→
MaintainLoadoutTaskResult
makeEffectHttpClientFetch
→
makeEffectHttpClientFetch
ManagedBotOptions
→
ManagedBotOptions
matchChat
→
matchChat
MinecraftAccountProto
→
MinecraftAccountProto
NearbyEntity
→
NearbyEntity
NextAuthFlowResponse
→
NextAuthFlowResponse
NextAuthFlowResponse_Failure_Reason
→
NextAuthFlowResponse_Failure_Reason
PacketDirection
→
PacketDirection
PacketSchema
→
PacketSchema
parallel
→
parallel
ParallelOptions
→
ParallelOptions
PathfindGoal
→
PathfindGoal
PathfindOptions
→
PathfindOptions
PathfindProgress
→
PathfindProgress
PathfindSearchMode
→
PathfindSearchMode
PathfindStatus
→
PathfindStatus
PlanPathOptions
→
PlanPathOptions
PlayerSnapshot
→
PlayerSnapshot
PluginCatalog
→
PluginCatalog
PluginPermissionDefault
→
PluginPermissionDefault
PluginPermissionDescriptor
→
PluginPermissionDescriptor
PluginPermissionRisk
→
PluginPermissionRisk
PluginPermissionScope
→
PluginPermissionScope
ProxyProto
→
ProxyProto
QueryBlocksResponse
→
QueryBlocksResponse
QueryEntitiesResponse
→
QueryEntitiesResponse
QueryRegion
→
QueryRegion
QuerySort
→
QuerySort
race
→
race
RangedAttackTaskOptions
→
RangedAttackTaskOptions
RangedAttackTaskResult
→
RangedAttackTaskResult
RankInventoryItemsResponse
→
RankInventoryItemsResponse
RawPacketEvent
→
RawPacketEvent
RaycastResponse
→
RaycastResponse
reduceBotSessionState
→
reduceBotSessionState
ReflectiveMessage
→
ReflectiveMessage
ReflectivePlugin
→
ReflectivePlugin
ReflectivePluginEvent
→
ReflectivePluginEvent
RefreshResponse
→
RefreshResponse
repeat
→
repeat
RepeatOptions
→
RepeatOptions
RequiredPluginRequirement
→
RequiredPluginRequirement
ResourcePackEventKind
→
ResourcePackEventKind
ResourcePackResponse
→
ResourcePackResponse
retry
→
retry
RetryOptions
→
RetryOptions
rpcStream
→
rpcStream
runBehaviors
→
runBehaviors
SchematicBlock
→
SchematicBlock
scopedLease
→
scopedLease
SDK_API_VERSION
→
SDK_API_VERSION
SDK_VERSION
→
SDK_VERSION
SendRawPacketOptions
→
SendRawPacketOptions
sequence
→
sequence
ServerMetadata
→
ServerMetadata
SleepTaskOptions
→
SleepTaskOptions
SleepTaskResult
→
SleepTaskResult
SmeltTaskOptions
→
SmeltTaskOptions
SmeltTaskResult
→
SmeltTaskResult
SoulFireActionError
→
SoulFireActionError
SoulFireAdmin
→
SoulFireAdmin
SoulFireBehaviorError
→
SoulFireBehaviorError
SoulFireBot
→
SoulFireBot
SoulFireBotControlLease
→
SoulFireBotControlLease
SoulFireCamera
→
SoulFireCamera
SoulFireCapabilityError
→
SoulFireCapabilityError
SoulFireChat
→
SoulFireChat
SoulFireClient
→
SoulFireClient
SoulFireCompatibilityError
→
SoulFireCompatibilityError
SoulFireConnectionError
→
SoulFireConnectionError
SoulFireContainer
→
SoulFireContainer
SoulFireContainerClosedError
→
SoulFireContainerClosedError
SoulFireExtension
→
SoulFireExtension
SoulFireExtensionTypeId
→
SoulFireExtensionTypeId
SoulFireFleet
→
SoulFireFleet
SoulFireFleetTaskGroup
→
SoulFireFleetTaskGroup
SoulFireInstallError
→
SoulFireInstallError
SoulFireInstallOptions
→
SoulFireInstallOptions
SoulFireInstance
→
SoulFireInstance
SoulFireInventory
→
SoulFireInventory
SoulFireOperationError
→
SoulFireOperationError
SoulFireOptions
→
SoulFireOptions
SoulFirePathfinder
→
SoulFirePathfinder
SoulFirePluginCompatibilityError
→
SoulFirePluginCompatibilityError
SoulFirePluginDescriptorError
→
SoulFirePluginDescriptorError
SoulFirePluginError
→
SoulFirePluginError
SoulFirePluginModule
→
SoulFirePluginModule
SoulFirePluginNotFoundError
→
SoulFirePluginNotFoundError
SoulFireProtocol
→
SoulFireProtocol
SoulFireRecipes
→
SoulFireRecipes
SoulFireRegistry
→
SoulFireRegistry
SoulFireRpcError
→
SoulFireRpcError
SoulFireService
→
SoulFireService
SoulFireStateError
→
SoulFireStateError
SoulFireTask
→
SoulFireTask
SoulFireTaskError
→
SoulFireTaskError
SoulFireTaskFailed
→
SoulFireTaskFailed
SoulFireTasks
→
SoulFireTasks
SoulFireTimeoutError
→
SoulFireTimeoutError
SoulFireValidationError
→
SoulFireValidationError
SoulFireWorld
→
SoulFireWorld
SphereRegion
→
SphereRegion
TabCompleteOptions
→
TabCompleteOptions
TaskListOptions
→
TaskListOptions
TaskStartOptions
→
TaskStartOptions
TextComponent
→
TextComponent
timeout
→
timeout
TitleEventKind
→
TitleEventKind
TokenProvider
→
TokenProvider
TypedPluginEvent
→
TypedPluginEvent
until
→
until
UntilOptions
→
UntilOptions
UserPluginPermissionGrant
→
UserPluginPermissionGrant
Vec3
→
Vec3
VillagerTradeTaskOptions
→
VillagerTradeTaskOptions
VillagerTradeTaskResult
→
VillagerTradeTaskResult
WaitForChatOptions
→
WaitForChatOptions
WaitForChunksResponse
→
WaitForChunksResponse
WatchBotStatusesResponse
→
WatchBotStatusesResponse
WatchChatOptions
→
WatchChatOptions
WatchPacketsOptions
→
WatchPacketsOptions
WatchPluginEventOptions
→
WatchPluginEventOptions
WorldMapOptions
→
WorldMapOptions
WorldPosition
→
WorldPosition
WorldTarget
→
WorldTarget
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Variables
Soul
Fire
References
Account
Type
Credentials
Account
Type
Device
Code
Attack
Entity
Target
Attack
Entity
Task
Options
Attack
Entity
Task
Result
attack
Nearest
Attack
Nearest
Options
Attack
Nearest
Task
Options
Attack
Nearest
Task
Result
auto
Armor
Auto
Armor
Options
Auto
Armor
Task
Options
Auto
Armor
Task
Result
auto
Eat
Auto
Eat
Options
Auto
Eat
Task
Options
Auto
Eat
Task
Result
auto
Respawn
Auto
Respawn
Options
Auto
Respawn
Task
Options
Auto
Respawn
Task
Result
auto
Totem
Auto
Totem
Options
Auto
Totem
Task
Options
Auto
Totem
Task
Result
Behavior
Predicate
Behavior
Result
Behavior
Results
Block
Face
Block
Position
Block
Selector
Block
Snapshot
Block
Target
Bot
Action
Result
Bot
Action
Status
Bot
Behavior
Bot
Boss
Bar
State
Bot
Chunk
Event
Bot
Control
Lease
Bot
Desired
State
Bot
Environment
State
Bot
Event
Bot
Event
Filter
Bot
Event
Filter
Schema
Bot
Fleet
Summary
Bot
Get
Dialog
Response
Bot
Info
Response
Bot
Inventory
State
Response
Bot
Lifecycle
Kind
Bot
List
Entry
Bot
Live
State
Bot
Movement
Bot
Predicate
Bot
Protocol
Info
Bot
Resource
Pack
Event
Bot
Runtime
State
Bot
Scoreboard
Objective
Bot
Scoreboard
Score
Bot
Scoreboard
State
Bot
Scoreboard
Team
Bot
Selection
Bot
Session
Bot
Session
Options
Bot
Session
State
Bot
Status
Bot
Task
Bot
Task
Conflict
Policy
Bot
Task
Disconnect
Policy
Bot
Task
Event
Bot
Task
Priority
Bot
Task
Reconnect
Policy
Bot
Task
Status
Bot
Title
Event
Box
Region
Breed
Task
Options
Breed
Task
Result
Brew
Task
Options
Brew
Task
Result
build
Build
Placement
Build
Task
Options
Build
Task
Result
Camera
Render
Options
Camera
Stream
Options
Can
See
Block
Response
Capability
Set
Chat
Match
Chat
Matcher
Chat
Mutation
Options
Chat
Source
Chunk
Event
Kind
cleanup
Click
Type
collect
Blocks
Collect
Blocks
Options
Collect
Blocks
Task
Options
Collect
Blocks
Task
Result
conditional
Connection
Metadata
Container
Mutation
Options
Container
Transfer
Spec
Container
Transfer
Task
Options
Container
Transfer
Task
Result
Craft
Task
Options
Craft
Task
Result
Create
Bot
Options
Creative
Item
Stack
Credentials
Auth
Response
decode
Camera
Image
define
Behavior
define
Soul
Fire
Plugin
Device
Code
Auth
Response
empty
Bot
Session
State
Entity
Event
Kind
Entity
Reference
Entity
Selector
Entity
Snapshot
Entity
Target
Estimate
Dig
Time
Response
Estimate
Explosion
Damage
Response
example
Plugin
Example
Plugin
Client
Excavate
Task
Options
Excavate
Task
Result
Explore
Task
Options
Explore
Task
Result
fallback
Farm
Task
Options
Farm
Task
Result
Fish
Task
Options
Fish
Task
Result
Flee
Task
Options
Flee
Task
Result
Fleet
Assignment
Fleet
Bot
Fleet
Distribution
Options
Fleet
Metadata
Selector
Fleet
Point
Fleet
Selector
Fleet
Task
Event
Fleet
Task
Group
Error
Fleet
Task
Member
Fleet
Task
Outcome
Fleet
Task
Report
Fleet
Task
Result
Value
Fleet
Task
Start
Failure
Fleet
Task
Start
Options
follow
Entity
Follow
Entity
Target
Follow
Entity
Task
Options
Follow
Entity
Task
Result
Get
Or
Create
Bot
Options
Get
Or
Create
Instance
Options
Get
World
Block
Response
Get
World
Entity
Response
goals
Go
To
Task
Options
Go
To
Task
Result
Guard
Task
Options
Guard
Task
Result
Hand
Instance
Event
Instance
Event
Filter
Instance
Event
Filter
Schema
Instance
Info
Instance
List
Response_
Instance
Inventory
Area
Inventory
Item
Recommendation
Inventory
Item
Score
Factor
Inventory
Ranking
Options
Inventory
Rank
Options
Inventory
Recommendation
Kind
is
Terminal
Task
Status
item
Selector
Item
Selector
Input
Item
Stack
Snapshot
Loadout
Requirement
Spec
Local
Soul
Fire
Server
Maintain
Loadout
Task
Options
Maintain
Loadout
Task
Result
make
Effect
Http
Client
Fetch
Managed
Bot
Options
match
Chat
Minecraft
Account
Proto
Nearby
Entity
Next
Auth
Flow
Response
Next
Auth
Flow
Response_
Failure_
Reason
Packet
Direction
Packet
Schema
parallel
Parallel
Options
Pathfind
Goal
Pathfind
Options
Pathfind
Progress
Pathfind
Search
Mode
Pathfind
Status
Plan
Path
Options
Player
Snapshot
Plugin
Catalog
Plugin
Permission
Default
Plugin
Permission
Descriptor
Plugin
Permission
Risk
Plugin
Permission
Scope
Proxy
Proto
Query
Blocks
Response
Query
Entities
Response
Query
Region
Query
Sort
race
Ranged
Attack
Task
Options
Ranged
Attack
Task
Result
Rank
Inventory
Items
Response
Raw
Packet
Event
Raycast
Response
reduce
Bot
Session
State
Reflective
Message
Reflective
Plugin
Reflective
Plugin
Event
Refresh
Response
repeat
Repeat
Options
Required
Plugin
Requirement
Resource
Pack
Event
Kind
Resource
Pack
Response
retry
Retry
Options
rpc
Stream
run
Behaviors
Schematic
Block
scoped
Lease
SDK_
API_
VERSION
SDK_
VERSION
Send
Raw
Packet
Options
sequence
Server
Metadata
Sleep
Task
Options
Sleep
Task
Result
Smelt
Task
Options
Smelt
Task
Result
Soul
Fire
Action
Error
Soul
Fire
Admin
Soul
Fire
Behavior
Error
Soul
Fire
Bot
Soul
Fire
Bot
Control
Lease
Soul
Fire
Camera
Soul
Fire
Capability
Error
Soul
Fire
Chat
Soul
Fire
Client
Soul
Fire
Compatibility
Error
Soul
Fire
Connection
Error
Soul
Fire
Container
Soul
Fire
Container
Closed
Error
Soul
Fire
Extension
Soul
Fire
Extension
Type
Id
Soul
Fire
Fleet
Soul
Fire
Fleet
Task
Group
Soul
Fire
Install
Error
Soul
Fire
Install
Options
Soul
Fire
Instance
Soul
Fire
Inventory
Soul
Fire
Operation
Error
Soul
Fire
Options
Soul
Fire
Pathfinder
Soul
Fire
Plugin
Compatibility
Error
Soul
Fire
Plugin
Descriptor
Error
Soul
Fire
Plugin
Error
Soul
Fire
Plugin
Module
Soul
Fire
Plugin
Not
Found
Error
Soul
Fire
Protocol
Soul
Fire
Recipes
Soul
Fire
Registry
Soul
Fire
Rpc
Error
Soul
Fire
Service
Soul
Fire
State
Error
Soul
Fire
Task
Soul
Fire
Task
Error
Soul
Fire
Task
Failed
Soul
Fire
Tasks
Soul
Fire
Timeout
Error
Soul
Fire
Validation
Error
Soul
Fire
World
Sphere
Region
Tab
Complete
Options
Task
List
Options
Task
Start
Options
Text
Component
timeout
Title
Event
Kind
Token
Provider
Typed
Plugin
Event
until
Until
Options
User
Plugin
Permission
Grant
Vec3
Villager
Trade
Task
Options
Villager
Trade
Task
Result
Wait
For
Chat
Options
Wait
For
Chunks
Response
Watch
Bot
Statuses
Response
Watch
Chat
Options
Watch
Packets
Options
Watch
Plugin
Event
Options
World
Map
Options
World
Position
World
Target
Guides
Python API
GitHub
SoulFire TypeScript SDK 2.10.3
Loading...