Class ConfigKeys

java.lang.Object
io.github.theword.queqiao.core.config.ConfigKeys

public final class ConfigKeys extends Object
核心配置项声明

这里是全部配置的唯一来源:路径、类型、默认值、校验、注释都在此声明。

路径与默认值必须与既有 config.yml 完全兼容: 不重命名字段、不改变嵌套结构、不改变默认值。

Since:
0.6.12
  • Field Details

    • ENABLE

      public static final ConfigKey<Boolean> ENABLE
    • DEBUG

      public static final ConfigKey<Boolean> DEBUG
    • SERVER_NAME

      public static final ConfigKey<String> SERVER_NAME
    • ACCESS_TOKEN

      public static final ConfigKey<String> ACCESS_TOKEN
    • MESSAGE_PREFIX

      public static final ConfigKey<String> MESSAGE_PREFIX
    • ENABLE_TRANSLATION

      public static final ConfigKey<Boolean> ENABLE_TRANSLATION
    • IGNORED_COMMANDS

      public static final ConfigKey<List<String>> IGNORED_COMMANDS
    • MANDATORY_IGNORED_COMMANDS

      public static final Set<String> MANDATORY_IGNORED_COMMANDS
      强制忽略的命令

      注册与登录命令不允许被用户配置放开——避免玩家凭据进入事件流。 它们与用户配置取并集,因此不是 IGNORED_COMMANDS 的默认值 (默认值仍为空列表,与既有模板一致)。

  • Method Details

    • effectiveIgnoredCommands

      public static Set<String> effectiveIgnoredCommands(Config runtime)
      生效的忽略命令集合 = 强制项 ∪ 用户配置

      这是既有行为的等价实现:此前 Config.loadIgnoredCommands 会把用户列表与 内置强制项合并。规则集中在这里,消费方(如 Tool)直接使用本方法。

      Parameters:
      runtime - 运行时值存储
      Returns:
      生效集合
    • all

      public static List<ConfigKey<?>> all()
      全部核心配置项(按 YAML 中的自然顺序)
      Returns:
      配置项列表
    • sections

      public static List<ConfigSectionNode> sections()
      区块的注释与排版(供 Writer 生成带注释的 YAML)

      注意:ignored_commands 是配置项而非区块,它的注释声明在 IGNORED_COMMANDS 上。

      Returns:
      区块列表
    • registerAll

      public static void registerAll(ConfigRegistry registry)
      把全部核心配置项与区块注册到 Registry
      Parameters:
      registry - 注册中心