Saxonberg Server API
    Preparing search index...
    • Type Parameters

      Parameters

      Returns {
          _mixinName: string;
          commandContributions: CommandContributions;
          defaultAliases: DefaultAliasEntry[];
          prototype: __type<any>;
          settings: SettingsSchemaEntry<unknown>[];
          new (...args: any[]): __type;
      } & TBase

        • new (...args: any[]): __type
        • Parameters

          • ...args: any[]

          Returns __type

      • _mixinName: string
      • commandContributions: CommandContributions

        Commands the mover itself supplies — locomotion and door interaction. Anything with MobileMixin (Avatar today; NPCs, vehicles in future) automatically gains go, open, and close.

      • defaultAliases: DefaultAliasEntry[]

        Default aliases for the 10 canonical cardinal directions (NavigationApi.cardinalDirections()) plus their conventional single/double-letter abbreviations. Every entry expands to go <full-name>, which dispatches through GoController and resolves the actor's currently-engaged locomotion mode at run time — so n does the right thing whether the actor is walking, swimming, or climbing.

        Composed onto any host that also composes AliasMixin (the collector walks the mixin chain). Hosts without alias support pay no cost. Player-set aliases on the same name win.

        The cockpit's <exit> click emits the full go <dir> form for pedagogy; these aliases give keyboard users the short forms they expect from MUD muscle memory.

      • prototype: __type<any>
      • settings: SettingsSchemaEntry<unknown>[]

        Movement-message templates. Schema-defaulted; player-overridable via the settings command on Avatars (which compose EnvironmentMixin); NPCs render at the schema default through resolveSetting's non-Environment fallback. Liquid syntax — see docs/subsystems/prose.md.