Referência da API
Referência completa da API C# do tModLoader com exemplos e boas práticas
Acesso Rápido
Classes Principais
ModItem
A classe base para criar itens personalizados. Herde de ModItem para criar armas, ferramentas, acessórios e consumíveis.
Métodos Principais:
SetDefaults()
Define propriedades do item como dano, tamanho, raridade e estilo de uso
AddRecipes()
Define receitas de crafting para seu item
UseItem(Player player)
Comportamento personalizado quando o item é usado
Exemplo de Implementação:
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
Crie NPCs personalizados incluindo inimigos, NPCs da cidade e chefes com IA e comportamento personalizados.
Métodos Essenciais:
SetDefaults()
Define estatísticas e propriedades do NPC
AI()
Lógica de comportamento de IA personalizada
ModifyNPCLoot()
Define tabelas de drop e loot
OnKill()
Ações quando o NPC é eliminado
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;
}
}Padrões Comuns de Desenvolvimento
Criando Receitas
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();
}As receitas são sincronizadas automaticamente em multiplayer e aparecem nos navegadores de receitas.
Projéteis Personalizados
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);
}
}
}Modificações Globais
Modifique conteúdo existente do jogo usando classes 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!"));
}
}
}Boas Práticas
Faça
- Use ModContent.ItemType<T>() para referenciar itens personalizados
- Implemente verificação adequada de null
- Use nomes significativos para variáveis e classes
- Teste em ambiente multiplayer
- Siga as convenções de nomenclatura do C#
- Documente seu código com comentários
Não Faça
- Não codifique IDs de itens diretamente - use constantes
- Não acesse Main.player diretamente em multiplayer
- Não esqueça de tratar casos extremos
- Não use operações pesadas em métodos AI()
- Não modifique conteúdo vanilla desnecessariamente
- Não ignore avisos do compilador
Utilitários e Helpers Úteis
Métodos Helper Comuns
// 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);Helpers de Rede
// 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;
}
}