RE 类注入器

RE 类注入器

一个面向RE引擎的早期插件加载器与原生类型扩展框架。创建自定义类、组件与UserData,在关键游戏初始化之前完成集成,并围绕RE引擎的原生系统构建新功能。

[size=6][b]RE Class Injector[/b][/size]
[b]创建新类型。添加你自己的组件。更早集成。[/b]

RE Class Injector 是《怪物猎人:荒野》的一个早期插件加载器和运行时类型扩展框架。

它允许模组开发者向 RE Engine 引入自己的类、组件和 UserData 类型,并在关键游戏初始化发生之前准备好它们的集成。

[b]对玩家而言,使用 Class Injector 构建的模组所需的依赖项。对开发者而言,它提供了通过游戏原生系统扩展游戏的基础。[/b]

[size=5][b]为什么选择 Class Injector?[/b][/size]

[size=4][b]更早访问游戏初始化[/b][/size]
有些系统仅在启动期间初始化一次。它们会构建类型列表、创建对象或缓存后续游戏玩法所依赖的数据。

传统的 REFramework 插件必须等到 REFramework 获取并准备好游戏的类型数据库之后,才能执行依赖 TDB 的操作。到那时,部分初始化可能已经完成。事后安装钩子并不会自动改变最初那些调用期间已经发生的事情。

Class Injector 提供了一个更早的集成点:[b]在引擎的类型数据库和原生方法条目就绪之后,但在全局静态构造函数执行之前。[/b]

这使得参与的插件能够在后续初始化运行之前准备好集成,而不必事后修改或重建其结果。

不引入任何自定义类型的插件也可以将 Class Injector 用作早期加载器。

[size=4][b]构建新行为,而不仅仅是修改现有行为[/b][/size]
许多模组通过拦截现有函数并更改其结果来工作。钩子仍然有用,但并非每个新功能都需要围绕它们来组织。

Class Injector 允许开发者定义引擎能够识别和使用的类型:
[list]
[][b]自定义类[/b],拥有自己的字段和方法。[/]
[][b]自定义组件[/b],参与原生组件生命周期。[/]
[][b]自定义 UserData 类型[/b],用于由资源支持的配置。[/]
[][b]继承、虚方法重写和现有接口[/b],用于与兼容的原生系统集成。[/]
[/list]开发者不必将每个功能的状态存储在外部表中并通过共享钩子更新,而是可以围绕各个对象和组件来组织行为。

[size=4][b]更原生、基于组件的创作工作流[/b][/size]
熟悉 Unity 等引擎的开发者会熟悉这种方式:

[b]组件定义行为。数据对象定义参数。资源组合功能。引擎驱动适用的生命周期。[/b]

例如,一个自定义行为可以拥有自己的组件类型,引用自定义 UserData 配置,并将运行时状态存储在实例字段中。多个对象可以复用该组件,同时保持独立状态。

目标是让 RE Engine 模组开发感觉更接近于为该引擎创建内容——而不仅仅是修改游戏中已有的逻辑。

[size=5][b]主要功能[/b][/size]
[list]
[][b]早期插件加载[/b]以及早期类型系统就绪回调。[/]
[][b]自定义托管类[/b],包括字段、方法和构造函数。[/]
[][b]自定义组件[/b],使用兼容的原生生命周期路径。[/]
[][b]自定义 UserData 类型[/b],具有由资源支持的字段。[/]
[][b]继承和虚方法重写。[/b][/]
[][b]实现现有接口。[/b][/]
[][b]在符合条件的现有托管类上添加额外字段。[/b][/]
[][b]扩展现有 Int32 枚举。[/b][/]
[][b]与 REFramework Lua 集成[/b],以访问已注册的类型。[/]
[/list]新类型仍然需要适当的资源以及与使用它们的系统的连接。Class Injector 提供基础;各个模组提供自己的内容和行为。

[size=5][b]面向玩家[/b][/size]
[b]Class Injector 本身不添加游戏内容。[/b]当其他模组将其列为依赖项时安装它。

[size=4][b]安装[/b][/size]
[list=1]
[]将 Class Injector 发行版解压到你的《怪物猎人:荒野》安装目录中。[/]
[]确保 [b]hid.dll[/b] 与 [b]MonsterHunterWilds.exe[/b] 位于同一目录。[/]
[]按照说明安装依赖模组,并保留其文件夹结构。[/]
[]完全重启游戏。[/]
[/list]依赖模组通常将其 Class Injector 插件文件放在:
[code]MonsterHunterWilds/
|-- MonsterHunterWilds.exe
|-- hid.dll
|-- reframework/
    |-- plugins/
        |-- ExampleMod.dll
        |-- ExampleMod.toml[/code]将每个插件的 DLL 和匹配的 TOML 文件放在一起。

[b]如果你的安装中已经包含另一个 hid.dll,请在替换之前查看相关模组的安装说明。[/b]

[size=4][b]更新或移除模组[/b][/size]
在更新 Class Injector 或其依赖插件之前,请完全关闭游戏。

移除 Class Injector 时,也请移除或禁用需要它的模组。

[size=5][b]面向模组开发者[/b][/size]
当你的模组需要以下内容时,请使用 Class Injector:
[list]
[]在系统完成初始设置之前进行集成。[/]
[]定义新组件,而不是复用无关的内置类型。[/]
[]让自定义配置拥有自己的 UserData 类型。[/]
[]将运行时状态附加到各个引擎对象上。[/]
[]向其他插件暴露共享类型契约。[/]
[]将资源驱动的配置与原生行为相结合。[/]
[/list]类型在 TOML 中声明,行为由 C++ provider 实现。一旦 REFramework SDK 就绪,REFramework Lua 就可以访问已注册的类型。

[b]早期回调并不会让 REFramework SDK 更早可用。[/b]早期集成使用 Class Injector 自己的接口;依赖 SDK 的工作必须等待 SDK 正常可用。

[b]开发者文档和公共 SDK 头文件:[/b]
[url=https://github.com/kassent/REClassInjector]GitHub 上的 RE Class Injector[/url]

该仓库包含英文和中文开发者指南,以及公共 ClassProvider.h 头文件。有关声明、生命周期要求、资源集成和示例,请参阅这些指南。

[size=5][b]兼容性说明[/b][/size]
[list]
[]专为 [b]《怪物猎人:荒野》[/b]设计。[/]
[]游戏更新可能需要兼容的 Class Injector 发行版以及依赖模组的更新。[/]
[]Class Injector 是对 REFramework 的补充;它并不替代 REFramework。[/]
[]自定义类型不会自动连接到每个游戏系统。每个模组必须提供相应的集成。[/]
[]更改插件 DLL 或类型声明后,请重启游戏。[/]
[/list][size=5][b]报告问题[/b][/size]
报告问题时,请包含:
[list]
[]你的游戏版本。[/]
[]你的 Class Injector 版本。[/]
[]依赖模组的名称和版本。[/]
[]相关日志。[/]
[]复现步骤。[/]
[/list]如果问题仅在某个特定依赖模组下出现,请提供该信息,以便将问题追溯到正确的集成。