TypedDict: InventoryLeaseOptions

Options for a temporary inventory replacement lease.

class InventoryLeaseOptions(TypedDict)

Related API: InventoryLeaseUnloadPolicy

Properties

include_equipment: NotRequired[bool]

Capture equipment slots in addition to the main inventory.

include_selected_slot: NotRequired[bool]

Capture the player's selected hotbar slot.

clear: NotRequired[bool]

Clear unspecified slots before applying the temporary loadout.

unload_policy: NotRequired[Optional[InventoryLeaseUnloadPolicy]]

Restore automatically on unload, or retain the lease for later recovery.

Related API: InventoryLeaseUnloadPolicy