创建一个基础城镇NPC

设置基础属性

进入正题~

首先，创建一个新项，就起名叫TestTownNPC吧

你可能注意到了我在TeaNPC里做例子上面这个 [AutoloadHead]，这一小段代码就是自动加载一个NPC的小地图图标用的，小地图图标的名字为：该NPC的类名加_Head（比如TestTownNPC_Head）。

按照惯例，先使用SetStaticDefaults与SetDefaults进行基础属性设置，首先来说SetStaticDefaults里需要填的

int npcID = NPCID.Merchant;
public override void SetStaticDefaults()
{
    //游戏内显示的称呼
    DisplayName.SetDefault("测试小伙");

    //总帧数，根据使用贴图的实际帧数进行填写，这里我们直接调用全部商人的数据
    Main.npcFrameCount[Type] = Main.npcFrameCount[npcID];

    //特殊交互帧（如坐下，攻击）的数量，其作用就是规划这个NPC的最大行走帧数为多少，
    //最大行走帧数即Main.npcFrameCount - NPCID.Sets.ExtraFramesCount
    NPCID.Sets.ExtraFramesCount[Type] = NPCID.Sets.ExtraFramesCount[npcID];

    //攻击帧的数量，取决于你的NPC属于哪种攻击类型，如何填写见上文的分类讲解
    NPCID.Sets.AttackFrameCount[Type] = NPCID.Sets.AttackFrameCount[npcID];

    //NPC的攻击方式，同样取决于你的NPC属于哪种攻击类型，投掷型填0，远程型填1，魔法型填2，近战型填3，
    //如果是宠物没有攻击手段那么这条将不产生影响
    NPCID.Sets.AttackType[Type] = NPCID.Sets.AttackType[npcID];

    //NPC的帽子位置中Y坐标的偏移量，这里特指派对帽，
    //当你觉得帽子戴的太高或太低时使用这个做调整（所以为什么不给个X的）         
    NPCID.Sets.HatOffsetY[Type] = NPCID.Sets.HatOffsetY[npcID];

    //这个名字比较抽象，可以理解为 [记录了NPC的某些帧带来的身体起伏量的数组] 的索引值，
    //而这个数组的名字叫 NPCID.Sets.TownNPCsFramingGroups ，详情请在源码的NPCID.cs与Main.cs内进行搜索。
    //举个例子：你应该注意到了派对帽或是机械师背后的扳手在NPC走动时是会不断起伏的，靠的就是用这个进行调整，
    //所以说在画帧图时最好比着原版NPC的帧图进行绘制，方便各种数据调用
    //补充：这个属性似乎是针对城镇NPC的。
    NPCID.Sets.NPCFramingGroup[Type] = NPCID.Sets.NPCFramingGroup[npcID];

    //魔法型NPC在攻击时产生的魔法光环的颜色，如果NPCID.Sets.AttackType不为2那就不会产生光环
    //如果NPCID.Sets.AttackType为2那么默认为白色
    NPCID.Sets.MagicAuraColor[Type] = Color.White;

    //NPC的单次攻击持续时间，如果你的NPC需要持续施法进行攻击可以把这里设置的很长，
    //比如树妖的这个值就高达600
    //补充说明一点：如果你的NPC的AttackType为3即近战型，
    //这里最好选择套用，因为近战型NPC的单次攻击时间是固定的
    NPCID.Sets.AttackTime[Type] = NPCID.Sets.AttackTime[npcID];

    //NPC的危险检测范围，以像素为单位，这个似乎是半径
    NPCID.Sets.DangerDetectRange[Type] = 500;

    //NPC在遭遇敌人时发动攻击的概率，如果为0则该NPC不会进行攻击（待验证）
    //遇到危险时，该NPC在可以进攻的情况下每帧有 1 / (NPCID.Sets.AttackAverageChance * 2) 的概率发动攻击
    //注：每帧都判定
    NPCID.Sets.AttackAverageChance[Type] = 10;

    //图鉴设置部分
    //将该NPC划定为城镇NPC分类
    NPCID.Sets.TownNPCBestiaryPriority.Add(Type);
    NPCID.Sets.NPCBestiaryDrawModifiers drawModifiers = new NPCID.Sets.NPCBestiaryDrawModifiers(0)
    {
        //为NPC设置图鉴展示状态，赋予其Velocity即可展现出行走姿态
        Velocity = 1f,
    };
    //添加信息至图鉴
    NPCID.Sets.NPCBestiaryDrawOffset.Add(Type, drawModifiers);

    //设置对邻居和环境的喜恶，也就是幸福度设置
    //幸福度相关对话需要写在hjson里，见下文所讲
    NPC.Happiness
        .SetBiomeAffection<JungleBiome>(AffectionLevel.Hate)//憎恶丛林环境
        .SetBiomeAffection<UndergroundBiome>(AffectionLevel.Dislike)//讨厌地下环境
        .SetBiomeAffection<SnowBiome>(AffectionLevel.Like)//喜欢雪地环境
        .SetBiomeAffection<OceanBiome>(AffectionLevel.Love)//最爱海洋环境
        .SetNPCAffection(NPCID.Angler, AffectionLevel.Dislike)//讨厌与渔夫做邻居
        .SetNPCAffection(NPCID.Guide, AffectionLevel.Like)//喜欢与向导做邻居
                                                          //邻居的喜好级别和环境的AffectionLevel是一样的
    ;
}

接下来是SetDefaults里需要填写的，这个不会太复杂。

public override void SetDefaults()
{
    //判断该NPC是否为城镇NPC，决定了这个NPC是否拥有幸福度对话，是否可以对话以及是否会被地图保存
    //当然以上这些属性也可以靠其他的方式开启或关闭，我们日后再说
    NPC.townNPC = true;
    //该NPC为友好NPC，不会被友方弹幕伤害且会被敌对NPC伤害
    NPC.friendly = true;
    //碰撞箱宽，不做过多解释，此处为标准城镇NPC数据
    NPC.width = 18;
    //碰撞箱高，不做过多解释，此处为标准城镇NPC数据
    NPC.height = 40;
    //套用原版城镇NPC的AIStyle，这样我们就不用自己费劲写AI了，
    //同时根据我以往的观测结果发现这个属性也决定了NPC是否会出现在入住列表里，还请大佬求证
    NPC.aiStyle = NPCAIStyleID.Passive;
    //伤害，由于城镇NPC没有体术所以这里特指弹幕伤害（虽然弹幕伤害也是单独设置的所以理论上这个可以不写？）
    NPC.damage = 10;
    //防御力
    NPC.defense = 15;
    //最大生命值，此处为标准城镇NPC数据
    NPC.lifeMax = 250;
    //受击音效
    NPC.HitSound = SoundID.NPCHit1;
    //死亡音效
    NPC.DeathSound = SoundID.NPCDeath1;
    //抗击退性，数据越小抗性越高
    NPC.knockBackResist = 0.5f;
    //模仿的动画类型，这样就不用自己费劲写动画播放了
    AnimationType = NPCID.Merchant;
}

设置身份信息

图鉴

填完了基础属性，我们发现他还需要一些在图鉴中展示的信息 … 欸等等？上面不是设置过了吗？

有些信息是不能在SetStaticDefaults里设置的，所以TML才会给我们这个东西。

这里就请出我们下一个要介绍的重写函数：SetBestiary

//设置图鉴内信息
public override void SetBestiary(BestiaryDatabase database, BestiaryEntry bestiaryEntry)
{
    bestiaryEntry.Info.AddRange(new IBestiaryInfoElement[] {
        //设置所属环境，一般填写他最喜爱的环境
        BestiaryDatabaseNPCsPopulator.CommonTags.SpawnConditions.Biomes.Ocean,
        //图鉴内描述
        new FlavorTextBestiaryInfoElement("一个人见人爱，花见花开，月总见了直接裂开的测试小伙")
    });
}

一个常驻型城镇NPC肯定要有自己的名字与入住方式，如果一个NPC没有入住条件，那么在不依靠非正常手段的情况下是不可能遇见他的；如果一个NPC没有姓名，那么当邻居在对话中提及他时只能说那个谁谁谁。

因此，我们需要为这个NPC添加入住条件和姓名

入住条件

城镇NPC的入住条件是依靠一个重写函数实现的：CanTownNPCSpawn

//设置入住条件
public override bool CanTownNPCSpawn(int numTownNPCs, int money)
{
    //返回条件为：拥有两个或以上的城镇居民，并且持有的钱币数量大于等于1金币
    return numTownNPCs >= 2 && money >= Item.buyPrice(0, 1, 0, 0);
}

城镇NPC的姓名也是靠一个重写函数实现的：SetNPCNameList

蛤？前面那个 DisplayName 不算数吗？当然不算，那是一个NPC的称呼，比如“向导”、“树妖”，“冰之妖精”；再比如“学生”、“老师”、“司机”等等。

这里指的就是我们普遍意义上的姓名，比如一个向导叫“Colin”，一个树妖叫”Tina”，一个专门霍霍城镇NPC的屑叫“中学生”。当你想要调用时可以使用 NPC.GivenName。

//设置姓名
public override List<string> SetNPCNameList()
{
    //所有可能出现的名字
    return new List<string>() {
        "Frisk",
        "Den-o",
        "Tiga",
        "Steve?",
        "Cirno",
        "Cocoa",
        "Lea",
        "Fei",
        "Quirrel"
    };
}

一个城镇NPC怎么能没有性别呢你说是吧骷髅商人？只不过我们给城镇NPC设置性别的方法不太寻常，我们是通过决定他是否会被国王雕像传送来决定他的性别的：CanGoToStatue

//决定NPC会被哪座雕像传送
public override bool CanGoToStatue(bool toKingStatue)
{
    //可以被国王雕像传送
    return toKingStatue;
}

除了这个，我们还可以在NPC被传送到雕像时搞点动作，需要的就是这个函数：OnGoToStatue

//当NPC在被雕像传送时会发生什么
public override void OnGoToStatue(bool toKingStatue)
{
    //在左下角弹出一句话
    if (toKingStatue)
        Main.NewText("测试小伙受到了国王雕像的召唤！");
    else
        Main.NewText("测试小伙受到了王后雕像的召唤！");
}

一个标准的城镇NPC肯定会有属于自己的对话。同样的，TML为我们提供了一个重写函数：GetChat

//设置对话
public override string GetChat()
{
    //声明一个int类型变量，查找一个whoAmI最靠前的、种类为向导的NPC并返回他的whoAmI
    int guide = NPC.FindFirstNPC(NPCID.Guide);
    WeightedRandom<string> chat = new WeightedRandom<string>();
    {
        //当血月和日食都没有发生时
        if (!Main.bloodMoon && !Main.eclipse)
        {
            //无家可归时
            if (NPC.homeless)
            {
                chat.Add("我想我们已经认识对方了，所以....能给个住的地方吗？");
            }
            else
            {
                //自我介绍，NPC.FullName就是带上称呼的姓名，比如“测试小伙Den-o”
                chat.Add($"你好！我是{NPC.FullName}");
                //当查找到向导NPC时
                if (guide != -1)
                {
                    //GivenName上面有提
                    chat.Add($"{Main.npc[guide].GivenName}博学多识，是个人才。");
                }
                //正在举行派对时
                if (BirthdayParty.PartyIsUp)
                {
                    chat.Add("老兄，我最喜欢派对了！");
                }
            }
        }
        //日食时
        if (Main.eclipse)
        {
            chat.Add("我相信你可以挺过去，让我没事就行！");
        }
        //血月时
        if (Main.bloodMoon)
        {
            chat.Add("不！不要血月！！！");
        }
        return chat;
    }
}

你想让你的NPC卖点东西？当然可以，不过在直接设置商店之前，我们肯定要为他设置打开商店的方式，也就是对话按钮。这里有两个我们需要认识的重写函数：SetChatButtons与OnChatButtonClicked。

首先是SetChatButtons，设置这个NPC的按钮属性。

//设置对话按钮的文本
public override void SetChatButtons(ref string button, ref string button2)
{
    //直接引用原版的“商店”文本
    button = Language.GetTextValue("LegacyInterface.28");
    //设置第二个按钮
    button2 = "按钮2";
}

接下来是OnChatButtonClicked，设置按钮被按下后会发生什么发生什么事儿了？

//设置当对话按钮被摁下时会发生什么
public override void OnChatButtonClicked(bool firstButton, ref bool shop)
{
    //当第一个按钮被按下时
    if (firstButton)
    {
        //打开商店
        shop = true;
    }
    //如果是第二个按钮被按下时
    else
    {
        //出现一句对话，使用这个属性可以直接设置NPC要说的话。
        Main.npcChatText = "这是第二个按钮哦！";
    }
}

设置商店需要用到的重写函数为：SetupShop

//设置商店内容
public override void SetupShop(Chest shop, ref int nextSlot)
{
    //将小型血瓶加入商店内
    shop.item[nextSlot].SetDefaults(ItemID.LesserHealingPotion);
    //进入下一个物品栏
    nextSlot++;
    //将小型魔瓶加入商店内
    shop.item[nextSlot].SetDefaults(ItemID.LesserManaPotion);
    nextSlot++;
    //将土块加入商店内
    shop.item[nextSlot].SetDefaults(ItemID.DirtBlock);
    //以一个金币的价格卖出（倒爷说的就是你是吧）
    //如果不对这个进行设置，那么商品的售价默认按照该物品的Item.value设置
    shop.item[nextSlot].value = Item.buyPrice(0, 1, 0, 0);
    nextSlot++;
    //当 击败克苏鲁之眼 且 处于专家模式 时
    if (NPC.downedBoss1 && Main.expertMode)
    {
        //将克苏鲁之盾加入商店内
        shop.item[nextSlot].SetDefaults(ItemID.EoCShield);
        nextSlot++;
    }
}

这部分包含了所有NPC都需要具备的：

TownNPCAttackStrength， NPC的攻击力。

//设置NPC的攻击力
public override void TownNPCAttackStrength(ref int damage, ref float knockback)
{
    //伤害，直接调用NPC本体的伤害
    damage = NPC.damage;
    //击退力，中规中矩的数据
    knockback = 3f;
}

TownNPCAttackCooldown，NPC的攻击冷却。

//设置每次攻击完毕后的冷却时间
public override void TownNPCAttackCooldown(ref int cooldown, ref int randExtraCooldown)
{
    //基础冷却时间
    cooldown = 60;
    //额外冷却时间
    randExtraCooldown = 30;
}

TownNPCAttackProj，也就是设置NPC发射的弹幕。

//设置发射的弹幕
public override void TownNPCAttackProj(ref int projType, ref int attackDelay)
{
    //射弹种类，这里用火枪子弹的弹幕
    projType = ProjectileID.Bullet;
    //弹幕发射延迟，最好只给魔法型NPC设置较高数据
    attackDelay = 10;
}

TownNPCAttackProjSpeed，设置发射弹幕的向量。

//设置发射弹幕的向量
public override void TownNPCAttackProjSpeed(ref float multiplier, ref float gravityCorrection, ref float randomOffset)
{
    //发射速度
    multiplier = 6f;
    //射击角度额外向上偏移的量
    gravityCorrection = 0f;
    //射击时产生的最大额外向量偏差
    randomOffset = 0.5f;
}

DrawTownAttackGun，顾名思义，它负责控制绘制在NPC手上的武器，当然如果你选择把武器画进帧图里可以不带这个。

//设置绘制在NPC手上的远程武器
public override void DrawTownAttackGun(ref float scale, ref int item, ref int closeness)
{
    //贴图尺寸
    scale = 1f;
    //贴图样式，这里用燧发枪
    item = ItemID.FlintlockPistol;
    //绘制位置到NPC中心的距离，数值越大越靠近
    closeness = 6;
}

这个部分的函数仅限魔法型NPC使用：

TownNPCAttackMagic，调整施法时脚下光环的亮度。

//设置NPC施法时魔法光环的亮度
public override void TownNPCAttackMagic(ref float auraLightMultiplier)
{
    //光亮程度，这里写2倍
    auraLightMultiplier = 2f;
}

TownNPCAttackSwing，用来设置NPC挥动武器时的实际碰撞箱。

//设置NPC挥动武器时的实际碰撞箱
public override void TownNPCAttackSwing(ref int itemWidth, ref int itemHeight)
{
    //宽与高，合称尺寸
    itemWidth = itemHeight = 80;
}

DrawTownAttackSwing，用来设置绘制该武器时的各种属性。

//设置绘制在NPC手上挥动的武器
public override void DrawTownAttackSwing(ref Texture2D item, ref int itemSize, ref float scale, ref Vector2 offset)
{
    //贴图样式，破坏者大剑hhh
    int id = ItemID.BreakerBlade;
    //如果选择使用原版贴图，这里必须要提前Load一遍，否则贴图将无法呈现
    Main.instance.LoadItem(id);
    item = TextureAssets.Item[id].Value;
    //碰撞箱尺寸，用于调整持握位置
    itemSize = 80;
    //贴图挥动起点到NPC中心的距离比例，值太大可能会导致武器脱手
    //！注意这不是调整贴图大小的
    scale = 0.1f;
    //绘制偏移量，绝对值越大距离NPC越近
    offset = new Vector2(2 * -NPC.direction, 0);
}

前面准备就绪，接下来打开你的 zh-Hans.Hjson。需要输入的内容如下：

TownNPCMood_Princess: 
{
	//公主关于测试小伙的对话
	LoveNPC_TownNPCExample/TestTownNPC: 
	'''
	{NPCName}愿意为他人传授知识，我很欣赏他！
	'''
}
Mods: 
{
	TownNPCExample: 
    {
		TownNPCMood: 
		{
		    TestTownNPC: 
			{
				//正好满足
				Content: 现在的一切都恰到好处。
				//需要房屋
				NoHome: 我想我需要一个家。
				//不拥挤
				LoveSpace: 我喜欢这样充足的个人空间。
				//离家太远
				FarFromHome: 我似乎离家太远了。
				//略微拥挤
				DislikeCrowded: 这里的人有点多...
				//十分拥挤
				HateCrowded: 这里的人太多了！
				//喜欢公主的对话
				LikeNPC_Princess: 
				'''
				{NPCName}深受大家欢迎，包括我。
				'''
				//喜爱的环境
				LoveBiome: 
				'''
				{BiomeName}宽广无垠，我爱这里。
				'''
				//喜欢的环境
				LikeBiome: 
				'''
				我很喜欢{BiomeName}银装素裹的美景。
				'''
				//讨厌的环境
				DislikeBiome: 
				'''
				{BiomeName}非常昏暗，我不喜欢这里。
				'''
				//厌恶的环境
				HateBiome: 
				'''
				{BiomeName}又潮湿又闷热，真是糟糕透了！
				'''
				//喜欢的NPC
				LikeNPC: 
				'''
				{NPCName}见多识广，我很崇拜他。
				'''
				//不喜欢的NPC
				DislikeNPC: 
				'''
				{NPCName}太喜欢恶作剧了，我不想和他当邻居。
				'''
			}
		}
	}
}