7月31日同步更新

2025-07-31 17:53:14 +08:00
parent f5c6bdba2e
commit cf061270d3
799 changed files with 27437 additions and 494 deletions
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/实体对象EntityObject.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/实体对象EntityObject.md
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/实体预设EntityPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/实体预设EntityPreset.md
@@ -0,0 +1,50 @@
+---
+sidebarDepth: 1
+---
+# 实体预设EntityPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+PresetBase <|-- EntityPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+EntityObject <|-- EntityPreset
+link EntityObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E5%AE%9E%E4%BD%93%E5%AF%B9%E8%B1%A1EntityObject.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+EntityPreset: 实体预设
+EntityObject: 实体对象
+EntityObject: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+```
+
+- 描述
+
+    EntityPreset（实体预设）是一类特殊的预设，实体预设通常会绑定MC的某类实体，实体预设实例与MC的某一个实体绑定，因此可以使用实体预设来进行一些实体相关的逻辑的编程。如果玩家同时启用了多个AddOn，且这些AddOn中均包含与同一种MC原版实体绑定的实体预设，那么只会加载第一个这种实体预设。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | engineTypeStr | str | 实体的类型ID |
+    | entityId | str | 实体ID |
+    | updateTransformInterval | int | 实体预设子节点的变换更新间隔，0表示永不更新 |
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/文字面板对象TextboardObject.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/文字面板对象TextboardObject.md
@@ -0,0 +1,321 @@
+---
+sidebarDepth: 1
+---
+# 文字面板对象TextboardObject
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+SdkInterface <|-- TextboardObject
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TextboardObject: 文字面板对象
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+```
+
+- 描述
+
+    TextboardObject(文字面板对象)是对文字面板对象封装的基类，为文字面板提供了面向对象方法
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | textboardId | int | 关联文字面板ID |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [SetBindEntity](#setbindentity) | <span style="display:inline;color:#7575f9">客户端</span> | 文字面板绑定实体对象 |
+| [SetPos](#setpos) | <span style="display:inline;color:#7575f9">客户端</span> | 修改文字面板预设位置 |
+| [SetRot](#setrot) | <span style="display:inline;color:#7575f9">客户端</span> | 修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效 |
+| [SetScale](#setscale) | <span style="display:inline;color:#7575f9">客户端</span> | 内容整体缩放 |
+| [SetText](#settext) | <span style="display:inline;color:#7575f9">客户端</span> | 修改文字面板内容 |
+| [SetColor](#setcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 修改字体颜色 |
+| [SetBackgroundColor](#setbackgroundcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 修改背景颜色 |
+| [SetFaceCamera](#setfacecamera) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否始终朝向相机 |
+| [SetBoardDepthTest](#setboarddepthtest) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启深度测试, 默认状态下是开启 |
+
+
+
+
+## SetBindEntity
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    文字面板绑定实体对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | bindEntityId | str | 绑定entity的Id; 如果为None，则为取消实体绑定, 此时下面参数为世界坐标和旋转 |
+    | offset | tuple(float,float,float) | 相对于实体的偏移量 |
+    | rot | tuple(float,float,float) | 相对于实体的偏移角度 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetBindEntity(self.GetLocalPlayerId(), (0.0, 1.5, 0.0), (0.0, 0.0, 0.0))
+```
+
+
+
+## SetPos
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    修改文字面板预设位置
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | pos | tuple(float,float,float) | 坐标 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetPos((0.0, 3.0, 0.0))
+```
+
+
+
+## SetRot
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | rot | tuple(float,float,float) | 角度(不是弧度) |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetRot((45.0, 90.0, 0.0))
+```
+
+
+
+## SetScale
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    内容整体缩放
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | scale | tuple(float,float) | x,y方向上的缩放值,要求值大于0,正常状态下是(1.0,1.0) |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetScale((2.0, 2.0))
+```
+
+
+
+## SetText
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    修改文字面板内容
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | text | str | 文字内容 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 是否修改成功 |
+
+- 示例
+
+```python
+self.SetText("修改后的文字")
+```
+
+
+
+## SetColor
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    修改字体颜色
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | textColor | tuple(float,float,float,float) | 颜色的RGBA值，范围0-1 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetColor((1.0, 1.0, 0.0, 0.8))
+```
+
+
+
+## SetBackgroundColor
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    修改背景颜色
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | backgroundColor | tuple(float,float,float,float) | 颜色的RGBA值，范围0-1 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetBackgroundColor((1.0, 1.0, 1.0, 1.0))
+```
+
+
+
+## SetFaceCamera
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    设置是否始终朝向相机
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | faceCamera | bool | 是否始终朝向相机, 默认为True |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetFaceCamera(True)
+```
+
+
+
+## SetBoardDepthTest
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Textboard.TextboardObject.TextboardObject
+
+- 描述
+
+    设置是否开启深度测试, 默认状态下是开启
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | depthTest | bool | True为开启深度测试,False为不开启 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 返回是否设置成功 |
+
+- 示例
+
+```python
+self.SetBoardDepthTest(False)
+```
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/文字面板预设TextboardPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/文字面板预设TextboardPreset.md
@@ -0,0 +1,46 @@
+---
+sidebarDepth: 1
+---
+# 文字面板预设TextboardPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+PresetBase <|-- TextboardPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+TextboardObject <|-- TextboardPreset
+link TextboardObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E6%96%87%E5%AD%97%E9%9D%A2%E6%9D%BF%E5%AF%B9%E8%B1%A1TextboardObject.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+TextboardPreset: 文字面板预设
+TextboardObject: 文字面板对象
+TextboardObject: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+```
+
+- 描述
+
+    TextboardPreset（文字面板预设）与文字面板实体绑定，以面向对象的形式提供文字面板相关属性修改接口。
+
+- 成员变量
+
+    无
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/方块预设BlockPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/方块预设BlockPreset.md
@@ -0,0 +1,77 @@
+---
+sidebarDepth: 1
+---
+# 方块预设BlockPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+PresetBase <|-- BlockPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+BlockPreset: 方块预设
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+```
+
+- 描述
+
+    BlockPreset（方块预设）是一类绑定方块的预设。由于MC的方块数量巨大，将方块预设与MC的原生方块绑定，尤其是地图中常见的原生方块可能对性能造成重大影响。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | engineTypeStr | str | 方块类型ID |
+    | blockId | str | 方块类型数字ID |
+    | auxValue | int | 附加值 |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [GetEngineTypeStr](#getenginetypestr) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取方块预设的方块类型ID |
+
+
+
+
+## GetEngineTypeStr
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.Block.BlockPreset.BlockPreset
+
+- 描述
+
+    获取方块预设的方块类型ID
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | str | 方块类型ID |
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/特效对象EffectObject.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/特效对象EffectObject.md
@@ -0,0 +1,246 @@
+---
+sidebarDepth: 1
+---
+# 特效对象EffectObject
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+SdkInterface <|-- EffectObject
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+EffectObject: 特效对象
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+```
+
+- 描述
+
+    EffectObject（特效对象）是对特效对象封装的基类，它为特效提供了面向对象的使用方式。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | effectId | int | 关联特效ID |
+    | effectType | str | 关联特效类型，frame/particle |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [Play](#play) | <span style="display:inline;color:#7575f9">客户端</span> | 播放特效，仅客户端有效 |
+| [Stop](#stop) | <span style="display:inline;color:#7575f9">客户端</span> | 停止播放特效，仅客户端有效 |
+| [BindToEntity](#bindtoentity) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定到实体 |
+| [BindToSkeleton](#bindtoskeleton) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定骨骼模型 |
+| [SetLoop](#setloop) | <span style="display:inline;color:#7575f9">客户端</span> | 设置特效是否循环播放，默认为否，仅对序列帧有效 |
+| [SetDeepTest](#setdeeptest) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否透视，默认为否 |
+| [SetFaceCamera](#setfacecamera) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否始终朝向摄像机，默认为是 |
+
+
+
+
+## Play
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    播放特效，仅客户端有效
+
+- 参数
+
+    无
+
+- 返回值
+
+    无
+
+
+
+## Stop
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    停止播放特效，仅客户端有效
+
+- 参数
+
+    无
+
+- 返回值
+
+    无
+
+
+
+## BindToEntity
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    绑定到实体
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | bindEntityId | str | 绑定的实体ID |
+    | offset | tuple(float,float,float) | 绑定的偏移量 |
+    | rot | tuple(float,float,float) | 绑定的旋转角度 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 设置是否成功 |
+
+- 示例
+
+```python
+self.BindToEntity(entityId, (0, 1, 0), (0, 0, 0))
+```
+
+
+
+## BindToSkeleton
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    绑定骨骼模型
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | modelId | int | 绑定的骨骼模型的ID（见model组件的GetModelId） |
+    | boneName | str | 绑定具体骨骼的名称 |
+    | offset | tuple(float,float,float) | 绑定的偏移量 |
+    | rot | tuple(float,float,float) | 绑定的旋转角度 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 设置是否成功 |
+
+- 示例
+
+```python
+self.BindToSkeleton(modelId, "root", (0, 1, 0), (0, 0, 0))
+```
+
+
+
+## SetLoop
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    设置特效是否循环播放，默认为否，仅对序列帧有效
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | loop | bool | True表示循环播放 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 设置是否成功 |
+
+- 示例
+
+```python
+# 设置为循环播放
+self.SetLoop(True)
+```
+
+
+
+## SetDeepTest
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    设置序列帧是否透视，默认为否
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | deepTest | bool | False表示透视，则被物体/方块阻挡时仍然能看到序列帧 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 设置是否成功 |
+
+- 示例
+
+```python
+# 设置为透视
+self.SetDeepTest(False)
+```
+
+
+
+## SetFaceCamera
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectObject.EffectObject
+
+- 描述
+
+    设置序列帧是否始终朝向摄像机，默认为是
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | face | bool | True表示朝摄像机 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 设置是否成功 |
+
+- 示例
+
+```python
+# 设置为不始终朝摄像机
+self.SetFaceCamera(False)
+```
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/特效预设EffectPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/特效预设EffectPreset.md
@@ -0,0 +1,105 @@
+---
+sidebarDepth: 1
+---
+# 特效预设EffectPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+PresetBase <|-- EffectPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+EffectObject <|-- EffectPreset
+link EffectObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E7%89%B9%E6%95%88%E5%AF%B9%E8%B1%A1EffectObject.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+EffectPreset: 特效预设
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+EffectObject: 特效对象
+EffectObject: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+```
+
+- 描述
+
+    EffectPreset（特效预设）是一类绑定特效资源的预设。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | resource | str | 特效json的相对路径，不含后缀.json |
+    | effectType | str | 特效类型，frame/particle |
+    | effectId | int | 特效ID |
+    | auto | bool | 是否自动播放 |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [GetResource](#getresource) | <span style="display:inline;color:#7575f9">客户端</span> | 获取绑定的json资源 |
+| [SetResource](#setresource) | <span style="display:inline;color:#7575f9">客户端</span> | 设置绑定的json资源 |
+
+
+
+
+## GetResource
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectPreset.EffectPreset
+
+- 描述
+
+    获取绑定的json资源
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | str | json资源相对路径，不含.json后缀 |
+
+
+
+## SetResource
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.Effect.EffectPreset.EffectPreset
+
+- 描述
+
+    设置绑定的json资源
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | resource | str | json资源相对路径，不含.json后缀 |
+
+- 返回值
+
+    无
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/玩家对象PlayerObject.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/玩家对象PlayerObject.md
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/玩家预设PlayerPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/玩家预设PlayerPreset.md
@@ -0,0 +1,56 @@
+---
+sidebarDepth: 1
+---
+# 玩家预设PlayerPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+EntityPreset <|-- PlayerPreset
+link EntityPreset "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E5%AE%9E%E4%BD%93%E9%A2%84%E8%AE%BEEntityPreset.html"
+PlayerObject <|-- PlayerPreset
+link PlayerObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E7%8E%A9%E5%AE%B6%E5%AF%B9%E8%B1%A1PlayerObject.html"
+PresetBase <|-- EntityPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+EntityObject <|-- EntityPreset
+link EntityObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E5%AE%9E%E4%BD%93%E5%AF%B9%E8%B1%A1EntityObject.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+PlayerPreset: 玩家预设
+PlayerObject: 玩家对象
+PlayerObject: (点击跳转)
+EntityPreset: 实体预设
+EntityPreset: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+EntityObject: 实体对象
+EntityObject: (点击跳转)
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+```
+
+- 描述
+
+    PlayerPreset（玩家预设）是一类特殊的实体预设，玩家预设与玩家实体进行绑定。每个AddOn（编辑器作品）只允许创建一个玩家预设。如果玩家同时启用了多个使用了玩家预设的AddOn，只会加载第一个玩家预设。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | entityId | str | 玩家ID |
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/界面预设UIPreset.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/界面预设UIPreset.md
@@ -0,0 +1,177 @@
+---
+sidebarDepth: 1
+---
+# 界面预设UIPreset
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+PresetBase <|-- UIPreset
+link PresetBase "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%A2%84%E8%AE%BE/%E9%A2%84%E8%AE%BE%E5%9F%BA%E7%B1%BBPresetBase.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+UIPreset: 界面预设
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+PresetBase: 预设基类
+PresetBase: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+```
+
+- 描述
+
+    UIPreset（界面预设）是一类绑定界面资源的预设。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | uiNodeScreen | str | UI画布路径，为"UI文件名.UI画布名"的字符串形式 |
+    | uiNodeModulePath | str | 继承自ScreenNode的UI逻辑文件模块路径 |
+    | uiNodeModule | str | 继承自ScreenNode的UI逻辑文件类名 |
+    | uiName | str | UI名称，需保证在单个addon中唯一 |
+    | autoCreate | bool | 在界面预设创建完成后是否自动创建UI |
+    | isHud | bool | 该界面是否屏蔽游戏操作 |
+    | createUIMethod | str | 创建界面接口 |
+    | isBindParent | bool | 是否绑定父预设，仅当父预设为实体预设时生效 |
+    | bindParentOffset | tuple | 当绑定父预设时生效，修改与绑定实体之间的偏移量 |
+    | bindParentAutoScale | bool | 当绑定父预设时生效，设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放 |
+    | showInEditor | bool | 是否在预设编辑器中创建UI |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [SetUiActive](#setuiactive) | <span style="display:inline;color:#7575f9">客户端</span> | 设置UI激活 |
+| [GetUiActive](#getuiactive) | <span style="display:inline;color:#7575f9">客户端</span> | 获取当前UI是否激活 |
+| [SetUiVisible](#setuivisible) | <span style="display:inline;color:#7575f9">客户端</span> | 设置UI显隐 |
+| [GetUiVisible](#getuivisible) | <span style="display:inline;color:#7575f9">客户端</span> | 获取当前UI是否显示 |
+| [GetScreenNode](#getscreennode) | <span style="display:inline;color:#7575f9">客户端</span> | 获取当前ScreenNode实例 |
+
+
+
+
+## SetUiActive
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.UI.UIPreset.UIPreset
+
+- 描述
+
+    设置UI激活
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | active | bool | 是否激活 |
+
+- 返回值
+
+    无
+
+
+
+## GetUiActive
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.UI.UIPreset.UIPreset
+
+- 描述
+
+    获取当前UI是否激活
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | UI是否激活 |
+
+
+
+## SetUiVisible
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.UI.UIPreset.UIPreset
+
+- 描述
+
+    设置UI显隐
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | visible | bool | 是否显示 |
+
+- 返回值
+
+    无
+
+
+
+## GetUiVisible
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.UI.UIPreset.UIPreset
+
+- 描述
+
+    获取当前UI是否显示
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | UI是否显示 |
+
+
+
+## GetScreenNode
+
+<span style="display:inline;color:#7575f9">客户端</span>
+
+method in Preset.Model.UI.UIPreset.UIPreset
+
+- 描述
+
+    获取当前ScreenNode实例
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | ScreenNode | 当前ScreenNode实例 |
+
+
+
--- a/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/预设基类PresetBase.md
+++ b/mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/预设对象/预设/预设基类PresetBase.md
@@ -0,0 +1,598 @@
+---
+sidebarDepth: 1
+---
+# 预设基类PresetBase
+
+
+
+## 概述
+
+- 继承关系
+
+```mermaid
+classDiagram
+SdkInterface <|-- PresetBase
+link SdkInterface "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html"
+TransformObject <|-- PresetBase
+link TransformObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E5%8F%98%E6%8D%A2%E5%AF%B9%E8%B1%A1TransformObject.html"
+GameObject <|-- TransformObject
+link GameObject "../../../../mcguide/20-玩法开发/14-预设玩法编程/13-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
+PresetBase: 预设基类
+SdkInterface: SDK接口封装
+SdkInterface: (点击跳转)
+TransformObject: 变换对象
+TransformObject: (点击跳转)
+GameObject: 游戏对象
+GameObject: (点击跳转)
+```
+
+- 描述
+
+    PresetBase（预设基类）是所有预设的基类。预设是一类可以被直接放置在场景中的TransformObject（变换对象），并且预设下可以挂接其他TransformObject，可以通过这种方式对游戏逻辑进行简单的封装。在编辑器中放置预设时，会生成预设的虚拟实例，在游戏中生成预设，会生成实例。
+
+- 成员变量
+
+    | 变量名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | presetId | str | 预设文件ID |
+    | preLoad | bool | 是否预加载 |
+    | forceLoad | bool | 是否常加载 |
+    | childPresetInstances | list(PresetBase) | 子预设列表 |
+    | childPartInstances | list(PartBase) | 子零件列表 |
+    | dimension | int | 预设所在维度 |
+    | isAlive | bool | 预设是否存活 |
+
+
+
+## 索引
+
+| 接口 | <div style="width: 3em"></div> | 描述 |
+| --- | --- | --- |
+| [GetIsAlive](#getisalive) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取预设的存活状态 |
+| [GetGameObjectById](#getgameobjectbyid) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取当前预设节点底下指定ID的游戏对象 |
+| [GetGameObjectByEntityId](#getgameobjectbyentityid) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取当前预设节点底下指定实体ID的游戏对象 |
+| [GetChildPresets](#getchildpresets) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取当前预设的所有子预设 |
+| [GetChildPresetsByName](#getchildpresetsbyname) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定名称的所有子预设 |
+| [GetChildPresetsByType](#getchildpresetsbytype) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定类型的所有子预设 |
+| [GetChildObjectByTypeName](#getchildobjectbytypename) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定实体ID的游戏对象 |
+| [GetChildObjectsByTypeName](#getchildobjectsbytypename) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定实体ID的游戏对象 |
+| [SetBlockProtect](#setblockprotect) | <span style="display:inline;color:#ff5555">服务端</span> | 设置预设内的所有素材区域的方块保护状态 |
+| [Replicate](#replicate) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 在指定位置坐标下复制当前预设 |
+| [RemoveChild](#removechild) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 移除指定的子节点对象 |
+| [AddBoxData](#addboxdata) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 添加指定的素材数据 |
+| [RemoveBoxData](#removeboxdata) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 移除指定的素材数据 |
+| [AddPreset](#addpreset) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 添加指定预设作为子预设 |
+| [RemovePreset](#removepreset) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 移除指定的子预设 |
+| [AddPart](#addpart) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 添加指定零件作为子零件 |
+| [RemovePart](#removepart) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 移除指定的子零件 |
+| [GetPartsByName](#getpartsbyname) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定名称的所有子零件 |
+| [GetPartByName](#getpartbyname) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定名称的第一个子零件 |
+| [GetPartsByType](#getpartsbytype) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定类型的所有子零件 |
+| [GetPartByType](#getpartbytype) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 获取指定类型的第一个子零件 |
+| [RemovePartsByType](#removepartsbytype) | <span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span> | 移除指定类型的所有子零件 |
+
+
+
+
+## GetIsAlive
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取预设的存活状态
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | bool | 是否存活 |
+
+
+
+## GetGameObjectById
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取当前预设节点底下指定ID的游戏对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | id | int | 对象ID |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | GameObject | 成功返回游戏对象，失败返回None |
+
+
+
+## GetGameObjectByEntityId
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取当前预设节点底下指定实体ID的游戏对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | entityId | str | 实体ID |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | GameObject | 成功返回游戏对象，失败返回None |
+
+
+
+## GetChildPresets
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取当前预设的所有子预设
+
+- 参数
+
+    无
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | list(PresetBase) | 子预设列表 |
+
+
+
+## GetChildPresetsByName
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定名称的所有子预设
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | name | str | 名称 |
+    | recursive | bool | 是否递归查找，默认为是 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | list(PresetBase) | 子预设列表 |
+
+
+
+## GetChildPresetsByType
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定类型的所有子预设
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | classType | str | 类型 |
+    | recursive | bool | 是否递归查找，默认为是 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | list(PresetBase) | 子预设列表 |
+
+
+
+## GetChildObjectByTypeName
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定实体ID的游戏对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | classType | str | 指定类型 |
+    | name | str | 指定名称，可缺省 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | TransformObject | 成功返回游戏对象，失败返回None |
+
+- 示例
+
+```python
+self.GetChildObjectByTypeName("PresetDebugPart")
+```
+
+
+
+## GetChildObjectsByTypeName
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定实体ID的游戏对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | classType | str | 指定类型 |
+    | name | str | 指定名称，可缺省 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | TransformObject | 成功返回游戏对象，失败返回None |
+
+- 示例
+
+```python
+self.GetChildObjectsByTypeName("PresetDebugPart")
+```
+
+
+
+## SetBlockProtect
+
+<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    设置预设内的所有素材区域的方块保护状态
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | protect | bool | 保护/取消保护 |
+
+- 返回值
+
+    无
+
+
+
+## Replicate
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    在指定位置坐标下复制当前预设
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | pos | tuple(float,float,float) | 位置坐标 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | PresetBase | 返回复制的预设，失败返回None |
+
+
+
+## RemoveChild
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    移除指定的子节点对象
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | child | TransformObject | 待移除的子对象 |
+
+- 返回值
+
+    无
+
+
+
+## AddBoxData
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    添加指定的素材数据
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | boxData | BoxData | 待添加的素材数据 |
+
+- 返回值
+
+    无
+
+
+
+## RemoveBoxData
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    移除指定的素材数据
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | boxData | BoxData | 待移除的素材数据 |
+
+- 返回值
+
+    无
+
+
+
+## AddPreset
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    添加指定预设作为子预设
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | preset | PresetBase | 待添加的预设 |
+
+- 返回值
+
+    无
+
+
+
+## RemovePreset
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    移除指定的子预设
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | preset | PresetBase | 待移除的子预设 |
+
+- 返回值
+
+    无
+
+
+
+## AddPart
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    添加指定零件作为子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | part | PartBase | 待添加的零件 |
+
+- 返回值
+
+    无
+
+
+
+## RemovePart
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    移除指定的子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | part | PartBase | 待移除的零件 |
+
+- 返回值
+
+    无
+
+
+
+## GetPartsByName
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定名称的所有子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | name | str | 零件名称 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | list(PartBase) | 零件列表 |
+
+
+
+## GetPartByName
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定名称的第一个子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | name | str | 零件名称 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | PartBase | 零件/None |
+
+
+
+## GetPartsByType
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定类型的所有子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | type | str | 零件类名 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | list(PartBase) | 零件列表 |
+
+
+
+## GetPartByType
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    获取指定类型的第一个子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | type | str | 零件类名 |
+
+- 返回值
+
+    | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- |
+    | PartBase | 零件/None |
+
+
+
+## RemovePartsByType
+
+<span style="display:inline;color:#7575f9">客户端</span>/<span style="display:inline;color:#ff5555">服务端</span>
+
+method in Preset.Model.PresetBase.PresetBase
+
+- 描述
+
+    移除指定类型的所有子零件
+
+- 参数
+
+    | 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
+    | :--- | :--- | :--- |
+    | type | str | 零件类名 |
+
+- 返回值
+
+    无
+
+
+