Interface Drivable

interface Drivable {
    getControllerSlot(): string;
    getDriver(): Stuff & Slottable | null;
    getVehicularMode(): LocomotionMode | null;
    isDriven(): boolean;
    setControllerSlot(value: string): void;
    setVehicularMode(value: LocomotionMode | null): void;
}

Index

Methods

getControllerSlot getDriver getVehicularMode isDriven setControllerSlot setVehicularMode

Methods

getControllerSlot

getControllerSlot(): string
Returns string
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:44

getDriver

getDriver(): Stuff & Slottable | null
Returns Stuff & Slottable | null
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:43

getVehicularMode

getVehicularMode(): LocomotionMode | null
Vehicular LocomotionMode this conveyance engages when driven (e.g., wheeled for a cart, sailed for a rowboat). Authoring is required: LocomotionApi.resolveHostMode throws on a Drivable with null vehicularMode — surfacing the content-author bug rather than silently walk-traversing a wheeled vehicle. Stored as templatePath (ref-shapes Pattern A).

Returns LocomotionMode | null
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:54

isDriven

isDriven(): boolean
Returns boolean
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:42

setControllerSlot

setControllerSlot(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:45

setVehicularMode

setVehicularMode(value: LocomotionMode | null): void
Parameters
- value: LocomotionMode | null
Returns void
- Defined in packages/server/src/mud/lib/slot/Drivable.ts:55