Merge pull request #96 from ethanmoffat/map_features

Big merge: Implement most of the missing map display features

Includes:
- F12 map refresh
- Hopping stones (jump tiles)
- Spikes
- Map signs / map sign serializer fixes
- Click to walk fixes
- Water splashies (water tiles)
- Rendering of effects cast by other players
- Damage counters above players and NPCs
- Earthquakes
- HP/TP drain

BatchMap/Program.cs

@@ -136,6 +136,7 @@ private static void Main(string[] args)
         private static void SetupDependencies()
         {
             _typeRegistry = new UnityRegistry("EOLib.IO");
+            _typeRegistry.RegisterDiscoveredTypes();
 
             _pubProvider = _typeRegistry.Resolve<IPubFileProvider>();
             _mapFileProvider = _typeRegistry.Resolve<IMapFileProvider>();

EOLib.IO/Map/MapPathToIDConverter.cs

@@ -6,11 +6,11 @@ public class MapPathToIDConverter
     {
         public int ConvertFromPathToID(string pathToMapFile)
         {
-            var lastSlash = pathToMapFile.LastIndexOf('\\') < 0 ? pathToMapFile.LastIndexOf('/') : -1;
-            if (lastSlash < 0)
+            var lastDot = pathToMapFile.LastIndexOf('.');
+            if (lastDot < 5)
                 throw new IOException();
 
-            var strID = pathToMapFile.Substring(lastSlash + 1, 5);
+            var strID = pathToMapFile.Substring(lastDot - 5, 5);
             return int.Parse(strID);
         }
     }

EOLib.IO/Map/SignMapEntity.cs

@@ -4,7 +4,7 @@ namespace EOLib.IO.Map
 {
     public class SignMapEntity : IMapEntity
     {
-        public const int DATA_SIZE = 5;
+        public const int DATA_SIZE = 4;
 
         public int X { get; private set; }
 

EOLib.IO/Services/Serializers/MapFileSerializer.cs

@@ -250,7 +250,7 @@ private int GetVariableSignLength(MemoryStream ms)
             ms.Read(messageLengthRaw, 0, 2); //read two-byte length
             ms.Seek(-4, SeekOrigin.Current); //skip back to beginning
 
-            return _numberEncoderService.DecodeNumber(messageLengthRaw) - 1;
+            return _numberEncoderService.DecodeNumber(messageLengthRaw);
         }
 
         #endregion

EOLib.IO/Services/Serializers/SignMapEntitySerializer.cs

@@ -25,18 +25,12 @@ public byte[] SerializeToByteArray(SignMapEntity mapEntity)
 
             retBytes.AddRange(numberEncoderService.EncodeNumber(mapEntity.X, 1));
             retBytes.AddRange(numberEncoderService.EncodeNumber(mapEntity.Y, 1));
-            retBytes.AddRange(numberEncoderService.EncodeNumber(mapEntity.Title.Length + mapEntity.Message.Length + 1, 2));
 
-            var fileMsg = new byte[mapEntity.Message.Length + mapEntity.Title.Length];
-
-            var rawTitle = mapStringEncoderService.EncodeMapString(mapEntity.Title);
-            Array.Copy(rawTitle, fileMsg, rawTitle.Length);
-
-            var rawMessage = mapStringEncoderService.EncodeMapString(mapEntity.Message);
-            Array.Copy(rawMessage, 0, fileMsg, rawTitle.Length, rawMessage.Length);
+            var fileMsg = mapStringEncoderService.EncodeMapString(mapEntity.Title + mapEntity.Message);
+            retBytes.AddRange(numberEncoderService.EncodeNumber(fileMsg.Length + 1, 2));
 
             retBytes.AddRange(fileMsg);
-            retBytes.AddRange(numberEncoderService.EncodeNumber(rawTitle.Length, 1));
+            retBytes.AddRange(numberEncoderService.EncodeNumber(mapEntity.Title.Length, 1));
 
             return retBytes.ToArray();
         }
@@ -50,12 +44,12 @@ public SignMapEntity DeserializeFromByteArray(byte[] data)
                 .WithX(numberEncoderService.DecodeNumber(data[0]))
                 .WithY(numberEncoderService.DecodeNumber(data[1]));
 
-            var titleAndMessageLength = numberEncoderService.DecodeNumber(data[2], data[3]) - 1;
+            var titleAndMessageLength = numberEncoderService.DecodeNumber(data[2], data[3]);
             if (data.Length != SignMapEntity.DATA_SIZE + titleAndMessageLength)
                 throw new ArgumentException("Data is improperly sized for deserialization", nameof(data));
 
-            var rawTitleAndMessage = data.Skip(4).Take(titleAndMessageLength).ToArray();
-            var titleLength = numberEncoderService.DecodeNumber(data[4 + titleAndMessageLength]);
+            var rawTitleAndMessage = data.Skip(SignMapEntity.DATA_SIZE).Take(titleAndMessageLength - 1).ToArray();
+            var titleLength = numberEncoderService.DecodeNumber(data[SignMapEntity.DATA_SIZE + titleAndMessageLength - 1]);
 
             var titleAndMessage = mapStringEncoderService.DecodeMapString(rawTitleAndMessage);
             sign = sign.WithTitle(titleAndMessage.Substring(0, titleLength))

EOLib/Domain/Character/CharacterRenderProperties.cs

@@ -26,7 +26,8 @@ public class CharacterRenderProperties : ICharacterRenderProperties
         public int MapX { get; private set; }
         public int MapY { get; private set; }
 
-        public int WalkFrame { get; private set; }
+        public int ActualWalkFrame { get; private set; }
+        public int RenderWalkFrame { get; private set; }
         public int AttackFrame { get; private set; }
         public int EmoteFrame { get; private set; }
 
@@ -123,11 +124,23 @@ public ICharacterRenderProperties WithMapY(int mapY)
             return props;
         }
 
-        public ICharacterRenderProperties WithNextWalkFrame()
+        public ICharacterRenderProperties WithNextWalkFrame(bool isSteppingStone = false)
         {
             var props = MakeCopy(this);
-            props.WalkFrame = (props.WalkFrame + 1) % MAX_NUMBER_OF_WALK_FRAMES;
-            props.CurrentAction = props.WalkFrame == 0 ? CharacterActionState.Standing : CharacterActionState.Walking;
+            props.ActualWalkFrame = (props.ActualWalkFrame + 1) % MAX_NUMBER_OF_WALK_FRAMES;
+
+            if (isSteppingStone && props.ActualWalkFrame > 1)
+            {
+                // force first walk frame when on a stepping stone (this is the graphic used for jump, Y adjusted)
+                props.RenderWalkFrame = 1;
+            }
+            else
+            {
+                props.RenderWalkFrame = props.ActualWalkFrame;
+            }
+
+            props.CurrentAction = props.RenderWalkFrame == 0 ? CharacterActionState.Standing : CharacterActionState.Walking;
+
             return props;
         }
 
@@ -159,7 +172,7 @@ public ICharacterRenderProperties WithNextSpellCastFrame()
         public ICharacterRenderProperties ResetAnimationFrames()
         {
             var props = MakeCopy(this);
-            props.WalkFrame = 0;
+            props.RenderWalkFrame = 0;
             props.AttackFrame = 0;
             props.EmoteFrame = 0;
             props.CurrentAction = CharacterActionState.Standing;
@@ -228,7 +241,8 @@ private static CharacterRenderProperties MakeCopy(ICharacterRenderProperties oth
                 MapX = other.MapX,
                 MapY = other.MapY,
 
-                WalkFrame = other.WalkFrame,
+                ActualWalkFrame = other.ActualWalkFrame,
+                RenderWalkFrame = other.RenderWalkFrame,
                 AttackFrame = other.AttackFrame,
                 EmoteFrame = other.EmoteFrame,
 
@@ -257,7 +271,8 @@ public override bool Equals(object obj)
                    Direction == properties.Direction &&
                    MapX == properties.MapX &&
                    MapY == properties.MapY &&
-                   WalkFrame == properties.WalkFrame &&
+                   ActualWalkFrame == properties.ActualWalkFrame &&
+                   RenderWalkFrame == properties.RenderWalkFrame &&
                    AttackFrame == properties.AttackFrame &&
                    EmoteFrame == properties.EmoteFrame &&
                    SitState == properties.SitState &&
@@ -283,7 +298,8 @@ public override int GetHashCode()
             hashCode = hashCode * -1521134295 + Direction.GetHashCode();
             hashCode = hashCode * -1521134295 + MapX.GetHashCode();
             hashCode = hashCode * -1521134295 + MapY.GetHashCode();
-            hashCode = hashCode * -1521134295 + WalkFrame.GetHashCode();
+            hashCode = hashCode * -1521134295 + ActualWalkFrame.GetHashCode();
+            hashCode = hashCode * -1521134295 + RenderWalkFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + AttackFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + EmoteFrame.GetHashCode();
             hashCode = hashCode * -1521134295 + SitState.GetHashCode();

EOLib/Domain/Character/ICharacterRenderProperties.cs

@@ -22,7 +22,8 @@ public interface ICharacterRenderProperties : ICloneable
         int MapX { get; }
         int MapY { get; }
 
-        int WalkFrame { get; }
+        int ActualWalkFrame { get; }
+        int RenderWalkFrame { get; }
         int AttackFrame { get; }
         int EmoteFrame { get; }
 
@@ -49,7 +50,7 @@ public interface ICharacterRenderProperties : ICloneable
         ICharacterRenderProperties WithMapX(int mapX);
         ICharacterRenderProperties WithMapY(int mapY);
 
-        ICharacterRenderProperties WithNextWalkFrame();
+        ICharacterRenderProperties WithNextWalkFrame(bool isSteppingStone = false);
         ICharacterRenderProperties WithNextAttackFrame();
         ICharacterRenderProperties WithNextEmoteFrame();
         ICharacterRenderProperties WithNextSpellCastFrame();

EOLib/Domain/Extensions/CharacterExtensions.cs

@@ -1,4 +1,5 @@
 using EOLib.Domain.Character;
+using System;
 
 namespace EOLib.Domain.Extensions
 {
@@ -38,5 +39,17 @@ public static ICharacter WithAppliedData(this ICharacter original, ICharacter up
                 .WithRenderProperties(newRenderProps)
                 .WithStats(newStats);
         }
+
+        public static ICharacter WithDamage(this ICharacter original, int damageTaken, bool isDead)
+        {
+            var stats = original.Stats;
+            stats = stats.WithNewStat(CharacterStat.HP, (short)Math.Max(stats[CharacterStat.HP] - damageTaken, 0));
+
+            var props = original.RenderProperties;
+            if (isDead)
+                props = props.WithDead();
+
+            return original.WithStats(stats).WithRenderProperties(props);
+        }
     }
 }

EOLib/Domain/Map/CurrentMapStateRepository.cs

@@ -21,6 +21,8 @@ public interface ICurrentMapStateRepository
 
         HashSet<IWarp> PendingDoors { get; set; }
 
+        HashSet<MapCoordinate> VisibleSpikeTraps { get; set; }
+
         WarpState MapWarpState { get; set; }
     }
 
@@ -40,6 +42,8 @@ public interface ICurrentMapStateProvider
 
         IReadOnlyCollection<IWarp> PendingDoors { get; }
 
+        IReadOnlyCollection<MapCoordinate> VisibleSpikeTraps { get; }
+
         WarpState MapWarpState { get; set; }
     }
 
@@ -60,6 +64,8 @@ public class CurrentMapStateRepository : ICurrentMapStateRepository, ICurrentMap
 
         public HashSet<IWarp> PendingDoors { get; set; }
 
+        public HashSet<MapCoordinate> VisibleSpikeTraps { get; set;  }
+
         public WarpState MapWarpState { get; set; }
 
         IReadOnlyCollection<ICharacter> ICurrentMapStateProvider.Characters => Characters;
@@ -72,6 +78,8 @@ public class CurrentMapStateRepository : ICurrentMapStateRepository, ICurrentMap
 
         IReadOnlyCollection<IWarp> ICurrentMapStateProvider.PendingDoors => PendingDoors;
 
+        IReadOnlyCollection<MapCoordinate> ICurrentMapStateProvider.VisibleSpikeTraps => VisibleSpikeTraps;
+
         public CurrentMapStateRepository()
         {
             ResetState();
@@ -87,6 +95,7 @@ public void ResetState()
             MapItems = new HashSet<IItem>();
             OpenDoors = new HashSet<IWarp>();
             PendingDoors = new HashSet<IWarp>();
+            VisibleSpikeTraps = new HashSet<MapCoordinate>();
 
             MapWarpState = WarpState.None;
         }

EOLib/Domain/Map/IMapCellState.cs

@@ -7,6 +7,8 @@ namespace EOLib.Domain.Map
 {
     public interface IMapCellState
     {
+        bool InBounds { get; }
+
         MapCoordinate Coordinate { get;  }
 
         IReadOnlyList<IItem> Items { get; }

EOLib/Domain/Map/MapActions.cs

@@ -22,6 +22,12 @@ public class MapActions : IMapActions
             _characterProvider = characterProvider;
         }
 
+        public void RequestRefresh()
+        {
+            var packet = new PacketBuilder(PacketFamily.Refresh, PacketAction.Request).Build();
+            _packetSendService.SendPacket(packet);
+        }
+
         public ItemPickupResult PickUpItem(IItem item)
         {
             var pickupResult = _itemPickupValidator.ValidateItemPickup(_characterProvider.MainCharacter, item);
@@ -40,6 +46,8 @@ public ItemPickupResult PickUpItem(IItem item)
 
     public interface IMapActions
     {
+        void RequestRefresh();
+
         ItemPickupResult PickUpItem(IItem item);
     }
 }

EOLib/Domain/Map/MapCellState.cs

@@ -7,6 +7,8 @@ namespace EOLib.Domain.Map
 {
     public class MapCellState : IMapCellState
     {
+        public bool InBounds { get; set; }
+
         public MapCoordinate Coordinate { get; set; }
 
         public IReadOnlyList<IItem> Items { get; set; }

EOLib/Domain/Map/MapCellStateProvider.cs

@@ -28,7 +28,7 @@ public class MapCellStateProvider : IMapCellStateProvider
         public IMapCellState GetCellStateAt(int x, int y)
         {
             if (x < 0 || y < 0 || x > CurrentMap.Properties.Width || y > CurrentMap.Properties.Height)
-                return new MapCellState {TileSpec = TileSpec.MapEdge};
+                return new MapCellState { InBounds = false, TileSpec = TileSpec.MapEdge };
 
             var tileSpec = CurrentMap.Tiles[y, x];
             var warp = CurrentMap.Warps[y, x];
@@ -42,6 +42,7 @@ public IMapCellState GetCellStateAt(int x, int y)
 
             return new MapCellState
             {
+                InBounds   = true,
                 Coordinate = new MapCoordinate(x, y),
                 Items      = items.ToList(),
                 TileSpec   = tileSpec,

EOLib/Domain/Map/Sign.cs

@@ -4,13 +4,21 @@ namespace EOLib.Domain.Map
 {
     public class Sign : ISign
     {
+        public string Title { get; private set; }
+
+        public string Message { get; private set; }
+
         public Sign(SignMapEntity sign)
         {
+            Title = sign.Title;
+            Message = sign.Message;
         }
     }
 
     public interface ISign
     {
-        //todo: figure out properties
+        string Title { get; }
+
+        string Message { get; }
     }
 }

EOLib/Domain/Notifiers/IEffectNotifier.cs

@@ -0,0 +1,22 @@
+using AutomaticTypeMapper;
+using EOLib.Domain.Map;
+
+namespace EOLib.Domain.Notifiers
+{
+    public interface IEffectNotifier
+    {
+        void NotifyWarpLeaveEffect(short characterId, WarpAnimation anim);
+        void NotifyWarpEnterEffect(short characterId, WarpAnimation anim);
+        void NotifyPotionEffect(short playerId, int effectId);
+        void NotifyEarthquake(byte strength);
+    }
+
+    [AutoMappedType]
+    public class NoOpEffectNotifier : IEffectNotifier
+    {
+        public void NotifyWarpLeaveEffect(short characterId, WarpAnimation anim) { }
+        public void NotifyWarpEnterEffect(short characterId, WarpAnimation anim) { }
+        public void NotifyPotionEffect(short playerId, int effectId) { }
+        public void NotifyEarthquake(byte strength) { }
+    }
+}

EOLib/Domain/Notifiers/INPCActionNotifier.cs

@@ -8,9 +8,11 @@ public interface INPCActionNotifier
 
         void StartNPCAttackAnimation(int npcIndex);
 
-        void RemoveNPCFromView(int npcIndex, bool showDeathAnimation);
+        void RemoveNPCFromView(int npcIndex, int playerId, Optional<short> spellId, Optional<int> damage, bool showDeathAnimation);
 
         void ShowNPCSpeechBubble(int npcIndex, string message);
+
+        void NPCTakeDamage(short npcIndex, int fromPlayerId, int damageToNpc, short npcPctHealth, Optional<int> spellId);
     }
 
     [AutoMappedType]
@@ -20,8 +22,10 @@ public class NoOpNPCActionNotifier : INPCActionNotifier
 
         public void StartNPCAttackAnimation(int npcIndex) { }
 
-        public void RemoveNPCFromView(int npcIndex, bool showDeathAnimation) { }
+        public void RemoveNPCFromView(int npcIndex, int playerId, Optional<short> spellId, Optional<int> damage, bool showDeathAnimation) { }
 
         public void ShowNPCSpeechBubble(int npcIndex, string message) { }
+
+        public void NPCTakeDamage(short npcIndex, int fromPlayerId, int damageToNpc, short npcPctHealth, Optional<int> spellId) { }
     }
 }

EOLib/Domain/Notifiers/IOtherCharacterAnimationNotifier.cs

@@ -7,6 +7,12 @@ public interface IOtherCharacterAnimationNotifier
         void StartOtherCharacterWalkAnimation(int characterID);
 
         void StartOtherCharacterAttackAnimation(int characterID);
+
+        void NotifyStartSpellCast(short playerId, short spellId);
+
+        void NotifySelfSpellCast(short playerId, short spellId, int spellHp, byte percentHealth);
+
+        void NotifyTargetOtherSpellCast(short sourcePlayerID, short targetPlayerID, short spellId, int recoveredHP, byte targetPercentHealth);
     }
 
     [AutoMappedType]
@@ -15,5 +21,11 @@ public class NoOpOtherCharacterAnimationNotifier : IOtherCharacterAnimationNotif
         public void StartOtherCharacterWalkAnimation(int characterID) { }
 
         public void StartOtherCharacterAttackAnimation(int characterID) { }
+
+        public void NotifyStartSpellCast(short playerId, short spellId) { }
+
+        public void NotifySelfSpellCast(short playerId, short spellId, int spellHp, byte percentHealth) { }
+
+        public void NotifyTargetOtherSpellCast(short sourcePlayerID, short targetPlayerID, short spellId, int recoveredHP, byte targetPercentHealth) { }
     }
 }