diff --git a/bbp_ng/UTIL_naming_convension.py b/bbp_ng/UTIL_naming_convension.py index ccd3ffc..af9db38 100644 --- a/bbp_ng/UTIL_naming_convension.py +++ b/bbp_ng/UTIL_naming_convension.py @@ -460,9 +460,9 @@ class YYCToolchainConvention(): case BallanceObjectType.LEVEL_END: return 'PE_Balloon_01' case BallanceObjectType.CHECKPOINT: - return f'PR_Resetpoint_{info.mSector:0>2d}' + return f'PR_TwoFlames_{info.mSector:0>2d}' case BallanceObjectType.RESETPOINT: - return f'PC_TwoFlames_{info.mSector:0>2d}' + return f'PC_Resetpoint_{info.mSector:0>2d}' case BallanceObjectType.DEPTH_CUBE: return 'DepthCubes_' diff --git a/docs/docs/imgs/component-adder.png b/docs/docs/imgs/component-adder.png new file mode 100644 index 0000000..5112e2e Binary files /dev/null and b/docs/docs/imgs/component-adder.png differ diff --git a/docs/docs/imgs/legacy-align.png b/docs/docs/imgs/legacy-align.png new file mode 100644 index 0000000..62265ca Binary files /dev/null and b/docs/docs/imgs/legacy-align.png differ diff --git a/docs/docs/zh-cn/component-adder.md b/docs/docs/zh-cn/component-adder.md index c822ee3..b685ea7 100644 --- a/docs/docs/zh-cn/component-adder.md +++ b/docs/docs/zh-cn/component-adder.md @@ -1,4 +1,49 @@ # 添加机关 -!!! info "制作中..." - 手册的这部分还在制作当中。稍安勿躁。 +在3D视图中，点击`Add - Components`可展开添加机关菜单。菜单如下图左侧所示。 + +![](../imgs/component-adder.png) + +上图右侧则展示了一些机关添加的界面，会在后续依次介绍它们，右侧从上到下分别是：添加Checkpoint（检查点）、添加Nong Extra Point（脓分）、添加Nong Ventilator（脓风扇）、添加Ventilator Series（风扇阵列）、添加Sector Pair（盘点对） + +## 普通机关 + +在添加机关菜单中，`Basic Components`分类下的是普通机关的添加。对于大多数机关而言，添加机关需要指定其所属小节，表示这个机关只在这个小节中激活。然而有一些例外： + +* PS_FourFlame：关卡开始的4火焰盘点，全局唯一，因此没有小节属性。 +* PE_Ballon：关卡终点的飞船，全局唯一，因此没有小节属性。 +* PC_TwoFlames：小节的检查点。具有小节属性，但需要注意的是，其小节指的是其要检查哪个小节，例如指定小节号为1，则表示它是第一小节的检查点，即第二小节的开始，通过后开启第二小节。 +* PR_Resetpoint：小节的重生点，小节号表示它是哪个小节的重生点。因此当PC_TwoFlames和PR_Resetpoint成对出现时，PR_Resetpoint总比PC_TwoFlames的标号小1。 + +!!! info "自动名称冲突检测" + 一部分物体在一张Ballance地图中名称是唯一的，例如开头盘点与终点飞船有且只能有一个，小节检查点与复活点同一小节只能存在一个等。 + + BBP在创建这些机关时提供了名称检测功能，如果名称已存在，会在创建时在下方用文字显示出来，以提醒用户不要创建重复的内容。如上文展示图右上角显示为例，其正在尝试添加一个已经存在的PC_TwoFlames并收到了警告。 + +## 添加脓机关 + +在添加机关菜单中，`Nong Components`分类下的是脓机关的添加。我们只提供两类常用脓机关的添加：脓分和脓风扇。 + +脓分添加需要指定脓分的小节号和个数。并且会自动帮用户对脓分实现一个逐个旋转的效果，以让游戏内的脓分显示的更好看。 + +脓风扇的添加同样要指定小节号和个数。不同的是我们提供了一些预设数值，这些预设数值构造的脓风扇可以恰好吹起木球或石球，如果你对这些预设数值不满意，仍可以自行输入数量。 + +!!! info "风扇阵列也可以" + 你知道吗，在添加风扇阵列时将偏移设为0也可以实现脓风扇。这里的脓风扇创建只是提供了一些预设数值罢了。 + +## 添加阵列机关 + +在添加机关菜单中，`Series Components`分类下的是阵列机关的添加。我们只提供两类常用阵列机关的添加：浮板阵列和风扇阵列。 + +浮板阵列需要提供小节号和浮板个数，并且还可以自由调整相邻浮板之间的间距，默认间距取自游戏内。 + +风扇阵列也需要提供小节号和风扇个数，然而它提供三维的偏移量，这样你就可以构建竖直的风扇阵列或水平的风扇阵列。默认偏移数值取自游戏内竖直风扇阵列的数值。 + +## 添加机关对 + +在添加机关菜单中，`Components Pair`分类下的是机关对的添加。目前只有一种机关对：盘点对可添加。 + +盘点对需要你输入一个小节号，它会为你自动生成盘点火与重生点机关对。例如输入1小节，则会自动生成4火焰盘点火和第1小节的重生点，输入2，则会生成第1小节检查点和第2小节重生点，以此类推。 + +!!! info "自动名称冲突检测" + 与普通机关添加类似，盘点对的添加也有名称冲突检测功能。上文图中右下角为例，其显示第1小节的盘点对已经存在，不需要添加。 diff --git a/docs/docs/zh-cn/group-operations.md b/docs/docs/zh-cn/group-operations.md index 7252f6b..47d65e6 100644 --- a/docs/docs/zh-cn/group-operations.md +++ b/docs/docs/zh-cn/group-operations.md @@ -1,8 +1,5 @@ # 按组操作 -!!! info "制作中..." - 手册的这部分还在制作当中。稍安勿躁。 - ## 按组选择 `Ballance - Select by Virtools Group`提供了一种按照Virtools归组数据进行筛选的功能。 diff --git a/docs/docs/zh-cn/index.md b/docs/docs/zh-cn/index.md index 78d991e..7f9d34a 100644 --- a/docs/docs/zh-cn/index.md +++ b/docs/docs/zh-cn/index.md @@ -1,8 +1,5 @@ # Ballance Blender Plugin用户手册 -!!! info "制作中..." - 手册的这部分还在制作当中。稍安勿躁。 - 欢迎来到Ballance Blender Plugin，一个自由开源的Ballance地图创作套件的用户手册。 Ballance Blender Plugin（后文简称BBP）是一款关注Ballance自制地图创建的插件。它提供了相当丰富的功能，从制图新手到老手，均可利用此插件创作Ballance自制地图。BBP提供了导入导出Ballance地图所用格式的功能，并为Ballance地图创作量身打造了一系列便利的功能：对于新手，可以借助预制路块快速拼接完成一张地图；对于老手，也提供了构建复杂结构所需的贴图工具。 diff --git a/docs/docs/zh-cn/legacy-align.md b/docs/docs/zh-cn/legacy-align.md index c9eb615..5a9ff71 100644 --- a/docs/docs/zh-cn/legacy-align.md +++ b/docs/docs/zh-cn/legacy-align.md @@ -1,4 +1,29 @@ # 传统对齐 -!!! info "制作中..." - 手册的这部分还在制作当中。稍安勿躁。 +`Ballance - 3ds Max Align`提供了一种类似于3ds Max中对齐方式的对齐功能。 + +所谓传统对齐功能，是是将3ds Max中的对齐操作完美地在Blender中重新进行了实现。可以使得很多从3ds Max转来使用Blender的制图人可以更快地上手，并且提供了一些便捷的对齐操作。下图展示了正在运作的传统对齐。 + +![](../imgs/legacy-align.png) + +## 使用方法 + +传统对齐支持将多个物体对一个物体的对齐，操作方法是先依次选中需要被对齐的物体，然后在最后选中对齐参考对象（也就是使其称为活动物体），然后点击`Ballance - 3ds Max Align`，即可弹出传统对齐面板，之后便可开始对齐操作。 + +## 面板介绍 + +在面板中，`Align Axis`指定了你要对齐的轴，此处可以多选以指定多个轴，不指定任何轴将无法进行对齐操作，因而也无法点击`Apply`按钮。 + +`Current Object`是对齐参考物体，也就是场景中的活动物体，通常也就是你选择的最后一个物体。在这个选项里指定你需要参考其什么数值进行对齐，分别有`Min`（轴上最小值）、`Center (Bounding Box)`（碰撞箱的中心）、`Center (Axis)`（物体的原点）、`Max`（轴上的最大值）可选。这些选项与3ds Max中的对齐选项是一致的。 + +`Target Objects`是正在被对齐的物体，可能有很多个，在这个选项里也是指定你需要参考其什么数值进行对齐。选项与`Current Object`含义一致。 + +`Apply`按钮点击后将把当前页面的配置压入操作栈，并重置上面的设置，使得你可以开始新一轮对齐操作而无需再次执行传统对齐。操作栈中的操作个数在`Apply`按钮下方显示。 + +!!! info "Apply按钮做了什么" + 了解这部分对制图没有用，除非你感兴趣，否则不需要阅读这个框里的内容。 + + 在设计上，Blender不支持所谓“在Operator内进行操作”，但是我们通过一些小把戏，模拟了一种类似于3ds Max中应用的效果。 + + Apply按钮实际上是一个特殊显示的BoolProperty，通过监听其值变化事件，在避免递归调用的情况下，将当前设置记录在一个隐藏的CollectionProperty中，并重置自身数值和显示的属性，以达到“应用”的效果。Operator在执行过程中则是依次处理CollectionProperty中积攒的对齐要求。 + diff --git a/docs/docs/zh-cn/naming-convention.md b/docs/docs/zh-cn/naming-convention.md index 37fbd48..197f195 100644 --- a/docs/docs/zh-cn/naming-convention.md +++ b/docs/docs/zh-cn/naming-convention.md @@ -1,8 +1,5 @@ # 命名规则 -!!! info "制作中..." - 手册的这部分还在制作当中。稍安勿躁。 - ## 自动归组与重命名 在大纲视图中，对任意集合右键，可以得到自动归组与重命名菜单。