ModuleConfig
Defined in: src/lib/module/index.ts:99
Module configuration options.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
dependencies? | string[] | Module dependencies (names of other modules that must start first). | src/lib/module/index.ts:108 |
huds? | FeatureRegistry | HUD features for persistent overlay elements (e.g., health bar, minimap). Keys are HUD element names, values are lazy imports to feature modules. Example huds: { status: () => import("@modules/needs/huds/status/feature"), } | src/lib/module/index.ts:136 |
name | string | Module name, used for RPC context generation and logging. | src/lib/module/index.ts:103 |
onStart? | (module: ModuleHandle) => void | Promise<void> | Called when the module starts, after all services are registered. Receives the module handle for accessing services. Can be async. | src/lib/module/index.ts:143 |
onStop? | (module: ModuleHandle) => void | Promise<void> | Called when the module stops, before services are unregistered. Receives the module handle for accessing services. Can be async. | src/lib/module/index.ts:150 |
pages? | FeatureRegistry | Page features for full-screen UI routes (e.g., ATM interface, inventory). Keys are route names, values are lazy imports to feature modules. Example pages: { "atm-interface": () => import("@modules/atm/pages/atm-interface/feature"), } | src/lib/module/index.ts:125 |
services? | ServiceClass<unknown>[] | Service classes to instantiate and register. Services with RPC decorators will have their handlers registered automatically. | src/lib/module/index.ts:114 |