Interface Reserved

interface Reserved {
    reserves: Record<string, ReserveStored>;
    adjustReserve(key: string, delta: Quantity<Unit>): void;
    getReserve(key: string): Reserve | undefined;
    getReserves(): ReadonlyMap<string, Reserve>;
    hasReserve(key: string): boolean;
    installBiologicalReserves(): void;
    removeReserve(key: string): boolean;
    setReserve(reserve: Reserve): void;
}

Index

Properties

Methods

adjustReserve getReserve getReserves hasReserve installBiologicalReserves removeReserve setReserve

Properties

reserves

reserves: Record<string, ReserveStored>

Storage — public for the Hydrator.

Methods

adjustReserve

adjustReserve(key: string, delta: Quantity<Unit>): void
Move current by delta, clamped to [0, capacity].
Parameters
- key: string
- delta: Quantity<Unit>
Returns void
- Defined in packages/server/src/mud/lib/reserve.ts:130

getReserve

getReserve(key: string): Reserve | undefined
Parameters
- key: string
Returns Reserve | undefined
- Defined in packages/server/src/mud/lib/reserve.ts:125

getReserves

getReserves(): ReadonlyMap<string, Reserve>
Returns ReadonlyMap<string, Reserve>
- Defined in packages/server/src/mud/lib/reserve.ts:126

hasReserve

hasReserve(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in packages/server/src/mud/lib/reserve.ts:131

installBiologicalReserves

installBiologicalReserves(): void
Install the default biological reserves if absent (idempotent).

Returns void
- Defined in packages/server/src/mud/lib/reserve.ts:134

removeReserve

removeReserve(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in packages/server/src/mud/lib/reserve.ts:132

setReserve

setReserve(reserve: Reserve): void
Add or replace a reserve (key derives from the value).
Parameters
- reserve: Reserve
Returns void
- Defined in packages/server/src/mud/lib/reserve.ts:128