tModLoader How does one create a new type of damage?

Comic Sans MS

Comic Sans MS

Terrarian
I'm new to modding and am trying to create a new weapon class. Could someone explain it here or link me a video about how to do it?
 
This is from the ExampleMod included in tModLoader. I hope it helps.

Code: 
using System.Collections.Generic;
using System.Linq;
using Terraria;
using Terraria.ModLoader;

namespace ExampleMod.Items.ExampleDamageClass
{
    // This class handles everything for our custom damage class
    // Any class that we wish to be using our custom damage class will derive from this class, instead of ModItem
    public abstract class ExampleDamageItem : ModItem
    {
        public override bool CloneNewInstances => true;
        public int exampleResourceCost = 0;

        // Custom items should override this to set their defaults
        public virtual void SafeSetDefaults() {
        }

        // By making the override sealed, we prevent derived classes from further overriding the method and enforcing the use of SafeSetDefaults()
        // We do this to ensure that the vanilla damage types are always set to false, which makes the custom damage type work
        public sealed override void SetDefaults() {
            SafeSetDefaults();
            // all vanilla damage types must be false for custom damage types to work
            item.melee = false;
            item.ranged = false;
            item.magic = false;
            item.thrown = false;
            item.summon = false;
        }

        // As a modder, you could also opt to make these overrides also sealed. Up to the modder
        public override void ModifyWeaponDamage(Player player, ref float add, ref float mult, ref float flat) {
            add += ExampleDamagePlayer.ModPlayer(player).exampleDamageAdd;
            mult *= ExampleDamagePlayer.ModPlayer(player).exampleDamageMult;
        }

        public override void GetWeaponKnockback(Player player, ref float knockback) {
            // Adds knockback bonuses
            knockback += ExampleDamagePlayer.ModPlayer(player).exampleKnockback;
        }

        public override void GetWeaponCrit(Player player, ref int crit) {
            // Adds crit bonuses
            crit += ExampleDamagePlayer.ModPlayer(player).exampleCrit;
        }

        // Because we want the damage tooltip to show our custom damage, we need to modify it
        public override void ModifyTooltips(List<TooltipLine> tooltips) {
            // Get the vanilla damage tooltip
            TooltipLine tt = tooltips.FirstOrDefault(x => x.Name == "Damage" && x.mod == "Terraria");
            if (tt != null) {
                // We want to grab the last word of the tooltip, which is the translated word for 'damage' (depending on what language the player is using)
                // So we split the string by whitespace, and grab the last word from the returned arrays to get the damage word, and the first to get the damage shown in the tooltip
                string[] splitText = tt.text.Split(' ');
                string damageValue = splitText.First();
                string damageWord = splitText.Last();
                // Change the tooltip text
                tt.text = damageValue + " example " + damageWord;
            }

            if(exampleResourceCost > 0) {
                tooltips.Add(new TooltipLine(mod, "Example Resource Cost", $"Uses {exampleResourceCost} example resource"));
            }
        }

        // Make sure you can't use the item if you don't have enough resource and then use 10 resource otherwise.
        public override bool CanUseItem(Player player) {
            var exampleDamagePlayer = player.GetModPlayer<ExampleDamagePlayer>();

            if (exampleDamagePlayer.exampleResourceCurrent >= exampleResourceCost) {
                exampleDamagePlayer.exampleResourceCurrent -= exampleResourceCost;
                return true;
            }
            return false;
        }
    }
}
 

Attachments

  • ExampleDamageItem.cs
    3.1 KB · Views: 248
  • ExampleDamagePlayer.cs
    3.8 KB · Views: 246
Graumen said:
This is from the ExampleMod included in tModLoader. I hope it helps.

Code: 
using System.Collections.Generic;
using System.Linq;
using Terraria;
using Terraria.ModLoader;

namespace ExampleMod.Items.ExampleDamageClass
{
    // This class handles everything for our custom damage class
    // Any class that we wish to be using our custom damage class will derive from this class, instead of ModItem
    public abstract class ExampleDamageItem : ModItem
    {
        public override bool CloneNewInstances => true;
        public int exampleResourceCost = 0;

        // Custom items should override this to set their defaults
        public virtual void SafeSetDefaults() {
        }

        // By making the override sealed, we prevent derived classes from further overriding the method and enforcing the use of SafeSetDefaults()
        // We do this to ensure that the vanilla damage types are always set to false, which makes the custom damage type work
        public sealed override void SetDefaults() {
            SafeSetDefaults();
            // all vanilla damage types must be false for custom damage types to work
            item.melee = false;
            item.ranged = false;
            item.magic = false;
            item.thrown = false;
            item.summon = false;
        }

        // As a modder, you could also opt to make these overrides also sealed. Up to the modder
        public override void ModifyWeaponDamage(Player player, ref float add, ref float mult, ref float flat) {
            add += ExampleDamagePlayer.ModPlayer(player).exampleDamageAdd;
            mult *= ExampleDamagePlayer.ModPlayer(player).exampleDamageMult;
        }

        public override void GetWeaponKnockback(Player player, ref float knockback) {
            // Adds knockback bonuses
            knockback += ExampleDamagePlayer.ModPlayer(player).exampleKnockback;
        }

        public override void GetWeaponCrit(Player player, ref int crit) {
            // Adds crit bonuses
            crit += ExampleDamagePlayer.ModPlayer(player).exampleCrit;
        }

        // Because we want the damage tooltip to show our custom damage, we need to modify it
        public override void ModifyTooltips(List<TooltipLine> tooltips) {
            // Get the vanilla damage tooltip
            TooltipLine tt = tooltips.FirstOrDefault(x => x.Name == "Damage" && x.mod == "Terraria");
            if (tt != null) {
                // We want to grab the last word of the tooltip, which is the translated word for 'damage' (depending on what language the player is using)
                // So we split the string by whitespace, and grab the last word from the returned arrays to get the damage word, and the first to get the damage shown in the tooltip
                string[] splitText = tt.text.Split(' ');
                string damageValue = splitText.First();
                string damageWord = splitText.Last();
                // Change the tooltip text
                tt.text = damageValue + " example " + damageWord;
            }

            if(exampleResourceCost > 0) {
                tooltips.Add(new TooltipLine(mod, "Example Resource Cost", $"Uses {exampleResourceCost} example resource"));
            }
        }

        // Make sure you can't use the item if you don't have enough resource and then use 10 resource otherwise.
        public override bool CanUseItem(Player player) {
            var exampleDamagePlayer = player.GetModPlayer<ExampleDamagePlayer>();

            if (exampleDamagePlayer.exampleResourceCurrent >= exampleResourceCost) {
                exampleDamagePlayer.exampleResourceCurrent -= exampleResourceCost;
                return true;
            }
            return false;
        }
    }
}
Click to expand...

thanks. This is helpful. is there a page on the Tmodloader wiki that goes into more detail?
 
Graumen said:
This is from the ExampleMod included in tModLoader. I hope it helps.

Code: 
using System.Collections.Generic;
using System.Linq;
using Terraria;
using Terraria.ModLoader;

namespace ExampleMod.Items.ExampleDamageClass
{
    // This class handles everything for our custom damage class
    // Any class that we wish to be using our custom damage class will derive from this class, instead of ModItem
    public abstract class ExampleDamageItem : ModItem
    {
        public override bool CloneNewInstances => true;
        public int exampleResourceCost = 0;

        // Custom items should override this to set their defaults
        public virtual void SafeSetDefaults() {
        }

        // By making the override sealed, we prevent derived classes from further overriding the method and enforcing the use of SafeSetDefaults()
        // We do this to ensure that the vanilla damage types are always set to false, which makes the custom damage type work
        public sealed override void SetDefaults() {
            SafeSetDefaults();
            // all vanilla damage types must be false for custom damage types to work
            item.melee = false;
            item.ranged = false;
            item.magic = false;
            item.thrown = false;
            item.summon = false;
        }

        // As a modder, you could also opt to make these overrides also sealed. Up to the modder
        public override void ModifyWeaponDamage(Player player, ref float add, ref float mult, ref float flat) {
            add += ExampleDamagePlayer.ModPlayer(player).exampleDamageAdd;
            mult *= ExampleDamagePlayer.ModPlayer(player).exampleDamageMult;
        }

        public override void GetWeaponKnockback(Player player, ref float knockback) {
            // Adds knockback bonuses
            knockback += ExampleDamagePlayer.ModPlayer(player).exampleKnockback;
        }

        public override void GetWeaponCrit(Player player, ref int crit) {
            // Adds crit bonuses
            crit += ExampleDamagePlayer.ModPlayer(player).exampleCrit;
        }

        // Because we want the damage tooltip to show our custom damage, we need to modify it
        public override void ModifyTooltips(List<TooltipLine> tooltips) {
            // Get the vanilla damage tooltip
            TooltipLine tt = tooltips.FirstOrDefault(x => x.Name == "Damage" && x.mod == "Terraria");
            if (tt != null) {
                // We want to grab the last word of the tooltip, which is the translated word for 'damage' (depending on what language the player is using)
                // So we split the string by whitespace, and grab the last word from the returned arrays to get the damage word, and the first to get the damage shown in the tooltip
                string[] splitText = tt.text.Split(' ');
                string damageValue = splitText.First();
                string damageWord = splitText.Last();
                // Change the tooltip text
                tt.text = damageValue + " example " + damageWord;
            }

            if(exampleResourceCost > 0) {
                tooltips.Add(new TooltipLine(mod, "Example Resource Cost", $"Uses {exampleResourceCost} example resource"));
            }
        }

        // Make sure you can't use the item if you don't have enough resource and then use 10 resource otherwise.
        public override bool CanUseItem(Player player) {
            var exampleDamagePlayer = player.GetModPlayer<ExampleDamagePlayer>();

            if (exampleDamagePlayer.exampleResourceCurrent >= exampleResourceCost) {
                exampleDamagePlayer.exampleResourceCurrent -= exampleResourceCost;
                return true;
            }
            return false;
        }
    }
}
Click to expand...
do you think you could make one of these for a 'grim reaper' class that deals 'death' damage?
 
You must log in or register to reply here.
Back
Top Bottom