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

      Parameters

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

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

          • ...args: any[]

          Returns __type

      • _mixinName: string
      • commandContributions: CommandContributions

        Player-facing commands contributed via the self slot.

      • persistentFields: string[]

        Hydrator round-trips both cwds. They are operational state but persist across logins so the avatar's session resumes where it left off.

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

        Workspace-tier settings. workspace.editor and workspace.pageSize are declared in v1 even though only pageSize is consumed (by the cat controller's soft cap); editor ships as a stub so future external-editor handoff can read the player's preference without a schema migration.

        workspace.tree is the default-tree selector — content, source, or mirror. Per-command -c / -s flags override the default for that invocation.

      • syntheticVars: SyntheticVarEntry[]

        Synthetic shell vars. Read-only — var set PWD foo is rejected by EnvironmentMixin.setVar because the ShellApi resolution order picks synthetic vars first.