For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/module-loader/classes/ConfigManager.md.
  • English
  • Class: ConfigManager

    Defined in: module-loader/internal/config-manager.ts:75

    BP 启动时一次性拉取并缓存的平台配置(无热重载)。

    Constructors

    Constructor

    new ConfigManager(): ConfigManager;

    Returns

    ConfigManager

    Methods

    bindDataAdapter()

    static bindDataAdapter(adapter: DataAdapter): void;

    Defined in: module-loader/internal/config-manager.ts:96

    由 installHostBootstrap 调用,注入 db-server 数据适配器。

    Parameters

    ParameterType
    adapterDataAdapter

    Returns

    void


    init()

    static init(): Promise<void>;

    Defined in: module-loader/internal/config-manager.ts:104

    初始化:健康检查 → 拉全量配置 → 设置 auth token → 标记 ready。 拉取/解析失败时抛错且不置 ready,允许后续重试。

    Returns

    Promise<void>


    isReady()

    static isReady(): boolean;

    Defined in: module-loader/internal/config-manager.ts:118

    配置是否已成功 init 并可读。

    Returns

    boolean


    resetForTesting()

    static resetForTesting(): void;

    Defined in: module-loader/internal/config-manager.ts:123

    测试沙箱复位(勿在 BDS 生产路径调用)。

    Returns

    void


    isEnabled()

    static isEnabled(module: string): boolean;

    Defined in: module-loader/internal/config-manager.ts:133

    模块是否启用。key 可为 catalog id(feature-afk)或 configKey(afk); populate 时按 catalog id 与 configKey 双写索引。

    Parameters

    ParameterType
    modulestring

    Returns

    boolean


    getModuleToken()

    static getModuleToken(moduleId: string): string;

    Defined in: module-loader/internal/config-manager.ts:139

    取模块 HMAC token(来自 configs/all.module_tokens)。

    Parameters

    ParameterType
    moduleIdstring

    Returns

    string


    getModuleConfigKey()

    static getModuleConfigKey(moduleId: string): string;

    Defined in: module-loader/internal/config-manager.ts:144

    取模块 configKey;无则空串。

    Parameters

    ParameterType
    moduleIdstring

    Returns

    string


    getSetting()

    static getSetting<T>(key: string, defaultVal?: T): T;

    Defined in: module-loader/internal/config-manager.ts:149

    读 settings 键;缺失时返回 defaultVal。

    Type Parameters

    Type Parameter
    T

    Parameters

    ParameterType
    keystring
    defaultVal?T

    Returns

    T


    getPermissions()

    static getPermissions(): Record<string, number>;

    Defined in: module-loader/internal/config-manager.ts:155

    取玩家权限覆盖表副本。

    Returns

    Record<string, number>


    loadAll()

    static loadAll(): Promise<boolean>;

    Defined in: module-loader/internal/config-manager.ts:163

    从 db-server 拉取全量配置并填充缓存。

    Returns

    Promise<boolean>

    是否成功写入缓存;失败时保留既有缓存不动。