Class Disposition

The disposition roster + lookups. A static-method value-object (no instances) — the axis IS its key.

Index

Constructors

Methods

all axisFor isAxis poleLabel

Constructors

constructor

new Disposition(): Disposition
Returns Disposition

Methods

`Static`all

all(): readonly DispositionAxis[]
The full roster (roster order).

Returns readonly DispositionAxis[]
- Defined in packages/server/src/mud/lib/trait/Disposition.ts:106

`Static`axisFor

axisFor(key: string): DispositionAxis | null
The axis for a key, or null if unrecognized.
Parameters
- key: string
Returns DispositionAxis | null
- Defined in packages/server/src/mud/lib/trait/Disposition.ts:85

`Static`isAxis

isAxis(value: unknown): value is string
Whether a value is a recognized axis key.
Parameters
- value: unknown
Returns value is string
- Defined in packages/server/src/mud/lib/trait/Disposition.ts:90

`Static`poleLabel

poleLabel(key: string, sign: number): string
The pole label an axis presents for a signed position: the positive pole for sign >= 0, the negative pole otherwise. Returns the bare key for an unrecognized axis (defensive — should not occur).
Parameters
- key: string
- sign: number
Returns string
- Defined in packages/server/src/mud/lib/trait/Disposition.ts:99