ModNPC.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.IO;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using ReLogic.Utilities;
using Terraria.DataStructures;
using Terraria.GameContent;
using Terraria.GameContent.Bestiary;
using Terraria.GameContent.UI;
using Terraria.ID;
using Terraria.Localization;
using Terraria.ModLoader.IO;
 
namespace Terraria.ModLoader;
 
public abstract class ModNPC : ModType<NPC, ModNPC>, ILocalizedModType, IModType
{
    public NPC NPC => base.Entity;
 
    public int Type => NPC.type;
 
    public virtual string LocalizationCategory => "NPCs";
 
    public virtual LocalizedText DisplayName => this.GetLocalization("DisplayName", base.PrettyPrintName);
 
    public virtual string Texture => (GetType().Namespace + "." + Name).Replace('.', '/');
 
    public virtual string HeadTexture => Texture + "_Head";
 
    public virtual string BossHeadTexture => Texture + "_Head_Boss";
 
    public int AIType { get; set; }
 
    public int AnimationType { get; set; }
 
    public int Music { get; set; } = -1;
 
 
    public SceneEffectPriority SceneEffectPriority { get; set; } = SceneEffectPriority.BossLow;
 
 
    public float DrawOffsetY { get; set; }
 
    public int Banner { get; set; }
 
    public int BannerItem { get; set; }
 
    public int[] SpawnModBiomes { get; set; } = new int[0];
 
 
    public bool TownNPCStayingHomeless { get; set; }
 
    protected override NPC CreateTemplateEntity()
    {
        return new NPC
        {
            ModNPC = this
        };
    }
 
    protected sealed override void Register()
    {
        ModTypeLookup<ModNPC>.Register(this);
        NPC.type = NPCLoader.Register(this);
        Type type = GetType();
        if (type.GetAttribute<AutoloadHead>() != null)
        {
            base.Mod.AddNPCHeadTexture(NPC.type, HeadTexture);
        }
        if (type.GetAttribute<AutoloadBossHead>() != null)
        {
            base.Mod.AddBossHeadTexture(BossHeadTexture, NPC.type);
        }
    }
 
    public virtual int? PickEmote(Player closestPlayer, List<int> emoteList, WorldUIAnchor otherAnchor)
    {
        return null;
    }
 
    public sealed override void SetupContent()
    {
        NPCLoader.SetDefaults(NPC, createModNPC: false);
        AutoStaticDefaults();
        SetStaticDefaults();
        NPCID.Search.Add(base.FullName, Type);
    }
 
    public virtual void SetDefaults()
    {
    }
 
    public virtual void OnSpawn(IEntitySource source)
    {
    }
 
    public virtual void AutoStaticDefaults()
    {
        TextureAssets.Npc[NPC.type] = ModContent.Request<Texture2D>(Texture);
        if (Banner != 0 && BannerItem != 0)
        {
            NPCLoader.bannerToItem[Banner] = BannerItem;
        }
        else if (Banner != 0 || BannerItem != 0)
        {
            Logging.tML.Warn((object)Language.GetTextValue("tModLoader.LoadWarningBannerOrBannerItemNotSet", base.Mod.DisplayName, Name));
        }
        if (NPC.lifeMax > 32767 || NPC.boss)
        {
            Main.npcLifeBytes[NPC.type] = 4;
        }
        else if (NPC.lifeMax > 127)
        {
            Main.npcLifeBytes[NPC.type] = 2;
        }
        else
        {
            Main.npcLifeBytes[NPC.type] = 1;
        }
    }
 
    public virtual void ApplyDifficultyAndPlayerScaling(int numPlayers, float balance, float bossAdjustment)
    {
    }
 
    public virtual void SetBestiary(BestiaryDatabase database, BestiaryEntry bestiaryEntry)
    {
    }
 
    public virtual void ModifyTypeName(ref string typeName)
    {
    }
 
    public virtual void ModifyHoverBoundingBox(ref Rectangle boundingBox)
    {
    }
 
    public virtual List<string> SetNPCNameList()
    {
        return new List<string>();
    }
 
    public virtual ITownNPCProfile TownNPCProfile()
    {
        return null;
    }
 
    public virtual void ResetEffects()
    {
    }
 
    public virtual bool PreAI()
    {
        return true;
    }
 
    public virtual void AI()
    {
    }
 
    public virtual void PostAI()
    {
    }
 
    public virtual void SendExtraAI(BinaryWriter writer)
    {
    }
 
    public virtual void ReceiveExtraAI(BinaryReader reader)
    {
    }
 
    public virtual void FindFrame(int frameHeight)
    {
    }
 
    public virtual void HitEffect(NPC.HitInfo hit)
    {
    }
 
    public virtual void UpdateLifeRegen(ref int damage)
    {
    }
 
    public virtual bool CheckActive()
    {
        return true;
    }
 
    public virtual bool CheckDead()
    {
        return true;
    }
 
    public virtual bool SpecialOnKill()
    {
        return false;
    }
 
    public virtual bool PreKill()
    {
        return true;
    }
 
    public virtual void OnKill()
    {
    }
 
    public virtual bool? CanFallThroughPlatforms()
    {
        return null;
    }
 
    public virtual bool? CanBeCaughtBy(Item item, Player player)
    {
        return null;
    }
 
    public virtual void OnCaughtBy(Player player, Item item, bool failed)
    {
    }
 
    public virtual void ModifyNPCLoot(NPCLoot npcLoot)
    {
    }
 
    public virtual void BossLoot(ref string name, ref int potionType)
    {
    }
 
    public virtual bool CanHitPlayer(Player target, ref int cooldownSlot)
    {
        return true;
    }
 
    public virtual void ModifyHitPlayer(Player target, ref Player.HurtModifiers modifiers)
    {
    }
 
    public virtual void OnHitPlayer(Player target, Player.HurtInfo hurtInfo)
    {
    }
 
    public virtual bool CanHitNPC(NPC target)
    {
        return true;
    }
 
    public virtual bool CanBeHitByNPC(NPC attacker)
    {
        return true;
    }
 
    public virtual void ModifyHitNPC(NPC target, ref NPC.HitModifiers modifiers)
    {
    }
 
    public virtual void OnHitNPC(NPC target, NPC.HitInfo hit)
    {
    }
 
    public virtual bool? CanBeHitByItem(Player player, Item item)
    {
        return null;
    }
 
    public virtual bool? CanCollideWithPlayerMeleeAttack(Player player, Item item, Rectangle meleeAttackHitbox)
    {
        return null;
    }
 
    public virtual void ModifyHitByItem(Player player, Item item, ref NPC.HitModifiers modifiers)
    {
    }
 
    public virtual void OnHitByItem(Player player, Item item, NPC.HitInfo hit, int damageDone)
    {
    }
 
    public virtual bool? CanBeHitByProjectile(Projectile projectile)
    {
        return null;
    }
 
    public virtual void ModifyHitByProjectile(Projectile projectile, ref NPC.HitModifiers modifiers)
    {
    }
 
    public virtual void OnHitByProjectile(Projectile projectile, NPC.HitInfo hit, int damageDone)
    {
    }
 
    public virtual void ModifyIncomingHit(ref NPC.HitModifiers modifiers)
    {
    }
 
    public virtual void BossHeadSlot(ref int index)
    {
    }
 
    public virtual void BossHeadRotation(ref float rotation)
    {
    }
 
    public virtual void BossHeadSpriteEffects(ref SpriteEffects spriteEffects)
    {
    }
 
    public virtual Color? GetAlpha(Color drawColor)
    {
        return null;
    }
 
    public virtual void DrawEffects(ref Color drawColor)
    {
    }
 
    public virtual bool PreDraw(SpriteBatch spriteBatch, Vector2 screenPos, Color drawColor)
    {
        return true;
    }
 
    public virtual void PostDraw(SpriteBatch spriteBatch, Vector2 screenPos, Color drawColor)
    {
    }
 
    public virtual void DrawBehind(int index)
    {
    }
 
    public virtual bool? DrawHealthBar(byte hbPosition, ref float scale, ref Vector2 position)
    {
        return null;
    }
 
    public virtual float SpawnChance(NPCSpawnInfo spawnInfo)
    {
        return 0f;
    }
 
    public virtual int SpawnNPC(int tileX, int tileY)
    {
        return NPC.NewNPC(null, tileX * 16 + 8, tileY * 16, NPC.type);
    }
 
    public virtual bool CanTownNPCSpawn(int numTownNPCs)
    {
        return false;
    }
 
    public virtual bool CheckConditions(int left, int right, int top, int bottom)
    {
        return true;
    }
 
    public virtual bool UsesPartyHat()
    {
        return true;
    }
 
    public virtual bool CanChat()
    {
        return NPC.townNPC;
    }
 
    public virtual string GetChat()
    {
        return Language.GetTextValue("tModLoader.DefaultTownNPCChat");
    }
 
    public virtual void SetChatButtons(ref string button, ref string button2)
    {
    }
 
    public virtual void OnChatButtonClicked(bool firstButton, ref string shopName)
    {
    }
 
    public virtual void AddShops()
    {
    }
 
    public virtual void ModifyActiveShop(string shopName, Item[] items)
    {
    }
 
    public virtual bool CanGoToStatue(bool toKingStatue)
    {
        return false;
    }
 
    public virtual void OnGoToStatue(bool toKingStatue)
    {
    }
 
    public virtual void TownNPCAttackStrength(ref int damage, ref float knockback)
    {
    }
 
    public virtual void TownNPCAttackCooldown(ref int cooldown, ref int randExtraCooldown)
    {
    }
 
    public virtual void TownNPCAttackProj(ref int projType, ref int attackDelay)
    {
    }
 
    public virtual void TownNPCAttackProjSpeed(ref float multiplier, ref float gravityCorrection, ref float randomOffset)
    {
    }
 
    public virtual void TownNPCAttackShoot(ref bool inBetweenShots)
    {
    }
 
    public virtual void TownNPCAttackMagic(ref float auraLightMultiplier)
    {
    }
 
    public virtual void TownNPCAttackSwing(ref int itemWidth, ref int itemHeight)
    {
    }
 
    public virtual void DrawTownAttackGun(ref Texture2D item, ref Rectangle itemFrame, ref float scale, ref int horizontalHoldoutOffset)
    {
    }
 
    public virtual void DrawTownAttackSwing(ref Texture2D item, ref Rectangle itemFrame, ref int itemSize, ref float scale, ref Vector2 offset)
    {
    }
 
    public virtual bool ModifyCollisionData(Rectangle victimHitbox, ref int immunityCooldownSlot, ref MultipliableFloat damageMultiplier, ref Rectangle npcHitbox)
    {
        return true;
    }
 
    public virtual bool NeedSaving()
    {
        return false;
    }
 
    public virtual void SaveData(TagCompound tag)
    {
    }
 
    public virtual void LoadData(TagCompound tag)
    {
    }
}