Saxonberg Server API
    Preparing search index...

    Interface Mobile

    Public shape provided by MobileMixin.

    Witness hooks (optional methods) — fire from Mobile.traverse around the inner ContainmentApi.move. The Containable/Container hooks fire from inside that move; the traversal hooks here add the exit-aware layer on top.

    interface Mobile {
        announceArrival(to: Stuff & Container, exit?: default): void;
        announceDeparture(from: Stuff & Container, exit?: default): void;
        autoIntroduceOnArrival(): void;
        autoSenseOnArrival(): Promise<void>;
        canTraverse?(via: default): VetoResult;
        getEngagedMode(): LocomotionMode | null;
        isEngagedIn(mode: string | LocomotionMode): boolean;
        onSlotReleased(host: Stuff & Slotted, slotName: string): void;
        onTraversed?(via: default): void;
        setEngagedMode(mode: LocomotionMode | null): void;
        teleport(destination: Stuff & Container, opts?: TeleportOptions): void;
        traverse(exit: default, mode: string): Promise<void>;
    }
    Index

    Methods

    announceArrival announceDeparture autoIntroduceOnArrival autoSenseOnArrival canTraverse? getEngagedMode isEngagedIn onSlotReleased onTraversed? setEngagedMode teleport traverse

    Methods

    • Fire look on this mover as a forced command. Used by the traversal pipeline (after a successful move) and by the goto verb's raw-move fallback (-l flag re-fires this when Mobile.teleport's polished path was bypassed). No-op for movers that aren't CommandGivers — scripted NPCs can move without auto-sensing. Errors are swallowed: a flaky sense shouldn't fail the movement.

      Switched from look to sense by the senses build so the mover perceives the new room across every channel they possess (vision, hearing, smell, touch, taste) without typing five commands. Vision-only rooms render identically because the augmenter's filter ∩ sensorium = vision for any room with no <sense> regions authored.

      Returns Promise<void>

    • Resolve the actor's currently-engaged LocomotionMode (the persisted singleton-by-path). null when the actor is not engaged in any mode. The backing storage is _engagedModePath: string | null — a runtime-only field (NOT in persistentFields); a fresh actor / a reloaded actor wakes up unengaged.

      Returns LocomotionMode | null

    • Witness invoked by Slotted.vacate when this actor releases occupancy on host's slot. v1: clears engagedMode when the mode is passthrough and the vacated host composes the mode's conveyanceMixin. A dismounting rider's engagement clears automatically without any controller-side bookkeeping.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods