配置 API

config 命名空间提供了读取和管理插件配置的功能。插件可以通过此API获取用户在界面上设置的配置项。

命名空间

declare namespace config { ... }

方法

getConfig

获取指定分组的配置数据（JSON字符串）。

function getConfig(groupId: string): string | null;

• 参数:
  • groupId: 配置分组ID
• 返回: 配置数据JSON字符串，如果没有启用的配置则返回null

getConfigObject

获取指定分组的配置数据（解析为JavaScript对象）。

function getConfigObject(groupId: string): any | null;

• 参数:
  • groupId: 配置分组ID
• 返回: 配置数据对象，如果没有启用的配置则返回null

getAllConfigs

获取所有启用的配置数据（按GroupId分组）。

function getAllConfigs(): { [groupId: string]: any };

• 返回: 包含所有配置分组的对象

hasConfig

检查指定分组是否有启用的配置。

function hasConfig(groupId: string): boolean;

• 参数:
  • groupId: 配置分组ID
• 返回: 如果有启用的配置返回true，否则返回false

getConfigValue

获取配置值（支持点号分隔的路径）。

function getConfigValue(groupId: string, path: string, defaultValue?: any): any;

• 参数:
  • groupId: 配置分组ID
  • path: 配置路径，使用点号分隔 (例如 "game.settings.volume")
  • defaultValue: 默认值，如果配置不存在则返回此值
• 返回: 配置值或默认值

getString

获取字符串类型的配置值。

function getString(groupId: string, path: string, defaultValue?: string): string;

getNumber

获取数字类型的配置值。

function getNumber(groupId: string, path: string, defaultValue?: number): number;

getInt

获取整数类型的配置值。

function getInt(groupId: string, path: string, defaultValue?: number): number;

getBoolean

获取布尔类型的配置值。

function getBoolean(groupId: string, path: string, defaultValue?: boolean): boolean;

getArray

获取数组类型的配置值。

function getArray(groupId: string, path: string): any[];