(client) chore:修改定义名称，添加后缀以区分运行时
This commit is contained in:
m0_75251201
90
Docs/DefineType/DrawingOrderDef.md
Normal file
90
Docs/DefineType/DrawingOrderDef.md
Normal file
@ -0,0 +1,90 @@
|
||||
# DrawingOrderDef使用文档
|
||||
|
||||
---
|
||||
|
||||
## 1. 基本概念
|
||||
|
||||
### 1.1 DrawingOrderDef
|
||||
`DrawingOrderDef` 是用于定义游戏对象树形结构的根节点。它表示整个渲染层级的入口点。
|
||||
|
||||
### 1.2 defName
|
||||
`defName` 是 `DrawingOrderDef` 的子节点，用于指定当前渲染层级结构的唯一引用名称。这个名称可以在其他地方（如脚本或配置文件）中被引用。
|
||||
|
||||
### 1.3 DrawNodeDef
|
||||
`DrawNodeDef` 是定义渲染层级中的节点元素。每个 `DrawNodeDef` 可以包含子节点，形成树形结构。其属性包括：
|
||||
- **name**：节点的名称，用于标识该节点。
|
||||
- **type**：可选属性，用于指定节点的类型。目前支持的类型有：
|
||||
- `image`：表示一个静态图像。
|
||||
- `animation`：表示一个动画序列。
|
||||
|
||||
---
|
||||
|
||||
## 2. 示例解析
|
||||
|
||||
以下是一个完整的 XML 示例及其解析：
|
||||
|
||||
```xml
|
||||
<DrawingOrderDef>
|
||||
<defName>CatGirl</defName>
|
||||
<DrawNodeDef name="body">
|
||||
<DrawNodeDef name="head">
|
||||
<DrawNodeDef name="backHair"/>
|
||||
<DrawNodeDef name="ear"/>
|
||||
<DrawNodeDef name="face"/>
|
||||
<DrawNodeDef name="frontHair"/>
|
||||
<DrawNodeDef name="hat"/>
|
||||
</DrawNodeDef>
|
||||
<DrawNodeDef name="clothes"/>
|
||||
</DrawNodeDef>
|
||||
</DrawingOrderDef>
|
||||
```
|
||||
|
||||
### 2.1 结构说明
|
||||
1. **根节点**：`DrawingOrderDef` 表示此角色的渲染树
|
||||
2. **唯一标识**：`defName` 节点指定了当前渲染层级结构的名称为 `CatGirl`。
|
||||
3. **渲染层级**：
|
||||
- `body` 是顶层节点，表示角色的身体部分。
|
||||
- `head` 是 `body` 的子节点，表示头部。
|
||||
- `backHair`、`ear`、`face`、`frontHair` 和 `hat` 是 `head` 的子节点，分别表示后发、耳朵、脸部、前发和帽子。
|
||||
- `clothes` 是 `body` 的另一个子节点，表示角色的衣服。
|
||||
|
||||
### 2.2 渲染顺序
|
||||
在渲染时，系统会按照 XML 中定义的树形结构依次绘制每个节点。例如，在上述例子中，渲染顺序为：
|
||||
1. `body`
|
||||
- `head`
|
||||
- `backHair`
|
||||
- `ear`
|
||||
- `face`
|
||||
- `frontHair`
|
||||
- `hat`
|
||||
- `clothes`
|
||||
|
||||
这种顺序确保了层次分明的渲染效果，例如，头发和帽子会覆盖在脸部之上，衣服则位于身体外部。
|
||||
|
||||
---
|
||||
|
||||
## 3. 扩展功能
|
||||
|
||||
### 3.1 指定节点类型
|
||||
可以通过 `type` 属性为节点指定具体的类型。例如：
|
||||
|
||||
```xml
|
||||
<DrawNodeDef name="background" type="image"/>
|
||||
<DrawNodeDef name="walk" type="animation"/>
|
||||
```
|
||||
|
||||
- 如果 `type="image"`，则表示该节点是一个静态图像。
|
||||
- 如果 `type="animation"`，则表示该节点是一个动画序列。
|
||||
|
||||
默认为image
|
||||
|
||||
### 3.2 动态引用
|
||||
通过 `defName`，可以将定义好的渲染层级结构动态引用到其他地方。例如，如果某个脚本需要加载 `CatGirl` 的渲染结构，可以直接通过 `defName` 引用。
|
||||
|
||||
---
|
||||
|
||||
## 4. 注意事项
|
||||
|
||||
1. **节点命名唯一性**：在同一层级中，节点的 `name` 属性应保持唯一，以避免冲突。
|
||||
2. **类型匹配**：如果指定了 `type` 属性，确保实际内容与类型一致（如 `image` 对应静态图片资源，`animation` 对应动画资源）。
|
||||
3. **嵌套深度**：虽然理论上可以无限嵌套，但建议控制嵌套深度，以提高性能和可维护性。
|
||||
@ -57,38 +57,38 @@ XML 文件根据根属性名分为三种类型：
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Define>
|
||||
<Attributes>
|
||||
<AttributesDef>
|
||||
<defName>CatGirl</defName>
|
||||
<health>100</health>
|
||||
<speed>1.2</speed>
|
||||
<strength>5</strength>
|
||||
</Attributes>
|
||||
</AttributesDef>
|
||||
|
||||
<Character>
|
||||
<CharacterDef>
|
||||
<defName>CatGirl</defName>
|
||||
<label>CatGirl</label>
|
||||
<description>She is a cat girl with agile movements and sharp senses.</description>
|
||||
<attributes>CatGirl</attributes> <!-- 引用 Attributes 类型的数据块 -->
|
||||
<attributes>CatGirl</attributes> <!-- 引用 AttributesDef 类型的数据块 -->
|
||||
|
||||
<drawingOrder_down>CatGirl_down</drawingOrder_down> <!-- 引用 DrawingOrder 类型的数据块 -->
|
||||
<drawingOrder_down>CatGirl_down</drawingOrder_down> <!-- 引用 DrawingOrderDef 类型的数据块 -->
|
||||
<drawingOrder_left>CatGirl_left</drawingOrder_left>
|
||||
<drawingOrder_right>CatGirl_right</drawingOrder_right>
|
||||
<drawingOrder_up>CatGirl_up</drawingOrder_up>
|
||||
</Character>
|
||||
</CharacterDef>
|
||||
|
||||
<DrawingOrder>
|
||||
<DrawingOrderDef>
|
||||
<defName>CatGirl_down</defName>
|
||||
<DrawNode name="body">
|
||||
<DrawNode name="head">
|
||||
<DrawNode name="backHair"/>
|
||||
<DrawNode name="ear"/>
|
||||
<DrawNode name="face"/>
|
||||
<DrawNode name="frontHair"/>
|
||||
<DrawNode name="hat"/>
|
||||
</DrawNode>
|
||||
<DrawNode name="clothes"/>
|
||||
</DrawNode>
|
||||
</DrawingOrder>
|
||||
<DrawNodeDef name="body">
|
||||
<DrawNodeDef name="head">
|
||||
<DrawNodeDef name="backHair"/>
|
||||
<DrawNodeDef name="ear"/>
|
||||
<DrawNodeDef name="face"/>
|
||||
<DrawNodeDef name="frontHair"/>
|
||||
<DrawNodeDef name="hat"/>
|
||||
</DrawNodeDef>
|
||||
<DrawNodeDef name="clothes"/>
|
||||
</DrawNodeDef>
|
||||
</DrawingOrderDef>
|
||||
</Define>
|
||||
```
|
||||
|
||||
@ -151,7 +151,7 @@ XML 文件根据根属性名分为三种类型：
|
||||
```
|
||||
例如：
|
||||
```
|
||||
Character.CatGirl.label
|
||||
CharacterDef.CatGirl.label
|
||||
```
|
||||
|
||||
#### 5.3 示例解析
|
||||
@ -160,8 +160,8 @@ Character.CatGirl.label
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Translation>
|
||||
<Character.CatGirl.label>猫娘</Character.CatGirl.label>
|
||||
<Character.CatGirl.description>她是一个猫娘，拥有猫的特性和人类的智慧。她的耳朵和尾巴显示了她的猫族血统。</Character.CatGirl.description>
|
||||
<CharacterDef.CatGirl.label>猫娘</CharacterDef.CatGirl.label>
|
||||
<CharacterDef.CatGirl.description>她是一个猫娘，拥有猫的特性和人类的智慧。她的耳朵和尾巴显示了她的猫族血统。</CharacterDef.CatGirl.description>
|
||||
</Translation>
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user