创造第一把武器
本教程将指导你创建一个简单的 Mod ，实现修改游戏内某个基础功能的功能。
信息
本教程的 Mod 代码储存在 Github 上。
本章节大部分代码来自 Frostbite。感谢 Frostbite 对本教程的帮助。
创建 Mod 项目
按照教程创造名为 FirstWeapon 的 Mod 项目。
制作 res.pak
按照教程制作一个diff pak。CDB中应包括：
- 一个名为 OtherDashSword 新武器以及它对应的 item
提示
OtherDashSword 可以换为其他名字。
一个现成的 res.pak。
复制 res.pak
- 将上一步获得的res.pak复制到项目根目录下。
- 修改FirstWeapon.csproj，添加以下内容
<ItemGroup>
<!--将res.pak文件复制到bin\Debug\net9.0目录-->
<None Update="res.pak">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<!--将res.pak文件复制到最终的输出目录-->
<OutputFiles Include="res.pak" />
</ItemGroup>
编写代码
加载 res.pak
- 修改
FirstWeaponMod.FirstWeapon类，使其实现IOnGameEndInit接口。
//加载res.pak并刷新CDB
void IOnGameEndInit.OnGameEndInit()
{
var res = Info.ModRoot!.GetFilePath("res.pak"); //获取 Mod 根目录 下的 res.pak 文件的绝对路径
FsPak.Instance.FileSystem.loadPak(res.AsHaxeString()); //加载 res.pak
var json = CDBManager.Class.instance.getAlteredCDB(); //获取合并后的 CDB Json
Data.Class.loadJson( //加载合并后的 CDB Json
json,
default);
}
信息
成功加载 res.pak 后，你可以在日志中看到类似的内容：
[14:30:13 INF][FsPak] Loading pak from C:\SteamLibrary\steamapps\common\Dead Cells\coremod\mods\FirstWeapon\res.pak
信息
IOnGameExit接口和IOnGameEndInit接口都是事件系统的一部分。它们会在对应的事件触发时被调用。
IOnGameExit将会在游戏退出前调用。OnGameEndInit将会在游戏初始化后被调用。IOnHeroUpdate将会在游戏内每帧调用一次。
创造武器类
创造一个 FirstWeaponMod.OtherDashSwordWeapon 类，使其继承于DashSword类并实现IHxbitSerializable<object>接口。
//武器类
internal class OtherDashSwordWeapon :
DashSword, //基类
IHxbitSerializable<object>
{
//默认构造方法
public OtherDashSwordWeapon(Hero o, InventItem i) : base(o, i)
{
}
//留空
object IHxbitSerializable<object>.GetData()
{
return new(); //TODO
}
//留空
void IHxbitSerializable<object>.SetData(object data)
{
//TODO
}
// 测试效果——每帧增加10细胞
public override void fixedUpdate()
{
base.fixedUpdate();
bool noStats = false;
this.owner.addCells(10, new HaxeProxy.Runtime.Ref<bool>(ref noStats));
}
}
信息
IHxbitSerializable<>接口用于保存游戏对象的数据。
为了简单起见，武器类并没有直接继承于 Weapon类（所有武器的基类），而是继承于DashSword类。
注册新武器
仅仅将新武器的信息添加到 CDB 中是仍然是不够的。
为了让游戏可以识别新武器，还需要修改FirstWeaponMod.FirstWeapon类，添加以下内容：
public override void Initialize()
{
Logger.Information("你好，世界");
Hook__Weapon.create += Hook__Weapon_create; //挂钩 $Weapon.create
}
private Weapon Hook__Weapon_create(Hook__Weapon.orig_create orig, dc.en.Hero o, InventItem i)
{
var id = i._itemData.id.ToString(); //获取武器id
if(id == "OtherDashSword")
{
return new OtherDashSwordWeapon(o, i); //返回自定义的武器
}
else
{
return orig(o, i); //调用原始方法
}
}
获取新武器
很明显，现在无法拿到新武器，因为目前它没有任何获取途径。
可以通过以下的代码创造新武器对应的物品：
//生成物品
private void SpawnWeapon(Hero hero)
{
InventItem testItem = new InventItem(new InventItemKind.Weapon("OtherDashSword".AsHaxeString()));
bool test_boolean = false;
ItemDrop itemDrop = new ItemDrop(hero._level, hero.cx, hero.cy, testItem, true, new HaxeProxy.Runtime.Ref<bool>(ref test_boolean));
// 生成掉落物后必须调用init方法，否则游戏会崩溃
itemDrop.init();
itemDrop.onDropAsLoot();
itemDrop.dx = hero.dx; // 不知道为什么要有这一步，但是原版代码这么写的
}
为了简单起见，使用以下代码使得在游戏中可以通过按下反斜杠来获取新武器
//实现IOnHeroUpdate接口
void IOnHeroUpdate.OnHeroUpdate(double dt)
{
if(Key.Class.isPressed(0xDC /**反斜杠键码**/))
{
SpawnWeapon(Game.Instance.HeroInstance!);
}
}