Referencia de la API
Referencia completa de la API de C# de tModLoader con ejemplos y mejores prácticas
Acceso Rápido
Clases Principales
ModItem
La clase base para crear objetos personalizados. Hereda de ModItem para crear armas, herramientas, accesorios y consumibles.
Métodos Principales:
SetDefaults()
Establece propiedades del objeto como daño, tamaño, rareza y estilo de uso
AddRecipes()
Define recetas de crafteo para tu objeto
UseItem(Player player)
Comportamiento personalizado cuando se usa el objeto
Ejemplo de Implementación:
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
Crea NPCs personalizados incluyendo enemigos, NPCs de pueblo y jefes con IA y comportamiento personalizado.
Métodos Esenciales:
SetDefaults()
Establece estadísticas y propiedades del NPC
AI()
Lógica de comportamiento de IA personalizada
ModifyNPCLoot()
Define tablas de drop y botín
OnKill()
Acciones cuando el NPC es 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;
}
}Patrones Comunes de Desarrollo
Crear Recetas
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();
}Las recetas se sincronizan automáticamente en multijugador y aparecen en los navegadores de recetas.
Proyectiles 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);
}
}
}Modificaciones Globales
Modifica el contenido existente del juego usando clases 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!"));
}
}
}Mejores Prácticas
Do's
- Use ModContent.ItemType<T>() for referencing custom items
- Implementa verificación adecuada de null
- Usa nombres significativos de variables y clases
- Prueba en entorno multijugador
- Sigue las convenciones de nombres de C#
- Documenta tu código con comentarios
Don'ts
- No codifiques IDs de objetos directamente - usa constantes
- No accedas a Main.player directamente en multijugador
- No olvides manejar los casos límite
- No uses operaciones pesadas en los métodos AI()
- No modifiques el contenido vanilla innecesariamente
- No ignores las advertencias del compilador
Utilidades y Ayudantes Útiles
Métodos de Ayuda Comunes
// 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);Ayudantes de Red
// 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;
}
}