Skip to main content

Interface: InventoryLease

Recoverable ownership of one player's temporary inventory replacement.

Properties​

id​

readonly id: string

Stable lease identifier.

isActive​

readonly isActive: boolean

Whether the temporary loadout is currently active.

playerId​

readonly playerId: string

UUID of the player whose inventory is leased.

snapshot​

readonly snapshot: InventorySnapshot

Original state that will be restored.

state​

readonly state: InventoryLeaseState

Current lease lifecycle state.

unloadPolicy​

readonly unloadPolicy: InventoryLeaseUnloadPolicy

Requested unload behaviour.

Methods​

discard()​

discard(): void

Keeps the current loadout and closes the lease without restoration.

Returns​

void

restore()​

restore(): void

Restores the original state and closes the lease.

Returns​

void