API 参考
tModLoader C# API 完整参考，包含示例和最佳实践
API 参考
所有级别
v2025.07.3.0
快速访问
核心类
ModItem
创建自定义物品的基类。继承 ModItem 来创建武器、工具、配件和消耗品。
关键方法：
SetDefaults()
设置物品属性，如伤害、大小、稀有度和使用方式
AddRecipes()
为你的物品定义合成配方
UseItem(Player player)
物品使用时的自定义行为
示例实现：
public class MagicSword : ModItem
{
public override void SetDefaults()
{
Item.damage = 80;
Item.DamageType = DamageClass.Magic;
Item.mana = 10;
Item.width = 44;
Item.height = 44;
Item.useTime = 25;
Item.useAnimation = 25;
Item.useStyle = ItemUseStyleID.Shoot;
Item.knockBack = 5;
Item.value = Item.buyPrice(gold: 5);
Item.rare = ItemRarityID.Pink;
Item.UseSound = SoundID.Item20;
Item.autoReuse = true;
Item.shoot = ProjectileID.MagicMissile;
Item.shootSpeed = 16f;
}
}ModNPC
创建自定义 NPC，包括敌人、城镇 NPC 和带有自定义 AI 与行为的 Boss。
核心方法：
SetDefaults()
设置 NPC 属性和特性
AI()
自定义 AI 行为逻辑
ModifyNPCLoot()
定义掉落表和战利品
OnKill()
NPC 被击杀时的行为
public class ExampleEnemy : ModNPC
{
public override void SetDefaults()
{
NPC.width = 40;
NPC.height = 56;
NPC.damage = 15;
NPC.defense = 6;
NPC.lifeMax = 100;
NPC.HitSound = SoundID.NPCHit1;
NPC.DeathSound = SoundID.NPCDeath2;
NPC.value = 60f;
NPC.knockBackResist = 0.5f;
NPC.aiStyle = NPCAIStyleID.Fighter;
AIType = NPCID.Zombie;
}
}常用开发模式
创建配方
public override void AddRecipes()
{
Recipe recipe = CreateRecipe();
recipe.AddIngredient(ItemID.IronBar, 5);
recipe.AddIngredient(ItemID.Wood, 10);
recipe.AddIngredient(ModContent.ItemType<CustomItem>(), 1);
recipe.AddTile(TileID.WorkBenches);
recipe.AddCondition(Recipe.Condition.InGraveyard);
recipe.Register();
}配方在多人联机中自动同步，并会出现在配方浏览器中。
自定义弹幕
public class MagicBolt : ModProjectile
{
public override void SetDefaults()
{
Projectile.width = 16;
Projectile.height = 16;
Projectile.friendly = true;
Projectile.penetrate = 3;
Projectile.timeLeft = 600;
Projectile.light = 0.5f;
Projectile.DamageType = DamageClass.Magic;
}
public override void AI()
{
// Custom movement and visual effects
Projectile.rotation += 0.4f;
if (Main.rand.NextBool(3))
{
Dust.NewDust(Projectile.position, Projectile.width,
Projectile.height, DustID.Electric);
}
}
}全局修改
使用 Global 类修改现有游戏内容：
public class GlobalItemChanges : GlobalItem
{
public override void SetStaticDefaults()
{
// Modify all items of a specific type
}
public override void ModifyTooltips(Item item, List<TooltipLine> tooltips)
{
if (item.type == ItemID.TerraBlade)
{
tooltips.Add(new TooltipLine(Mod, "CustomTooltip",
"Enhanced by YourMod!"));
}
}
}最佳实践
推荐做法
- 使用 ModContent.ItemType<T>() 引用自定义物品
- 实现正确的空值检查
- 使用有意义的变量和类名
- 在多人联机环境中测试
- 遵循 C# 命名规范
- 用注释记录你的代码
避免做法
- 不要硬编码物品 ID - 使用常量
- 不要在多人联机中直接访问 Main.player
- 不要忘记处理边界情况
- 不要在 AI() 方法中使用重量级操作
- 不要不必要地修改原版内容
- 不要忽略编译器警告
实用工具和辅助方法
常用辅助方法
// Get item type from mod item class
int itemType = ModContent.ItemType<MyCustomItem>();
// Check if mod is loaded
bool calamityLoaded = ModLoader.HasMod("CalamityMod");
// Create dust effects
Dust.NewDust(position, width, height, DustID.Electric);
// Spawn projectiles
Projectile.NewProjectile(source, position, velocity, type, damage, knockback);
// Play sounds
SoundEngine.PlaySound(SoundID.Item1, position);网络通信辅助
// Send data to server
ModPacket packet = Mod.GetPacket();
packet.Write((byte)MessageType.ExampleMessage);
packet.Write(someData);
packet.Send();
// Handle received packets
public override void HandlePacket(BinaryReader reader, int whoAmI)
{
MessageType msgType = (MessageType)reader.ReadByte();
switch (msgType)
{
case MessageType.ExampleMessage:
// Handle message
break;
}
}