SDKReferenceSDK API
TypeScript options
Connection, session, and task options from the SDK source.
Generated from the SoulFire SDK source. Each signature links to the same source revision.
These tables include inherited fields. Path options use the generated PathfindOptionsSchema contract. See pathfinding for search modes and safety limits.
SoulFireOptions
| Field | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | |
token | string | TokenProvider | No | |
defaultTimeoutMs | number | No | |
fetch | GrpcWebTransportOptions["fetch"] | No | |
interceptors | Interceptor[] | No | |
requiredCapabilities | readonly string[] | No | |
requiredPlugins | readonly RequiredPluginRequirement[] | No | |
transport | Transport | No |
BotSessionOptions
| Field | Type | Required | Description |
|---|---|---|---|
filter | MessageInitShape<typeof BotEventFilterSchema> | No | Defaults to every category except sounds, particles and chunks. |
heartbeatIntervalSeconds | number | No | Defaults to 15, from 5 to 60. |
TaskStartOptions
| Field | Type | Required | Description |
|---|---|---|---|
call | CallOptions | No | |
deadline | Date | No | The task ends as TIMED_OUT at this time. Must be in the future. |
conflictPolicy | BotTaskConflictPolicy | No | |
reconnectPolicy | BotTaskReconnectPolicy | No | |
disconnectPolicy | BotTaskDisconnectPolicy | No | |
priority | BotTaskPriority | No | |
parentTaskId | string | undefined | No | |
causationId | string | undefined | No | |
idempotencyKey | string | undefined | No |
CollectBlocksTaskOptions
| Field | Type | Required | Description |
|---|---|---|---|
tags | readonly string[] | No | Block tags to match, besides blockIds. |
count | number | No | Defaults to 1. |
searchRadius | number | No | Defaults to 32, at most 64. |
avoidSubmergedTargets | boolean | No | Skips blocks with fluid above them, up to the bot's height. |
requireLineOfSight | boolean | No | Only picks blocks the bot can see, checked again after each block. |
targetYRange | Readonly<{ minimum?: number; maximum?: number; }> | No | Only blocks between these heights; a missing bound is open. |
path | MessageInitShape<typeof PathfindOptionsSchema> | No | |
call | CallOptions | No | |
deadline | Date | No | The task ends as TIMED_OUT at this time. Must be in the future. |
conflictPolicy | BotTaskConflictPolicy | No | |
reconnectPolicy | BotTaskReconnectPolicy | No | |
disconnectPolicy | BotTaskDisconnectPolicy | No | |
priority | BotTaskPriority | No | |
parentTaskId | string | undefined | No | |
causationId | string | undefined | No | |
idempotencyKey | string | undefined | No |
FollowEntityTaskOptions
| Field | Type | Required | Description |
|---|---|---|---|
path | MessageInitShape<typeof PathfindOptionsSchema> | No | |
targetUnavailableTimeoutSeconds | number | No | How long the entity may stay out of sight before the task ends. Defaults to 10, at most 3600. |
call | CallOptions | No | |
deadline | Date | No | The task ends as TIMED_OUT at this time. Must be in the future. |
conflictPolicy | BotTaskConflictPolicy | No | |
reconnectPolicy | BotTaskReconnectPolicy | No | |
disconnectPolicy | BotTaskDisconnectPolicy | No | |
priority | BotTaskPriority | No | |
parentTaskId | string | undefined | No | |
causationId | string | undefined | No | |
idempotencyKey | string | undefined | No |
How is this page?
Last updated on