Merge pull request #183 from ethanmoffat/spell_casting

Implement selection/casting of spells by main player. Enforce SP limits.

EOLib.Localization/EOResourceID.cs

@@ -114,7 +114,7 @@ public enum EOResourceID
         STRING_SERVER = 118,
         SERVER_MESSAGE_MAP_MUTATION = 119,
         STATUS_LABEL_NOTHING_HAPPENED = 120,
-
+        YOU_CANNOT_ATTACK_THIS_NPC = 121,
         DIALOG_SHOP_BUY_ITEMS = 122,
         DIALOG_SHOP_SELL_ITEMS = 123,
         DIALOG_SHOP_CRAFT_ITEMS = 124,

EOLib/Domain/Character/Character.cs

@@ -6,6 +6,8 @@ public class Character : ICharacter
     {
         public int ID { get; private set; }
 
+        public int Index => ID;
+
         public string Name { get; private set; }
 
         public string Title { get; private set; }

EOLib/Domain/Character/CharacterActions.cs

@@ -14,15 +14,15 @@ namespace EOLib.Domain.Character
     public class CharacterActions : ICharacterActions
     {
         private readonly IPacketSendService _packetSendService;
-        private readonly ICharacterProvider _characterProvider;
+        private readonly ICharacterRepository _characterRepository;
         private readonly IESFFileProvider _spellFileProvider;
 
         public CharacterActions(IPacketSendService packetSendService,
-                                ICharacterProvider characterProvider,
+                                ICharacterRepository characterRepository,
                                 IESFFileProvider spellFileProvider)
         {
             _packetSendService = packetSendService;
-            _characterProvider = characterProvider;
+            _characterRepository = characterRepository;
             _spellFileProvider = spellFileProvider;
         }
 
@@ -37,9 +37,9 @@ public void Face(EODirection direction)
 
         public void Walk()
         {
-            var admin = _characterProvider.MainCharacter.NoWall &&
-                        _characterProvider.MainCharacter.AdminLevel != AdminLevel.Player;
-            var renderProperties = _characterProvider.MainCharacter.RenderProperties;
+            var admin = _characterRepository.MainCharacter.NoWall &&
+                        _characterRepository.MainCharacter.AdminLevel != AdminLevel.Player;
+            var renderProperties = _characterRepository.MainCharacter.RenderProperties;
 
             var packet = new PacketBuilder(PacketFamily.Walk, admin ? PacketAction.Admin : PacketAction.Player)
                 .AddChar((byte) renderProperties.Direction)
@@ -53,8 +53,12 @@ public void Walk()
 
         public void Attack()
         {
+            var c = _characterRepository.MainCharacter;
+            var sp = Math.Max(0, c.Stats[CharacterStat.SP] - 1);
+            _characterRepository.MainCharacter = c.WithStats(c.Stats.WithNewStat(CharacterStat.SP, sp));
+
             var packet = new PacketBuilder(PacketFamily.Attack, PacketAction.Use)
-                .AddChar((byte) _characterProvider.MainCharacter.RenderProperties.Direction)
+                .AddChar((byte) _characterRepository.MainCharacter.RenderProperties.Direction)
                 .AddThree(DateTime.Now.ToEOTimeStamp())
                 .Build();
 
@@ -63,7 +67,7 @@ public void Attack()
 
         public void ToggleSit()
         {
-            var renderProperties = _characterProvider.MainCharacter.RenderProperties;
+            var renderProperties = _characterRepository.MainCharacter.RenderProperties;
             var sitAction = renderProperties.SitState == SitState.Standing
                 ? SitAction.Sit
                 : SitAction.Stand;
@@ -81,7 +85,7 @@ public void ToggleSit()
 
         public void SitInChair()
         {
-            var rp = _characterProvider.MainCharacter.RenderProperties;
+            var rp = _characterRepository.MainCharacter.RenderProperties;
             var action = rp.SitState == SitState.Chair ? SitAction.Stand : SitAction.Sit;
             var packet = new PacketBuilder(PacketFamily.Chair, PacketAction.Request)
                 .AddChar((byte)action)
@@ -106,6 +110,10 @@ public void CastSpell(int spellId, ISpellTargetable target)
         {
             var data = _spellFileProvider.ESFFile.Single(x => x.ID == spellId);
 
+            var c = _characterRepository.MainCharacter;
+            var sp = Math.Max(0, c.Stats[CharacterStat.SP] - data.SP);
+            _characterRepository.MainCharacter = c.WithStats(c.Stats.WithNewStat(CharacterStat.SP, sp));
+
             var action = data.Target == IO.SpellTarget.Self
                 ? PacketAction.TargetSelf
                 : data.Target == IO.SpellTarget.Normal
@@ -138,7 +146,7 @@ public void CastSpell(int spellId, ISpellTargetable target)
                         .AddChar(1) // unknown
                         .AddShort(1) // unknown
                         .AddShort((short)spellId)
-                        .AddShort((short)target.ID)
+                        .AddShort((short)target.Index)
                         .AddThree(DateTime.Now.ToEOTimeStamp());
                 }
                 else

EOLib/Domain/Character/CharacterRenderProperties.cs

@@ -31,6 +31,7 @@ public class CharacterRenderProperties : ICharacterRenderProperties
         public int ActualAttackFrame { get; private set; }
         public int RenderAttackFrame { get; private set; }
         public int EmoteFrame { get; private set; }
+        public int ActualSpellCastFrame { get; private set; }
 
         public SitState SitState { get; private set; }
         public Emote Emote { get; private set; }
@@ -179,10 +180,10 @@ public ICharacterRenderProperties WithNextEmoteFrame()
 
         public ICharacterRenderProperties WithNextSpellCastFrame()
         {
+            // spell cast frame ticks: 0 0 1 1 1
             var props = MakeCopy(this);
-            props.CurrentAction = props.CurrentAction == CharacterActionState.Standing
-                ? CharacterActionState.SpellCast
-                : CharacterActionState.Standing;
+            props.ActualSpellCastFrame = (props.ActualSpellCastFrame + 1) % MAX_NUMBER_OF_ATTACK_FRAMES;
+            props.CurrentAction = props.ActualSpellCastFrame == 0 ? CharacterActionState.Standing : CharacterActionState.SpellCast;
             return props;
         }
 
@@ -271,6 +272,7 @@ private static CharacterRenderProperties MakeCopy(ICharacterRenderProperties oth
                 ActualAttackFrame = other.ActualAttackFrame,
                 RenderAttackFrame = other.RenderAttackFrame,
                 EmoteFrame = other.EmoteFrame,
+                ActualSpellCastFrame = other.ActualSpellCastFrame,
 
                 SitState = other.SitState,
                 Emote = other.Emote,
@@ -304,6 +306,7 @@ public override bool Equals(object obj)
                    RenderWalkFrame == properties.RenderWalkFrame &&
                    RenderAttackFrame == properties.RenderAttackFrame &&
                    EmoteFrame == properties.EmoteFrame &&
+                   ActualSpellCastFrame == properties.ActualSpellCastFrame &&
                    SitState == properties.SitState &&
                    Emote == properties.Emote &&
                    IsHidden == properties.IsHidden &&
@@ -333,6 +336,7 @@ public override int GetHashCode()
             hashCode = hashCode * -1521134295 + ActualAttackFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + RenderAttackFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + EmoteFrame.GetHashCode();
+            hashCode = hashCode * -1521134295 + ActualSpellCastFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + SitState.GetHashCode();
             hashCode = hashCode * -1521134295 + Emote.GetHashCode();
             hashCode = hashCode * -1521134295 + IsHidden.GetHashCode();

EOLib/Domain/Character/ICharacterRenderProperties.cs

@@ -27,6 +27,7 @@ public interface ICharacterRenderProperties : ICloneable
         int ActualAttackFrame { get; }
         int RenderAttackFrame { get; }
         int EmoteFrame { get; }
+        int ActualSpellCastFrame { get; }
 
         SitState SitState { get; }
         Emote Emote { get; }

EOLib/Domain/Interact/MapNPCActions.cs

@@ -26,7 +26,7 @@ public MapNPCActions(IPacketSendService packetSendService,
         public void RequestShop(INPC npc)
         {
             var packet = new PacketBuilder(PacketFamily.Shop, PacketAction.Open)
-                .AddShort(npc.Index)
+                .AddShort((short)npc.Index)
                 .Build();
 
             _packetSendService.SendPacket(packet);
@@ -39,7 +39,7 @@ public void RequestQuest(INPC npc)
             var data = _enfFileProvider.ENFFile[npc.ID];
 
             var packet = new PacketBuilder(PacketFamily.Quest, PacketAction.Use)
-                .AddShort(npc.Index)
+                .AddShort((short)npc.Index)
                 .AddShort(data.VendorID)
                 .Build();
 
@@ -49,7 +49,7 @@ public void RequestQuest(INPC npc)
         public void RequestBank(INPC npc)
         {
             var packet = new PacketBuilder(PacketFamily.Bank, PacketAction.Open)
-                .AddShort(npc.Index)
+                .AddShort((short)npc.Index)
                 .Build();
 
             _packetSendService.SendPacket(packet);

EOLib/Domain/NPC/INPC.cs

@@ -5,8 +5,6 @@ namespace EOLib.Domain.NPC
 {
     public interface INPC : ISpellTargetable
     {
-        byte Index { get; }
-
         byte X { get; }
 
         byte Y { get; }

EOLib/Domain/NPC/NPC.cs

@@ -7,7 +7,7 @@ public class NPC : INPC
     {
         public int ID { get; }
 
-        public byte Index { get; }
+        public int Index { get; }
 
         public byte X { get; private set; }
 
@@ -19,7 +19,7 @@ public class NPC : INPC
 
         public Option<short> OpponentID { get; private set; }
 
-        public NPC(int id, byte index)
+        public NPC(int id, int index)
         {
             ID = id;
             Index = index;

EOLib/Domain/Spells/ISpellTargetable.cs

@@ -3,5 +3,7 @@
     public interface ISpellTargetable
     {
         int ID { get; }
+
+        int Index { get; }
     }
 }

EOLib/Domain/Spells/SpellCastValidationActions.cs

@@ -0,0 +1,83 @@
+using AutomaticTypeMapper;
+using EOLib.Domain.Character;
+using EOLib.Domain.Map;
+using EOLib.Domain.NPC;
+using EOLib.IO;
+using EOLib.IO.Repositories;
+
+namespace EOLib.Domain.Spells
+{
+    [AutoMappedType]
+    public class SpellCastValidationActions : ISpellCastValidationActions
+    {
+        private readonly IPubFileProvider _pubFileProvider;
+        private readonly ICurrentMapProvider _currentMapProvider;
+        private readonly ICharacterProvider _characterProvider;
+
+        public SpellCastValidationActions(IPubFileProvider pubFileProvider,
+                                          ICurrentMapProvider currentMapProvider,
+                                          ICharacterProvider characterProvider)
+        {
+            _pubFileProvider = pubFileProvider;
+            _currentMapProvider = currentMapProvider;
+            _characterProvider = characterProvider;
+        }
+
+        public SpellCastValidationResult ValidateSpellCast(int spellId)
+        {
+            var spellData = _pubFileProvider.ESFFile[spellId];
+
+            var stats = _characterProvider.MainCharacter.Stats;
+            if (stats[CharacterStat.SP] - spellData.SP < 0)
+                return SpellCastValidationResult.ExhaustedNoSp;
+            if (stats[CharacterStat.TP] - spellData.TP < 0)
+                return SpellCastValidationResult.ExhaustedNoTp;
+
+            return SpellCastValidationResult.Ok;
+        }
+
+        public SpellCastValidationResult ValidateSpellCast(int spellId, ISpellTargetable spellTarget)
+        {
+            var res = ValidateSpellCast(spellId);
+            if (res != SpellCastValidationResult.Ok)
+                return res;
+
+            var spellData = _pubFileProvider.ESFFile[spellId];
+
+            if (spellTarget is INPC)
+            {
+                if (spellData.TargetRestrict == SpellTargetRestrict.Friendly ||
+                    spellData.Target != SpellTarget.Normal ||
+                    spellData.Type != SpellType.Damage)
+                    return SpellCastValidationResult.WrongTargetType;
+
+                var npcData = _pubFileProvider.ENFFile[spellTarget.ID];
+
+                if (npcData.Type != NPCType.Passive && npcData.Type != NPCType.Aggressive)
+                    return SpellCastValidationResult.CannotAttackNPC;
+            }
+            else if (spellTarget is ICharacter)
+            {
+                if (spellData.TargetRestrict == SpellTargetRestrict.NPCOnly ||
+                    spellData.Target != SpellTarget.Normal ||
+                    (spellTarget == _characterProvider.MainCharacter && spellData.TargetRestrict != SpellTargetRestrict.Friendly) ||
+                    (spellData.Type != SpellType.Heal && spellData.Type != SpellType.Damage) ||
+                    (!_currentMapProvider.CurrentMap.Properties.PKAvailable && spellData.TargetRestrict == SpellTargetRestrict.Opponent))
+                    return SpellCastValidationResult.WrongTargetType;
+            }
+            else
+            {
+                return SpellCastValidationResult.WrongTargetType;
+            }
+
+            return SpellCastValidationResult.Ok;
+        }
+    }
+
+    public interface ISpellCastValidationActions
+    {
+        SpellCastValidationResult ValidateSpellCast(int spellId);
+
+        SpellCastValidationResult ValidateSpellCast(int spellId, ISpellTargetable spellTarget);
+    }
+}

EOLib/Domain/Spells/SpellCastValidationResult.cs

@@ -0,0 +1,11 @@
+namespace EOLib.Domain.Spells
+{
+    public enum SpellCastValidationResult
+    {
+        Ok,
+        CannotAttackNPC,
+        WrongTargetType,
+        ExhaustedNoSp,
+        ExhaustedNoTp,
+    }
+}