Class BulkSlot

constructor

• new BulkSlot(host: Stuff & Bulkable, affordance: BulkAffordance): BulkSlot

  Parameters

  • host: Stuff & Bulkable
  • affordance: BulkAffordance

  Returns BulkSlot

Readonlyaffordance

available

• available(): number

  Litres available to draw FROM this slot. Host policy (the base is the current amount; an inexhaustible source returns ∞).

  Returns number

debit

• debit(litres: number): void

  Debit litres from this slot. Host policy (the base subtracts and clears the material at zero; an inexhaustible source is a no-op).

  Parameters

  • litres: number

  Returns void

getAmount

• getAmount(): Quantity<"L">

  Current amount (always Quantity<'L'>; 0 L when empty).

  Returns Quantity<"L">

getCapacity

• getCapacity(): Quantity<"L"> | null

  Authored capacity, or null for an uncapped slot (a puddle).

  Returns Quantity<"L"> | null

getClosure

• getClosure(): ClosureLevel

  This slot's closure level (the holder's inherent construction).

  Returns ClosureLevel

getHolder

• getHolder(): Stuff & Bulkable

  The holder Stuff this slot belongs to.

  Returns Stuff & Bulkable

getMaterial

• getMaterial(): default | null

  Resolve the material singleton (null when empty / unresolved).

  Returns default | null

getMaterialPath

• getMaterialPath(): string | null

  Material-path ref (null ⇒ empty slot).

  Returns string | null

isEmpty

• isEmpty(): boolean

  Empty ⇔ no material, or a non-positive amount. Delegated to the host so a capability mixin can override the policy (an inexhaustible source is never empty — see UnboundedSource.ts).

  Returns boolean

remaining

• remaining(): number

  Litres of headroom remaining to pour INTO this slot. ∞ for an uncapped slot (a puddle); otherwise capacity − amount (floored at 0).

  Returns number

setAmount

• setAmount(amount: Quantity<"L">): void

  Overwrite the slot's amount (canonical-unit Quantity<'L'>).

  Parameters

  • amount: Quantity<"L">

  Returns void

setMaterial

• setMaterial(material: default | null): void

  Assign / clear the slot's material (writes the path on the host).

  Parameters

  • material: default | null

  Returns void