Interface Hauler

The public surface added by HaulerMixin.

interface Hauler {
    getHaulDraft(): Quantity<"kg">;
    getHauledCart(): Stuff & Haulable | null;
    hitch(cart: Stuff & Haulable): void;
    isHitched(): boolean;
    unhitch(): void;
}

Index

Methods

getHaulDraft getHauledCart hitch isHitched unhitch

Methods

getHaulDraft

getHaulDraft(): Quantity<"kg">
Effective-kg draft this creature bears for its hitched cart (0 if none).

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

getHauledCart

getHauledCart(): Stuff & Haulable | null
The cart currently hitched (R2.3 self-heal), or null.

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

hitch

hitch(cart: Stuff & Haulable): void
Hitch a cart — becomes this creature's hauled cart (atomic pair).
Parameters
- cart: Stuff & Haulable
Returns void
- Defined in packages/server/src/mud/lib/slot/Hauler.ts:33

isHitched

isHitched(): boolean
Whether a cart is currently hitched.

Returns boolean
- Defined in packages/server/src/mud/lib/slot/Hauler.ts:31

unhitch

unhitch(): void
Release the hitched cart, if any (clears both sides).

Returns void
- Defined in packages/server/src/mud/lib/slot/Hauler.ts:35