Skip to content

变量字段 JSON 格式

用于导入导出聊天设定中的变量字段定义列表。

顶层结构

json
{
  "version": 1,
  "stateFieldDefinitions": []
}
字段类型必填说明
versionnumber固定为 1
stateFieldDefinitionsarray变量字段定义数组

字段定义

stateFieldDefinitions 中每个元素的字段:

字段类型必填说明
idstring字段标识符
displayNamestring用户可见的显示名
typestring字段类型:text / number / boolean / enum
visibilitystring可见性:visible / hidden。默认 visible
descriptionstring字段描述
enumOptionsarray of stringenum 类型枚举选项列表
minValuenumbernumber 类型最小值
maxValuenumbernumber 类型最大值
defaultValueany默认值,类型须与 type 匹配

最小示例

json
{
  "version": 1,
  "stateFieldDefinitions": [
    {
      "id": "phase",
      "displayName": "当前阶段",
      "type": "enum",
      "visibility": "visible",
      "enumOptions": ["序章", "发展", "高潮", "尾声"],
      "defaultValue": "序章"
    }
  ]
}

完整示例

json
{
  "version": 1,
  "stateFieldDefinitions": [
    {
      "id": "phase",
      "displayName": "当前阶段",
      "type": "enum",
      "visibility": "visible",
      "description": "故事进展阶段",
      "enumOptions": ["序章", "发展", "高潮", "尾声"],
      "defaultValue": "序章"
    },
    {
      "id": "affection",
      "displayName": "好感度",
      "type": "number",
      "visibility": "visible",
      "description": "角色对玩家的好感度",
      "minValue": 0,
      "maxValue": 100,
      "defaultValue": 50
    },
    {
      "id": "is_angry",
      "displayName": "是否生气",
      "type": "boolean",
      "visibility": "hidden",
      "defaultValue": false
    },
    {
      "id": "location",
      "displayName": "当前位置",
      "type": "text",
      "visibility": "visible",
      "defaultValue": "教室"
    }
  ]
}

说明

  • visibility == visible 表示该变量可在会话设置等用户界面中显式看到。
  • visibility == hidden 表示该变量不在用户界面中显式展示,通常用于仅供规则或运行时读写的内部状态。