Interface Respiration

interface Respiration {
    respirationClockStamp: number;
    exhale(): void;
    getBreathableMedia(): readonly string[];
    inhale(): void;
    isHoldingBreath(): boolean;
    isRespiring(): boolean;
    onTraversed(via: default): void;
    reassess(): Promise<void>;
    respirationDrainTick(drain: RespirationDrain): void;
    respirationRecoverTick(recovery: RespirationRecovery): void;
    setRespirationClockStamp(value: number): void;
}

Index

Properties

respirationClockStamp

Methods

exhale getBreathableMedia inhale isHoldingBreath isRespiring onTraversed reassess respirationDrainTick respirationRecoverTick setRespirationClockStamp

Properties

respirationClockStamp

respirationClockStamp: number

Game-time (seconds) of the last drain/recovery tick; 0 = unseeded.

Methods

exhale

exhale(): void
Let the held breath out — clear the grace.

Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:131

getBreathableMedia

getBreathableMedia(): readonly string[]
The species breathable set (default ['air']; water-breaters ['water']).

Returns readonly string[]
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:112

inhale

inhale(): void
Take and hold a breath — extend the breath-hold grace (free-diving).

Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:129

isHoldingBreath

isHoldingBreath(): boolean
Whether a voluntary/automatic breath-hold is currently active.

Returns boolean
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:116

isRespiring

isRespiring(): boolean
Whether this body respires at all (the respires opt-out).

Returns boolean
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:114

onTraversed

onTraversed(via: default): void
The traverse hook (the Mobile.onTraversed shape) — fires reassess on every move.
Parameters
- via: default
Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:121

reassess

reassess(): Promise<void>
The central event-driven re-resolve: engage/cancel the crisis drain.

Returns Promise<void>
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:119

respirationDrainTick

respirationDrainTick(drain: RespirationDrain): void
Emission body of the drain engagement (delegated from RespirationDrain).
Parameters
- drain: RespirationDrain
Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:124

respirationRecoverTick

respirationRecoverTick(recovery: RespirationRecovery): void
Emission body of the recovery engagement.
Parameters
- recovery: RespirationRecovery
Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:126

setRespirationClockStamp

setRespirationClockStamp(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/server/src/mud/lib/respiration/Respiration.ts:109