Skip to content
On this page
通用

KattonConfigApi

top.katton.apicommon/src/main/kotlin/top/katton/api/KattonConfigApi.kt
面向脚本的配置 API,会从当前脚本包的 manifest 里读取配置值。

KattonConfig

KattonConfig通用对象
kotlin
object KattonConfig

面向脚本的配置 API,会从当前脚本包的 manifest 里读取配置值。

脚本中的用法:

kotlin
import top.katton.api.*

val rate = config.getNumber("spawn_rate").toDouble()
val prefix = config.getString("message_prefix", "[Default]")
val debug = config.getBool("debug_mode")
val raw = config["some_key"]

每个脚本包都有自己独立的配置值,来自 manifest.json 里的 "config" 字段。 当前脚本包会根据脚本执行上下文自动识别。

KattonConfig.get

KattonConfig.get通用函数
kotlin
operator fun get(key: String): Any?

按键获取原始配置值。如果键不存在,或者当前脚本包无法解析,则返回 null。

KattonConfig.getString

KattonConfig.getString通用函数
kotlin
fun getString(key: String, default: String = ""): String

获取字符串配置值,可指定默认值。

KattonConfig.getNumber

KattonConfig.getNumber通用函数
kotlin
fun getNumber(key: String, default: Number = 0): Number

获取数值配置,可指定默认值。

KattonConfig.getBool

KattonConfig.getBool通用函数
kotlin
fun getBool(key: String, default: Boolean = false): Boolean

获取布尔配置值,可指定默认值。

KattonConfig.all

KattonConfig.all通用函数
kotlin
fun all(): Map<String, Any>

返回当前脚本包的全部配置项。

config

config通用属性
kotlin
val config: KattonConfig

简写访问器 - 在脚本中使用 config["key"]