Interface Haulable

The public surface added by HaulableMixin.

interface Haulable {
    getDraftFactor(): number;
    getDraftLoad(): Quantity<"kg">;
    getHandedness(): number;
    getHauledBy(): Stuff & Hauler | null;
    getPassageMode(): LocomotionMode | null;
    setDraftFactor(value: number): void;
    setHandedness(value: number): void;
    setHauledBy(hauler: Stuff & Hauler | null): void;
    setPassageMode(value: string): void;
}

Index

Methods

getDraftFactor getDraftLoad getHandedness getHauledBy getPassageMode setDraftFactor setHandedness setHauledBy setPassageMode

Methods

getDraftFactor

getDraftFactor(): number
Returns number
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:88

getDraftLoad

getDraftLoad(): Quantity<"kg">
Effective-kg draft a hauler bears while pulling this cart.

Returns Quantity<"kg">
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:96

getHandedness

getHandedness(): number
Returns number
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:90

getHauledBy

getHauledBy(): Stuff & Hauler | null
The hauler currently hitched to this cart (R2.3 self-heal).

Returns Stuff & Hauler | null
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:98

getPassageMode

getPassageMode(): LocomotionMode | null
Locomotion mode the cart's passage needs (default wheeled).

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

setDraftFactor

setDraftFactor(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:89

setHandedness

setHandedness(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:91

setHauledBy

setHauledBy(hauler: Stuff & Hauler | null): void
Pairing setter (haulage-family internal — keep both sides in sync).
Parameters
- hauler: Stuff & Hauler | null
Returns void
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:100

setPassageMode

setPassageMode(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/server/src/mud/lib/slot/Haulable.ts:94