first commit

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/00-触发器零件.md

@@ -0,0 +1,27 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+# 触发器
+
+TriggerPart（触发器零件）包含一个长方体的区域，可以使用触发器零件对进出区域的实体进行检测。
+
+![image-20210710181419000](./images/parts001.png)
+
+点击触发器，可以在他的属性面板中看到以下属性：
+
+- 区域，用于指定触发器的区域
+  - 维度：用于指定这个区域在哪个维度
+- 监听，影响触发器的事件发送
+
+![image-20210710181656492](./images/parts002.png)
+
+点击区域页签旁边的定位按钮，可以将触发器的区域显示出来（如下图），之后可以通过挪动坐标系整体移动区域的位置，或者使用鼠标对触发器区域的每一个面进行拖拽。
+
+> 区域的坐标是相对于触发器的坐标，拖动触发器同样可以改变区域的整体位置。
+
+![parts003](./images/parts003.gif)
+
+>如果需要在游戏中使用脚本调用此零件，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/触发器零件TriggerPart.html" rel="noopenner"> 触发器零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/01-玩家基础属性零件.md

@@ -0,0 +1,23 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+
+
+# 玩家基础属性
+
+PlayerBasicPart（玩家基础属性零件）是一种只能挂接到玩家预设下的内置零件。
+
+![image-20210708144908833](./images/image-20210708144908833.png)
+
+通过挂接玩家基础属性零件，我们能够对所有玩家的基础属性进行相应的修改。
+
+![image-20210708150124638](./images/image-20210708150124638.png)
+
+点击运行，进入游戏，我们可以看到自身的血量上限有40，可以透视到其他玩家的名字。
+
+![image-20210708150107248](./images/image-20210708150107248.png)
+
+>如果需要在游戏中使用脚本调用此零件，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/玩家基础属性零件PlayerBasicPart.html" rel="noopenner"> 玩家基础属性零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/02-世界属性零件.md

@@ -0,0 +1,18 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+
+# 世界属性零件
+
+使用时挂在空预设下即可。并且尽量保证这个预设在场景中有且仅有一个实例。
+
+![parts004](./images/parts004.png)
+
+世界选项与旧版关卡编辑器的世界属性组件相同。
+
+![parts005](./images/parts005.png)
+
+>如果需要在游戏中使用脚本调用此零件，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/世界属性零件WorldPart.html" rel="noopenner"> 世界属性零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/03-相机轨迹CameraTrackPart.md

@@ -0,0 +1,52 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+# 相机轨迹零件
+
+相机轨迹零件CameraTrackPart是一个用于制作相机移动和旋转轨迹动画的零件。
+
+为了便于查看效果，这里我们添加一个货摊素材作为参照物，如下图所示。
+
+![parts006](./images/parts006.png)
+
+点击相机轨迹零件，我们可以在属性面板看到其有如下属性:
+
+![parts006](./images/parts007.png)
+
+这里重点解释一下相机轨迹这部分属性：
+
+1. 预览路径：用于控制是否开启预览路径，预览路径就是用线条和箭头在预设场景中显示相机动画的轨迹路线，即上面示意图中的部分。
+
+2.  播放：勾选则在预设场景中播放当前相机轨迹动画。
+  
+3.  轨迹：即相机轨迹动画中的每个轨迹点的信息，可以理解为关键帧动画中的某一帧，代表相机在某个时间点须将自身的位置旋转等信息变换到这个轨迹点所代表的状态上。相机轨迹零件的作用就是让玩家能够自由编辑相机的轨迹点信息，从而构成相机动画。可以通过轨迹右侧的"+"按钮新增轨迹点，每个轨迹点的属性如下：
+
+      >偏移：该轨迹点相对于整个相机轨迹零件的位置偏移量
+      >
+      >旋转：该轨迹点摄像机相对于正北方向的旋转弧度（上下弧度，左右弧度）
+      >
+      >Pitch（俯仰角）顺向：控制上下方向的顺逆
+      >
+      >Yaw（偏航角）顺向：控制左右方向的顺逆
+      >
+      >时间：上一个轨迹点到当前轨迹点所需时间，越长，相机变换的速度越缓慢
+
+4.  轨迹点操作方式：
+  
+![parts009](./images/parts009.png)
+
+1. 轨迹点顶部按钮，可以快捷执行删除轨迹点、上移轨迹点、下移轨迹点、上方新建轨迹点四种操作。
+2. 轨迹点的偏移和旋转属性右侧提供了记录当前摄像头信息和定位的快捷操作按钮
+
+>记录当前摄像头信息：将预设场景界面的摄像头信息记录在当前轨迹点，当前支持记录位置和旋转两种信息。
+>
+>定位：在预设场景展示该轨迹点的坐标，并提供坐标轴供玩家进行可视化操作来调整轨迹点的位置信息。
+    
+充分熟悉上述操作方式后，我们能够更快速和便捷地进行相机轨迹动画的创作，并随时进行路径的预览和播放，如下图所示
+
+![cameratrack](./images/cameratrack.gif)
+
+>如果需要在游戏中使用脚本调用此零件，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/相机轨迹CameraTrackPart.html" rel="noopenner"> 相机轨迹零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/04-实体零件.md

@@ -0,0 +1,40 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+# 实体零件
+
+## 实体组合
+
+实体零件EntiyBasePart用于在预设下管理多个实体预设。
+
+在[预设组装的挂接规则](../../14-预设玩法编程/1-深入理解预设/1-组装预设.md)中，我们知道空预设下是无法挂载实体预设的，为了让开发者更便捷地管理多个实体，我们提供了实体零件。使用时只需在空预设下挂载此零件，再从属性面板选择对应的实体类型，就能够间接地达成预设下挂载实体的目标。实体零件属性的如下图所示：
+
+![custommonster](./images/custommonster.png)
+
+- 自动创建：是否在零件初始化时，自动创建关联实体ID，如果不勾选，则需要手动调用零件的API创建关联实体ID，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/实体零件EntityBasePart.html" rel="noopenner"> 实体零件API接口文档 </a>。
+
+- 实体类型：实体零件所绑定的实体类型，这里支持原版实体和未绑定预设的实体配置。
+>注意：实体类型不支持实体预设
+
+这里举一个实用例子，对于含有刷怪事件的玩法，开发者可以将每波刷出的怪物制作成一个怪物阵型，从而对每波怪物进行统一的管理，这里就需要用到实体零件，
+通过复制或新建，在预设下创建多个该零件，便能构建出一个怪物阵型，如下图所示：
+
+![monsterFormation](./images/monsterFormation.png)
+
+
+
+## 注意事项
+
+- 实体零件**只能挂接在空预设**下
+- 实体类型属性，**不能选择已经有对应实体预设的类型**，否则创建出来的是实体预设，不受实体零件管理
+- 实体零件创建出来的实体，**不会保存到地图**中，在预设卸载，保存退出等时机会自动清除相关实体，在下次预设加载时再重新创建
+- 注意避免组合大量实体零件构建怪物阵型，这可能造成加载时卡顿，尤其在低配手机上
+- 实体零件进行缩放时，是**xyz轴同步缩放**，但它的父节点可以设置xyz轴分别为不同缩放，以**x轴的最终缩放**为准，尽量避免实体零件的父节点的缩放不一致
+- 实体零件进行旋转时，**只支持xy轴旋转**，且只在实体生成时有效，此后由怪物AI控制，如果前面把父节点的缩放设为不一致，旋转实体可能导致x轴的缩放系数发生变化导致实体缩放突变。
+
+
+
+>如果需要在游戏中使用脚本调用此零件，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/实体零件EntityBasePart.html" rel="noopenner"> 实体零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/05-导航路径零件.md

@@ -0,0 +1,33 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+# 导航路径零件
+导航路径零件NavPointsPart用于创建一条可视化的路径，并进行路径点的可视化添加和编辑，点击该零件，我们在属性面板可以看到其拥有以下属性：
+
+![parts010](./images/parts010.png)
+
+这里着重讲一下巡逻路径属性，巡逻路径的本质就是一组有顺序的位置坐标数据。巡逻路径有两个属性：
+
+1. 预览路径：用于控制是否开启预览路径，预览路径就是用线段和箭头将所有巡逻点连接起来，让玩家在编辑路径时能够直观地看到每个点之间的位置和顺序关系。
+   
+2. 路径：即巡逻路径上的每个巡逻点的信息，通过右侧的"➕"按钮可以新建巡逻点，巡逻点下包含该点的位置坐标。 
+   
+3. 路径操作方式：每个巡逻点上方的菜单（下图中A框）可以进行巡逻点的删除、上移、下移和上方新建四种快捷操作。右侧的记录摄像机位置（下图中B框）和定位按钮（下图中C框）可以让你更为便捷地进行路径点的可视化选取和移动。
+
+![parts011](./images/parts011.png)
+
+熟练上述操作后能够帮助你快速搭建导航路径，如下图所示：
+
+![navpointssample](./images/navpointssample.gif)
+
+这里举一个运用导航路径零件的例子：在塔防游戏中，我们希望怪物出生后按照一定的路径进行移动巡逻，比如从起始点开始，走向第二个巡逻点，再走向第三个巡逻点，以此类推，形成一条巡逻路径。那么如何快速进行路径的可视化编辑呢？
+
+为了达到这个效果，我们可以在编辑器内使用导航路径零件，提前构造好巡逻路径点，然后在脚本中使用本零件的接口(<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/导航路径零件NavPointsPart.html" rel="noopenner"> GetNavigationPoints </a>)快速获得所有巡逻点的数据，再调用寻路接口(<a href="../../../../mcdocs/1-ModAPI/接口/实体/行为.html" rel="noopenner"> SetMoveSetting </a>)让怪物依次在各个点之间移动，以此达到怪物移动巡逻的效果。
+
+>这里只是一个简单使用案例，导航路径零件主要帮助开发者可视化编辑路径/位置数据，具体使用还需要开发者根据实际需要灵活运用哦~
+
+
+关于导航路径零件的接口，可以参考<a href="../../../../mcdocs/3-PresetAPI/预设对象/零件/导航路径零件NavPointsPart.html" rel="noopenner"> 导航路径零件的API接口文档 </a>

docs/mcguide/20-玩法开发/11-组装简单玩法/11-内置零件/06-后处理零件.md

@@ -0,0 +1,78 @@
+---
+front: 	https://nie.res.netease.com/r/pic/20210727/76bfa7be-0be4-4e27-91a3-b5268695f359.png
+hard: 入门
+time: 20分钟
+---
+
+# 后处理零件
+后处理零件PostProcessPart用于快速设置并在游戏中使用渐晕、镜头污渍、模糊等后处理效果。
+
+以往开发者想要使用后处理效果，需要手动在零件代码中调用后处理相关的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/索引.html" rel="noopenner"> ModAPI</a>接口，步骤繁琐且需要先了解python和SDK框架，对新开发者不够友好，此次将后处理效果封装成一个零件，正是为了帮助不会代码的开发者用上后处理的效果，让自己开发的组件达到更高的品质。
+
+> 后处理零件只能挂载在已经勾选预加载的空预设上。
+
+点开零件属性，我们可以看到后处理零件拥有以下属性。
+
+
+
+![postprocesspart-1](./images/postprocesspart-1.png)
+
+
+
+接下来我们逐一介绍后处理零件的几种效果属性。
+
+### 渐晕：效果如下图
+
+![postprocesspart](./images/postprocesspart-2.png)
+
+| 属性         | 描述                                                         |
+| ------------ | ------------------------------------------------------------ |
+| 开启屏幕渐晕 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/渐晕.html#setenablevignette" rel="noopenner">SetEnableVignette</a>接口，设置是否开启屏幕渐晕（Vignette）效果，开启后玩家屏幕周围将出现渐晕。 |
+| 渐晕中心位置 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/渐晕.html#setvignettecenter" rel="noopenner">SetVignetteCenter</a>接口，设置渐晕（Vignette）的渐晕中心位置，可改变屏幕渐晕的位置。 |
+| 渐晕颜色     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/渐晕.html#setvignettergb" rel="noopenner">SetVignetteRGB</a>接口，设置渐晕（Vignette）的渐晕颜色，可改变屏幕渐晕的颜色。 |
+| 渐晕半径     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/渐晕.html#setvignetteradius" rel="noopenner">SetVignetteRadius</a>接口，设置渐晕（Vignette）的渐晕半径，半径越大，渐晕越小，玩家的视野范围越大。 |
+| 渐晕模糊系数 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/渐晕.html#setvignettesmoothness" rel="noopenner">SetVignetteSmoothness</a>接口，设置渐晕（Vignette）的渐晕模糊系数，模糊系数越大，则渐晕边缘越模糊，模糊的范围也越大。 |
+
+### 模糊：效果如下图
+
+![postprocesspart](./images/postprocesspart-3.png)
+
+| 属性         | 描述                                                         |
+| ------------ | ------------------------------------------------------------ |
+| 开启高斯模糊 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/模糊.html#setenablegaussianblur" rel="noopenner">SetEnableGaussianBlur</a>接口，设置是否开启高斯模糊效果，开启后玩家屏幕周围被模糊。 |
+| 模糊半径     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/模糊.html#setgaussianblurradius" rel="noopenner">SetGaussianBlurRadius</a>接口，设置高斯模糊效果的模糊半径，半径越大，模糊程度越大，反之则模糊程度越小。 |
+
+### 色彩校正：效果如下图
+
+![postprocesspart](./images/postprocesspart-4.png)
+| 属性             | 描述                                                         |
+| ---------------- | ------------------------------------------------------------ |
+| 开启色彩校正    | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/色彩.html#setenablecoloradjustment" rel="noopenner">SetEnableColorAdjustment</a>接口，设置是否开启色彩校正效果，开启后可进行屏幕色彩调整 。|
+| 色彩亮度    | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/色彩.html#setcoloradjustmentbrightness" rel="noopenner">SetColorAdjustmentBrightness</a>接口，调整屏幕色彩亮度，亮度值越大，屏幕越亮，反之则越暗。|
+| 色彩对比度   | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/色彩.html#setcoloradjustmentcontrast" rel="noopenner">SetColorAdjustmentContrast</a>接口，调整屏幕色彩对比度，屏幕对比度值越大，色彩差异则越明显，反之则色彩差异越小。|
+| 色彩饱和度    | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/色彩.html#setcoloradjustmentsaturation" rel="noopenner">SetColorAdjustmentSaturation</a>接口，调整屏幕色彩饱和度，屏幕饱和度值越大，色彩则越明显，反之则越灰暗。|
+| 色调    | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/色彩.html#setcoloradjustmenttint" rel="noopenner">SetColorAdjustmentTint</a>接口，调整屏幕色彩的色调，根据输入的色调和强度来调整屏幕色彩，当强度越大时，屏幕整体颜色越偏向输入的色调。|
+
+### 景深效果：效果如下图
+
+![postprocesspart](./images/postprocesspart-5.png)
+
+| 属性             | 描述                                                         |
+| ---------------- | ------------------------------------------------------------ |
+| 开启景深效果     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setenabledepthoffield" rel="noopenner">SetEnableDepthOfField</a>接口，设置是否开启景深效果，开启后屏幕出现景深效果，根据焦点距离呈现远处模糊近处清晰或者近处模糊远处清晰的效果。 |
+| 模糊半径         | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setdepthoffieldblurradius" rel="noopenner">SetDepthOfFieldBlurRadius</a>接口，调整景深效果模糊半径，模糊半径越大，模糊程度越大，反之则越小。 |
+| 远景模糊大小     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setdepthoffieldfarblurscale" rel="noopenner">SetDepthOfFieldFarBlurScale</a>接口，调整景深效果远景模糊大小，远景模糊大小越大，远景的模糊程度越大，反之则越小。注意，远景模糊程度的调节依赖于焦点距离，如果焦点处于较远的距离，那么此时远景处于较清晰的状态，模糊程度大小调节不会很明显。 |
+| 近景模糊大小     | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setdepthoffieldnearblurscale" rel="noopenner">SetDepthOfFieldNearBlurScale</a>接口，调整景深效果近景模糊大小，近景模糊大小越大，近景的模糊程度越大，反之则越小。注意，近景模糊程度的调节依赖于焦点距离，如果焦点处于较近的距离，那么此时近景处于较清晰的状态，模糊程度大小调节不会很明显。 |
+| 屏幕中心聚焦模式 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setdepthoffieldusecenterfocus" rel="noopenner">SetDepthOfFieldUseCenterFocus</a>接口，设置景深效果是否开启屏幕中心聚焦模式，开启后聚焦距离将被自动设置为屏幕中心所对应的物体所在的距离。在第一人称视角下，聚焦距离将被自动设置为屏幕准心所对应的物体与相机的距离，即自动聚焦准心所对应的物体。在第三人称视角下，由于屏幕中心总是对应着玩家，因此聚焦距离将被自动设置为玩家与相机的距离，即自动聚焦在玩家自己。 |
+| 焦点距离         | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setdepthoffieldfocusdistance" rel="noopenner">SetDepthOfFieldFocusDistance</a>接口，调整景深效果焦点距离，距离越小，则远处模糊,近处清晰;距离越大，则远处清晰，近处模糊。该距离为实际距离，即以玩家相机为起点的世界坐标距离。 |
+
+### 镜头污迹：效果如下图
+
+![postprocesspart-6](./images/postprocesspart-6.png)
+
+| 属性         | 描述                                                         |
+| ------------ | ------------------------------------------------------------ |
+| 镜头污迹效果 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setenablelensstain" rel="noopenner">SetEnableLensStain</a>接口，设置是否开启镜头污迹效果，开启后镜头出现污迹效果，可改变使用的污迹贴图及污迹颜色。 |
+| 镜头污迹强度 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setlensstainintensity" rel="noopenner">SetLensStainIntensity</a>接口，调整镜头污迹强度，强度越大，污迹越明显，反之则越透明。 |
+| 镜头污迹贴图 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setlensstaintexture" rel="noopenner">SetLensStainTexture</a>接口，开启镜头污迹效果后，污迹效果使用的为系统默认贴图。该接口可改变镜头污迹所使用的贴图。注意贴图最好使用透明背景，否则屏幕将被贴图覆盖。 |
+| 镜头污迹颜色 | 等同于调用ModAPI下的<a href="../../../../mcdocs/1-ModAPI/接口/后处理/镜头效果.html#setlensstaincolor" rel="noopenner">SetLensStainColor</a>接口，调整镜头污迹颜色，根据输入的颜色和强度来调整污迹色彩，当强度越大时，污迹颜色越偏向输入的颜色。 |