SoulFireInstance
Public TypeScript members of SoulFireInstance.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.
fleet
get fleet(): SoulFireFleetbot
bot(botId: string): SoulFireBotinfo
info(
options?: CallOptions,
): Effect.Effect<InstanceInfo, SoulFireOperationError>delete
Deletes the instance and its data for good. Its bots are stopped first.
delete(
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>updateMetadata
updateMetadata(
request: InstanceScopedRequest<typeof InstanceUpdateMetaRequestSchema>,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>setConfigEntry
setConfigEntry(
request: InstanceScopedRequest<
typeof InstanceUpdateConfigEntryRequestSchema
>,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>addAccounts
addAccounts(
accounts: readonly MinecraftAccountProto[],
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>removeAccounts
removeAccounts(
profileIds: readonly string[],
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>addProxies
addProxies(
proxies: readonly ProxyProto[],
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>removeProxies
removeProxies(
addresses: readonly string[],
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>loginCredentials
loginCredentials(
request: InstanceScopedRequest<typeof CredentialsAuthRequestSchema>,
options?: CallOptions,
): Stream.Stream<CredentialsAuthResponse, SoulFireOperationError>loginDeviceCode
loginDeviceCode(
request: InstanceScopedRequest<typeof DeviceCodeAuthRequestSchema>,
options?: CallOptions,
): Stream.Stream<DeviceCodeAuthResponse, SoulFireOperationError>refreshAccount
refreshAccount(
request: InstanceScopedRequest<typeof RefreshRequestSchema>,
options?: CallOptions,
): Effect.Effect<RefreshResponse, SoulFireOperationError>bots
Every bot of the instance, online or not. Online ones come with their live state, without the inventory.
bots(
options?: CallOptions,
): Effect.Effect<BotListEntry[], SoulFireOperationError>watchBotStatuses
A snapshot of every bot's desired and runtime state, then each change.
watchBotStatuses(
options?: CallOptions,
): Stream.Stream<WatchBotStatusesResponse, SoulFireOperationError>events
Watches one multiplexed event stream for the selected bots in this instance. The default filter includes every stateful event category while leaving high-volume sounds and particles opt-in.
events(
filter: MessageInitShape<
typeof InstanceEventFilterSchema
> = DEFAULT_INSTANCE_EVENT_FILTER,
options?: CallOptions,
): Stream.Stream<InstanceEvent, SoulFireOperationError>start
Marks bots to run; they connect in the background. selection defaults to
every bot not marked to run.
start(
selection?: BotSelection,
options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>stop
Marks bots as stopped; they disconnect in the background. selection
defaults to every bot marked to run.
stop(
selection?: BotSelection,
options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>restart
Gives bots a fresh connection. selection defaults to every bot marked to
run.
restart(
selection?: BotSelection,
options?: CallOptions,
): Effect.Effect<BotStatus[], SoulFireOperationError>How is this page?
Last updated on