跳到主要内容

描述文件设置

描述文件格式范例​

{
    "Name" : "测试Mod",
    "Author" : "佚名",
    "Version" : "1.0.0",
    "Description" : "测试用的Mod。",
    "Settings" : [ ... ]
}

描述文件字段表​

描述文件的总体字段结果如表： |字段名|类型|作用| | - | - | - | | Name | 字符串 String | Mod名称 | Author | 字符串 String | Mod作者 | Version | 字符串 String | Mod版本号 | Description | 字符串 String | Mod描述 | Settings | 数组 | Mod设置选项（可不填）

Mod设置选项​

Mod设置选项用于给玩家提供在进入游戏前的Mod设置

在描述文件的Settings数组中，填入选项数据，即可在Mod设置面板中出现对应设置。

设置选项通用字段​

字段名类型作用
Type字符串 String设置选项的类型
Key字符串 String设置选项的Key，用于决定获取值时的输入
Name字符串 String设置选项的名称
Description字符串 String设置选项的描述，在鼠标浮动到选项上时浮现。

设置选项类型​

设置选项对应的类型目前主要有四种，选项数值的获取可以参考 运行时脚本 中 GetXXXSetting 相关的方法。

类型使用方法默认值
布尔值 - Bool使用bool GetBoolSetting(string key)获取布尔值类型，结果为true或falsefalse
长整形 - Long使用int GetIntSetting(string key)或long GetLongSetting(string key)获取整形数值。

注：获取int类型的数值时，会将long强制转换为int。若数值过大或过小可能会发生溢出。		0
双浮点型 - Double使用float GetFloatSetting(string key)或double GetDoubleSetting(string key)获取整形数值。

注：获取float类型的数值时，会将double强制转换为float。若数值过大或过小可能会发生溢出。		0.0
字符串 - String使用string GetStringSetting(string key)获取字符串类型。""

单选框 - Toggle​

单选框用于设置Bool类型的值，结果为true（选中）或false（不选中）

类型​

布尔值 Bool

范例​

{
    "Type" : "Toggle",
    "Key" : "Bool_Key",
    "Name" : "单选设置",
    "Description" : "描述内容",
    "DefaultValue" : true
}

字段表​

字段名类型作用
DefaultValue布尔值 Bool默认值

整形输入框 - IntegerInput​

整形输入框用于设置Long类型的值

类型​

整形 Long

范例​

{
    "Type" : "IntegerInput",
    "Key" : "Int_Key1",
    "Name" : "整形输入",
    "Description" : "描述内容",
    "DefaultValue" : 0
}

字段表​

字段名类型作用
DefaultValue长整形 Long默认值

整形滑动条 - IntegerSlider​

整形用于设置具有上下限的Long类型数值

类型​

整形 Long

初始化​

在初始化时，若已经存在的数值超出了滑动条的上下限，那么数值将会被限制回上下限范围内

范例​

{
    "Type" : "IntegerSlider",
    "Key" : "Int_Key2",
    "Name" : "整形滑动条",
    "Description" : "描述内容",
    "MinValue" : 0,
    "MaxValue" : 100,
    "DefaultValue" : 10
}

字段表​

字段名类型作用
MinValue长整形 Long最小值
MaxValue长整形 Long最大值
DefaultValue长整形 Long默认值

浮点输入框 - FloatInput​

浮点输入框用于设置Double类型的值

类型​

双浮点 Double

范例​

{
    "Type" : "FloatInput",
    "Key" : "Float_Key1",
    "Name" : "浮点输入",
    "Description" : "描述内容",
    "DefaultValue" : 0.0
}

字段表​

字段名类型作用
DefaultValue双浮点 Double默认值

浮点滑动条 - FloatSlider​

浮点滑动条用于设置具有上下限的Double类型数值

类型​

双浮点 Double

初始化​

在初始化时，若已经存在的数值超出了滑动条的上下限，那么数值将会被限制回上下限范围内

范例​

{
    "Type" : "FloatSlider",
    "Key" : "Float_Key2",
    "Name" : "浮点滑动条",
    "Description" : "描述内容",
    "MinValue" : 0,
    "MaxValue" : 10,
    "DefaultValue" : 1.5
}

字段表​

字段名类型作用
MinValue双浮点 Double最小值
MaxValue双浮点 Double最大值
DefaultValue双浮点 Double默认值

字符串输入框 - StringInput​

浮点输入框用于设置Double类型的值

类型​

字符串 String

范例​

{
    "Type" : "StringInput",
    "Key" : "String_Key1",
    "Name" : "字符串输入",
    "Description" : "描述内容",
    "DefaultValue" : "初始文本"
}

字段表​

字段名类型作用
DefaultValue字符串 String默认值

下拉框 - Dropdown​

下拉框用于给与玩家几个固定选项用于选择，选择的值会存在整形数据里。

类型​

长整形 Long

初始化​

在初始化时，若储存的索引超出上限，那么将会把索引重设为初始值。

范例​

{
    "Type" : "Dropdown",
    "Key" : "Int_Index",
    "Name" : "下拉选项",
    "Description" : "描述内容",
    "Options" : [
        "[索引0]选项一",
        "[索引1]选项二",
        "[索引2]选项三",
        "[索引3]选项四"
    ],
    "DefaultValue" : 1
}

字段表​

字段名类型作用
Options字符串数组 String[]选项列表
DefaultValue长整形 Long默认索引