Search Results for

    Show / Hide Table of Contents

    制作特效模组

    中文 | English

    在仓库根目录运行以下命令,用本机 Unity MCP 回放本页示例。 命令也会重拍两种语言的配图。

    python Docs/Manual/manual/tools/tutorials.py run vfx-mod --capture
    
    点击展开 MCP 操作点击收起 MCP 操作

    准备教学样例。${变量} 由配方提供。

    {
      "variables": {
        "prefab": "${fixture}/TutorialVFX.prefab",
        "identifier": "${fixture}/TutorialVFXIdentifier.asset",
        "pool": "${fixture}/TutorialVFXPool.asset",
        "pipeline": "${fixture}/Docs_${runId}_Pipeline.asset",
        "package": "${fixture}/Docs_${runId}_Package.asset",
        "packageGuid": "69127c62-2de8-5f37-ac99-fe95537a9298",
        "bulletVfx": "${fixture}/TutorialBulletVFX.asset"
      },
      "calls": [
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateFolder",
            "args": [
              "${fixtureParent}",
              "${folder}"
            ]
          },
          "expect": {
            "contains": "(String)"
          }
        },
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateAsset",
            "args": [
              "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.ModPackageData)",
              "${package}"
            ]
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateAsset",
            "args": [
              "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.ModPackageBuildPiplineData)",
              "${pipeline}"
            ]
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/localizedModName/defaultName",
            "value": "Tutorial Package"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/localizedDescription/defaultName",
            "value": "Documentation teaching package"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/author",
            "value": "Documentation"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/supportURL",
            "value": "https://doc.game.windyverse.net/"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/guid",
            "value": "${packageGuid}"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${pipeline}/linkedModPackage",
            "value": "@asset:${package}"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        }
      ]
    }
    

    这个例子将特效注册为 TutorialVFX,再把这个键绑定到炮弹的弹道。第一次制作炮弹时,可以先使用坦克教程的原装特效,确认炮口、弹道和命中都能显示,再改成自己的资源。

    1. 建立资源标识和特效预制体

    1. 在 Project 右键选 Create → A Panzer War → P Pool → Pool Resource Identifier。给标识填显示名。游戏用标识把已安装的特效包列到选择项中,GUID 由 Unity 自动生成。需要给旧「马哥特效包」追加资源时,请向作者取得原标识资产。同名新资产会生成自己的 GUID。
    2. 把粒子效果做成独立 GameObject,将它拖到 Project 保存为 prefab。双击打开,在根节点挂 PoolItemComponent。做弹道时,在子节点 Trail 添加 Trail Renderer,然后把这个子物体拖进**武器拖尾(Weapon Projectile)**列表。后效回放和炮弹展示会隐藏这份拖尾。保存 prefab,再从根节点打开组件检查引用。

    特效资源标识和自动生成的 GUID

    将拖尾子物体绑定到 Weapon Projectile

    点击展开 MCP 操作点击收起 MCP 操作
    [
      {
        "tool": "prefab_edit",
        "arguments": {
          "json": {
            "path": "${prefab}",
            "mode": "create",
            "component": "ShanghaiWindy.Core.PoolItemComponent",
            "children": [
              "Trail"
            ],
            "values": {
              "weaponProjectiles": [
                null
              ]
            },
            "references": [
              {
                "property": "weaponProjectiles.Array.data[0]",
                "child": "Trail",
                "component": "UnityEngine.GameObject"
              }
            ]
          }
        },
        "expect": {
          "equals": {
            "ok": true
          }
        }
      },
      {
        "tool": "prefab_edit",
        "arguments": {
          "json": {
            "path": "${prefab}",
            "mode": "update",
            "component": "UnityEngine.TrailRenderer",
            "child": "Trail"
          }
        },
        "expect": {
          "equals": {
            "ok": true
          }
        }
      },
      {
        "tool": "inspect",
        "arguments": {
          "path": "asset:${prefab}/PoolItemComponent/weaponProjectiles/0/name"
        },
        "expect": {
          "contains": "(String) Trail"
        }
      }
    ]
    

    2. 配置对象池资源

    在相同 P Pool 菜单创建 Pool Resource。将第一步的标识拖入 Identifier,再展开 Spawn Reses,点击 + 添加一项。

    字段 教学值 用途
    特效名称 TutorialVFX 运行时查找的键。建议为自己的模组取独立名字。
    特效物体 第一节保存的 prefab 调用时由对象池生成。
    预加载实例化数量 -1 按需生成。正数会预建实例,可减少首次播放时的卡顿。数量越多,占用的内存和加载时间越大。
    生命时长 3 秒 普通一次性效果到时回收。0 留给由逻辑主动回收的喷火、激光等效果。

    保存后点击刷新特效下拉框。如果选不到新键,检查资源条目是否保存、Prefab 引用是否为空,再刷新一次。

    对象池特效名称与特效预制体

    点击展开 MCP 操作点击收起 MCP 操作
    [
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.PoolResourceIdentifierData)",
            "${identifier}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "asset:${identifier}/OnValidate",
          "args": []
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect",
        "arguments": {
          "path": "asset:${identifier}/guid"
        },
        "expect": {
          "contains": "(String)"
        },
        "capture": {
          "poolGuid": {
            "regex": "\\(String\\) ([a-f0-9-]{36})"
          }
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.PoolResource)",
            "${pool}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEngine.JsonUtility/FromJsonOverwrite",
          "args": [
            "{\"spawnReses\":[{\"spawnName\":\"TutorialVFX\",\"instanceCount\":-1,\"lifeTime\":3}]}",
            "@asset:${pool}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${pool}/identifier",
          "value": "@asset:${identifier}"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${pool}/spawnReses/0/spawnObject",
          "value": "@asset:${prefab}"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.EditorUtility/SetDirty",
          "args": [
            "@asset:${pool}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/SaveAssets",
          "args": []
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect",
        "arguments": {
          "path": "asset:${pool}/spawnReses/0/spawnObject/name"
        },
        "expect": {
          "contains": "(String) TutorialVFX"
        }
      }
    ]
    

    3. 绑定炮弹、构建并试用

    1. 选中炮弹并打开引用的 BulletVFX。把 TutorialVFX 选到弹道。如果想保留原弹道作为回退,在重载弹道列表里添加 TutorialVFX,保留原基础键。制作着弹效果时可同样填写击中地面或击中装甲。回到炮弹确认它仍引用刚编辑的 BulletVFX。
    2. 如果特效与载具同包,把 Pool Resource 和载具数据加入同一构建管线。如果分包,把 Pool Resource 加进特效包的 Linked Objects,构建特效包。把该包的 ModPackageData GUID 加到载具包的依赖,再重打包载具。这里的依赖指整个模组包,资源标识的 GUID 用于区分特效选择项。
    3. 用同一平台的包安装并试车,射击空地和装甲目标,观察新弹道是否播放、旧效果是否能回退、短时效果是否能回收。若只显示基础效果,先查键名拼写、依赖是否加载,再核对优先使用的特效包。多个已安装对象池注册同一个键时,游戏优先用当前选中的特效包。

    教学对象池键绑定到炮弹弹道

    点击展开 MCP 操作点击收起 MCP 操作
    [
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.BulletVFX)",
            "${bulletVfx}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${bulletVfx}/weaponProjectileEffect",
          "value": "TutorialVFX"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect",
        "arguments": {
          "path": "asset:${bulletVfx}/weaponProjectileEffect"
        },
        "expect": {
          "contains": "(String) TutorialVFX"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.EditorUtility/SetDirty",
          "args": [
            "@asset:${bulletVfx}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/SaveAssets",
          "args": []
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "asset:${pipeline}/linkedObjects/Add",
          "args": [
            "@asset:${pool}"
          ]
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.EditorUtility/SetDirty",
          "args": [
            "@asset:${pipeline}"
          ]
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/SaveAssets",
          "args": []
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "modpack_plan",
        "arguments": {
          "pipeline": "${pipeline}"
        },
        "expect": {
          "equals": {
            "ok": true,
            "built": false
          },
          "contains": "\"pooldata\""
        },
        "phase": "build"
      },
      {
        "tool": "modpack_build",
        "arguments": {
          "pipeline": "${pipeline}"
        },
        "expect": {
          "equals": {
            "ok": true,
            "archiveExists": true,
            "published": false,
            "installed": false
          }
        },
        "capture": {
          "archivePath": {
            "path": "archivePath"
          }
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:Frontend.Editor.ModPackageWorkshopMeta/WriteSidecar",
          "args": [
            "${archivePath}"
          ]
        },
        "expect": {
          "contains": ".modpack.json"
        },
        "capture": {
          "sidecarPath": {
            "regex": "\\(String\\) (.+)"
          }
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:System.IO.File/ReadAllText",
          "args": [
            "${sidecarPath}"
          ]
        },
        "expect": {
          "contains": "${packageGuid}"
        },
        "phase": "build"
      }
    ]
    
    In this article
    Back to top Panzer War Document