Interface Enablement

interface Enablement {
    canBeEngagedBy(actor: Stuff): boolean;
    canEngageAxis(direction: string): boolean;
    getAxes(): readonly string[];
    getDifficulty(): number | null;
    setAxes(value: string[]): void;
    setDifficulty(value: number | null): void;
}

Hierarchy (View Summary)

Enablement

Index

Methods

canBeEngagedBy canEngageAxis getAxes getDifficulty setAxes setDifficulty

Methods

canBeEngagedBy

canBeEngagedBy(actor: Stuff): boolean
True if the actor has enough capability for this scope's difficulty.
Parameters
- actor: Stuff
Returns boolean
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:29

canEngageAxis

canEngageAxis(direction: string): boolean
True if this host enables the mode in the given direction.
Parameters
- direction: string
Returns boolean
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:24

getAxes

getAxes(): readonly string[]
Direction tokens this host enables. '*' means any direction.

Returns readonly string[]
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:21

getDifficulty

getDifficulty(): number | null
RPG-mechanical difficulty; null means "any capability passes".

Returns number | null
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:26

setAxes

setAxes(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:22

setDifficulty

setDifficulty(value: number | null): void
Parameters
- value: number | null
Returns void
- Defined in packages/server/src/mud/lib/locomotion/Enablement.ts:27