SoulFireInventory
Public Python members of SoulFireInventory.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.
snapshot
@fn("SoulFireInventory.snapshot")
def snapshot(
self, *, timeout_ms: int | None = None
) -> EffectGen[ContainerSnapshot, SoulFireOperationError]count
@fn("SoulFireInventory.count")
def count(
self,
selector: ItemSelector,
*,
areas: Iterable[InventoryArea] = (),
timeout_ms: int | None = None,
) -> EffectGen[int, SoulFireOperationError]find
@fn("SoulFireInventory.find")
def find(
self,
selector: ItemSelector,
*,
areas: Iterable[InventoryArea] = (),
timeout_ms: int | None = None,
) -> EffectGen[FindInventorySlotsResponse, SoulFireOperationError]rank
@fn("SoulFireInventory.rank")
def rank(
self,
kind: InventoryRecommendationKind,
*,
selector: ItemSelector | None = None,
areas: Iterable[InventoryArea] = (),
target_block: BlockPosition | None = None,
equipment_slot: str | None = None,
limit: int = 10,
prefer_hotbar: bool = False,
preferred_enchantment_ids: Iterable[str] = (),
excluded_enchantment_ids: Iterable[str] = (),
prefer_high_durability: bool = False,
timeout_ms: int | None = None,
) -> EffectGen[RankInventoryItemsResponse, SoulFireOperationError]best_tool
@fn("SoulFireInventory.best_tool")
def best_tool(
self, target_block: BlockPosition, **options: Unpack[InventoryRankingOptions]
) -> EffectGen[InventoryItemRecommendation | None, SoulFireOperationError]best_weapon
@fn("SoulFireInventory.best_weapon")
def best_weapon(
self, **options: Unpack[InventoryRankingOptions]
) -> EffectGen[InventoryItemRecommendation | None, SoulFireOperationError]best_armor
@fn("SoulFireInventory.best_armor")
def best_armor(
self, equipment_slot: str, **options: Unpack[InventoryRankingOptions]
) -> EffectGen[InventoryItemRecommendation | None, SoulFireOperationError]best_food
@fn("SoulFireInventory.best_food")
def best_food(
self, **options: Unpack[InventoryRankingOptions]
) -> EffectGen[InventoryItemRecommendation | None, SoulFireOperationError]best_scaffold
@fn("SoulFireInventory.best_scaffold")
def best_scaffold(
self, **options: Unpack[InventoryRankingOptions]
) -> EffectGen[InventoryItemRecommendation | None, SoulFireOperationError]move
@fn("SoulFireInventory.move")
def move(
self,
source_slot: int,
destination_slot: int,
*,
count: int | None = None,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]transfer
@fn("SoulFireInventory.transfer")
def transfer(
self,
selector: ItemSelector,
count: int,
*,
from_area: InventoryArea,
to_area: InventoryArea,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]toss
@fn("SoulFireInventory.toss")
def toss(
self,
selector: ItemSelector,
count: int,
*,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]select_hotbar
@fn("SoulFireInventory.select_hotbar")
def select_hotbar(
self,
*,
slot: int | None = None,
selector: ItemSelector | None = None,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]equip
@fn("SoulFireInventory.equip")
def equip(
self,
selector: ItemSelector,
equipment_slot: str,
*,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]unequip
@fn("SoulFireInventory.unequip")
def unequip(
self,
equipment_slot: str,
*,
destination_area: InventoryArea | None = None,
expected_revision: int = 0,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> EffectGen[InventoryMutationResponse, SoulFireOperationError]open
def open(
self,
position: BlockPosition,
*,
idempotency_key: str | None = None,
timeout_ms: int | None = None,
) -> Effect[SoulFireContainer, SoulFireOperationError, Scope]How is this page?
Last updated on
