Update schema description

EaseCation · Feb 4, 2024 · d9c439c · d9c439c
1 parent 5d2e8d1
commit d9c439c
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 3 deletions.
diff --git a/ecnpc/container.schema.json b/ecnpc/container.schema.json
@@ -2,6 +2,7 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/ecnpc/container.schema.json",
     "title": "ECNPCContainer schema",
+    "description": "ECNPC对象容器，用于定义一组ECNPC相关的Dialogue、Hook、Skin以及一组相关的NPC预制实体，对象容器内的NPC预制实体可以根据npcTag进行过滤，统一被生成、管理",
     "type": "object",
     "properties": {
         "reference": {

diff --git a/ecnpc/dialogue.handler.schema.json b/ecnpc/dialogue.handler.schema.json
@@ -2,8 +2,8 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/ecnpc/dialogue.handler.schema.json",
     "title": "ECNPC dialogue handler schema",
+    "description": "ECNPC交互对话处理器，用于玩家在NPC交互点击按钮后继续进行对话或者执行其他操作",
     "type": "object",
-    "description": "对话的handler配置",
     "properties": {
         "type": {
             "type": "string",

diff --git a/ecnpc/dialogue.schema.json b/ecnpc/dialogue.schema.json
@@ -2,6 +2,7 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/ecnpc/dialogue.schema.json",
     "title": "ECNPC dialogue schema",
+    "description": "ECNPC交互对话，用于实现游戏内打开对话框后NPC实体与玩家进行交互",
     "type": "object",
     "properties": {
         "type": {
@@ -82,6 +83,5 @@
             "description": "对话弹窗左侧的NPC模型的位置平移"
         }
     },
-    "additionalProperties": false,
-    "description": "dialogue的详细配置"
+    "additionalProperties": false
 }
diff --git a/ecnpc/hook.schema.json b/ecnpc/hook.schema.json
@@ -2,6 +2,7 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/ecnpc/hook.schema.json",
     "title": "ECNPC hook schema",
+    "description": "ECNPC行为钩子，用于定义NPC的特定行为和与玩家的交互",
     "type": "array",
     "items": {
         "oneOf": [

diff --git a/ecnpc/prefab.schema.json b/ecnpc/prefab.schema.json
@@ -2,9 +2,11 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/ecnpc/prefab.schema.json",
     "title": "ECNPC prefab schema",
+    "description": "ECNPC预制实体，游戏内NPC实体可以由预制实体作为模板来生成，一个预制实体可生成多个游戏内NPC实体",
     "type": "object",
     "properties": {
         "npcTag": {
+            "description": "指定NPC的皮肤（只有在type为human时生效）",
             "type": "string"
         },
         "pos": {

diff --git a/playeraction/playeraction.schema.json b/playeraction/playeraction.schema.json
@@ -2,6 +2,7 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://easecation.github.io/ECConfigSchema/playeraction/playeraction.schema.json",
     "title": "Player action schema",
+    "description": "玩家行为接口，用于对某一玩家执行游戏内、业务逻辑等相关的行为和操作",
     "type": "object",
     "oneOf": [
         {