SoulFire LogoSoulFire

SoulFireContainer

Public TypeScript members of SoulFireContainer.

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.

snapshot

get snapshot(): Readonly<ContainerSnapshot>

Source

closed

get closed(): boolean

Source

refresh

Throws SoulFireContainerClosedError if the container was closed in the meantime.

refresh(
  options?: CallOptions,
): Effect.Effect<ContainerSnapshot, SoulFireOperationError>

Source

deposit

Moves count items matching selector from the player's inventory into the container. Fails if fewer are available or they don't fit.

deposit(
  selector: InventoryRequest<typeof TransferItemsRequestSchema>["selector"],
  count: number,
  options: ContainerMutationOptions = {},
): Effect.Effect<ContainerSnapshot, SoulFireOperationError>

Source

withdraw

Moves count items matching selector from the container into the player's inventory. Fails if fewer are available or they don't fit.

withdraw(
  selector: InventoryRequest<typeof TransferItemsRequestSchema>["selector"],
  count: number,
  options: ContainerMutationOptions = {},
): Effect.Effect<ContainerSnapshot, SoulFireOperationError>

Source

close

close(
  options: ContainerMutationOptions = {},
): Effect.Effect<ContainerSnapshot, SoulFireOperationError>

Source

How is this page?

Last updated on

On this page