概述
在开始使用通用库存系统(GIS)之前,需要完成以下准备工作以确保顺利集成和使用。本节介绍如何启用插件、获取配套项目、熟悉项目内容以及迁移到现有项目。
启用插件
安装并启用 GenericInventorySystem。插件描述符显式依赖 ModularGameplay;使用配套项目的 UI 或交互示例时,还需根据引用启用 GenericGameSystem、CommonUI、GameplayAbilities、Smart Objects 等依赖。
获取配套项目
通过Discord 验证购买 以获取配套项目。验证后,你将获得一个完整项目,包含:
- 核心资产文件
- 额外资产
- 演示(Demo)内容
注意
请参考配套项目进行学习使用,里面的内容足够你了解GIS的运作方式,因此,文档无法对GIS的所有功能进行一比一还原。
建议结合本文档和配套项目一起学习,以快速掌握 GIS 的使用。
熟悉项目内容
配套项目包含以下文件夹结构:
提示
尽量不要修改GenericDemo文件夹下的内容,因为它仅用于参考,帮助你学习了解用法。如果你认为Demo的内容也能满足你的需求,那么你可以将将整个文件夹复制一份到别处并开始修改它。
完全API
GIS_Demo 关卡的 APIGraph 可用于查看部分蓝图节点示例;完整 API 请以当前插件的蓝图节点和 Public 头文件为准。
此外,BP_GIS_UnitTester 蓝图包含对各种 API 的测试内容,帮助你更清晰地理解其用法。
迁移到你的项目
建议先熟悉 GIS_Demo 项目后再迁移到现有项目,以便更好地选择所需内容和排除不需要的内容。 如果是新项目,可直接以 GIS_Demo 为基础开始开发。
迁移内容
先检查目标资产的引用及其插件依赖,再使用 Unreal 的迁移工具迁移实际需要的资产。演示内容与共享内容是否需要取决于选用的资产;不要假定整个 GenericGame 文件夹或单纯复制文件即可满足依赖。
迁移标签
按所迁移内容检查并合并所需 Gameplay Tags 配置,确认项目的标签导入设置;不要直接覆盖目标项目已有配置。
迁移设置
对照配套项目和目标项目的配置,按需合并设置、输入及标签,并检查项目描述文件中所需插件。
更新注意事项
GIS 将持续更新,每次代码发布新版本时,配套项目也会同步更新。 最简单的更新方式是重复上述迁移步骤。 但随着 GIS 的迭代,文件路径可能变更,新增功能可能引入,旧功能可能移除。为便于更新,建议:
- 将 GenericGame 和 GenericDemo 中的内容视为参考资源,避免直接修改。
- GIS 提供的 Widget 设计为高度可复用,建议复制后修改样式。
- 版本更新后检查提供的重定向、资产引用与配置差异,验证迁移结果。
配套项目中的具体路径和示例入口见配套项目与示例资产。