Core/Objects: Implemented vignettes

Port From (https://github.com/TrinityCore/TrinityCore/commit/fccf6fb72b60b08dfbe6d5fb17fba55239944fca)

Source/Game/Entities/Unit/Unit.Combat.cs

@@ -928,6 +928,20 @@ namespace Game.Entities
                     }
                 }
 
+                VignetteData vignette = victim.GetVignette();
+                if (vignette != null)
+                {
+                    foreach (Player tapper in tappers)
+                    {
+                        Quest reward = Global.ObjectMgr.GetQuestTemplate((uint)vignette.Data.RewardQuestID);
+                        if (reward != null)
+                            tapper.RewardQuest(reward, LootItemType.Item, 0, victim, false);
+
+                        if (vignette.Data.VisibleTrackingQuestID != 0)
+                            tapper.SetRewardedQuest(vignette.Data.VisibleTrackingQuestID);
+                    }
+                }
+
                 new KillRewarder(tappers.ToArray(), victim, false).Reward();
             }
 

Source/Game/Entities/Unit/Unit.Fields.cs

@@ -110,6 +110,7 @@ namespace Game.Entities
         public UnitTypeMask UnitTypeMask { get; set; }
         UnitState m_state;
         protected LiquidTypeRecord _lastLiquid;
+        VignetteData m_vignette;
         protected DeathState m_deathState;
         public Vehicle m_vehicle { get; set; }
         public Vehicle VehicleKit { get; set; }

Source/Game/Entities/Unit/Unit.Movement.cs

@@ -684,6 +684,10 @@ namespace Game.Entities
             if (isInWater)
                 RemoveAurasWithInterruptFlags(SpellAuraInterruptFlags2.Swimming);
 
+            // TODO: on heartbeat
+            if (m_vignette != null)
+                Vignettes.Update(m_vignette, this);
+
             return (relocated || turn);
         }
 

Source/Game/Entities/Unit/Unit.cs

@@ -538,6 +538,8 @@ namespace Game.Entities
             // This needs to be before RemoveFromWorld to make GetCaster() return a valid for aura removal
             InterruptNonMeleeSpells(true);
 
+            SetVignette(0);
+
             if (IsInWorld)
                 RemoveFromWorld();
             else
@@ -939,6 +941,24 @@ namespace Game.Entities
             return collisionHeight1 == 0.0f ? MapConst.DefaultCollesionHeight : collisionHeight1;
         }
 
+        public override VignetteData GetVignette() { return m_vignette; }
+
+        public void SetVignette(uint vignetteId)
+        {
+            if (m_vignette != null)
+            {
+                if (m_vignette.Data.ID == vignetteId)
+                    return;
+
+                Vignettes.Remove(m_vignette, this);
+                m_vignette = null;
+            }
+
+            var vignette = CliDB.VignetteStorage.LookupByKey(vignetteId);
+            if (vignette != null)
+                m_vignette = Vignettes.Create(vignette, this);
+        }
+
         public override string GetDebugInfo()
         {
             string str = $"{base.GetDebugInfo()}\nIsAIEnabled: {IsAIEnabled()} DeathState: {GetDeathState()} UnitMovementFlags: {GetUnitMovementFlags()} UnitMovementFlags2: {GetUnitMovementFlags2()} Class: {GetClass()}\n" +
@@ -1574,6 +1594,9 @@ namespace Game.Entities
                 SetEmoteState(Emote.OneshotNone);
                 SetStandState(UnitStandStateType.Stand);
 
+                if (m_vignette != null && !m_vignette.Data.GetFlags().HasFlag(VignetteFlags.PersistsThroughDeath))
+                    SetVignette(0);
+
                 // players in instance don't have ZoneScript, but they have InstanceScript
                 ZoneScript zoneScript = GetZoneScript() != null ? GetZoneScript() : GetInstanceScript();
                 if (zoneScript != null)

Source/Game/Entities/Unit/Vignette.cs

@@ -0,0 +1,147 @@
+// Copyright (c) CypherCore <http://github.com/CypherCore> All rights reserved.
+// Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE file in the project root for full license information.
+
+using Framework.Constants;
+using Game.DataStorage;
+using Game.Maps;
+using Game.Networking.Packets;
+using System.Collections.Generic;
+
+namespace Game.Entities
+{
+    static class Vignettes
+    {
+        public static void UpdatePosition(VignetteData vignette, WorldObject owner)
+        {
+            vignette.Position = owner.GetPosition();
+            WmoLocation wmoLocation = owner.GetCurrentWmo();
+            if (wmoLocation != null)
+            {
+                vignette.WMOGroupID = (uint)wmoLocation.GroupId;
+                vignette.WMODoodadPlacementID = wmoLocation.UniqueId;
+            }
+        }
+
+        public static void SendVignetteUpdate(VignetteData vignette, WorldObject owner)
+        {
+            if (!owner.IsInWorld)
+                return;
+
+            VignetteUpdate vignetteUpdate = new();
+            vignette.FillPacket(vignetteUpdate.Updated);
+            vignetteUpdate.Write();
+
+            var sender = (Player receiver) =>
+            {
+                if (CanSee(receiver, vignette))
+                    receiver.SendPacket(vignetteUpdate);
+            };
+
+            MessageDistDeliverer notifier = new(owner, sender, owner.GetVisibilityRange());
+            Cell.VisitWorldObjects(owner, notifier, owner.GetVisibilityRange());
+        }
+
+        public static void SendVignetteAdded(VignetteData vignette, WorldObject owner)
+        {
+            if (!owner.IsInWorld)
+                return;
+
+            VignetteUpdate vignetteUpdate = new();
+            vignette.FillPacket(vignetteUpdate.Added);
+            vignetteUpdate.Write();
+
+            var sender = (Player receiver) =>
+            {
+                if (CanSee(receiver, vignette))
+                    receiver.SendPacket(vignetteUpdate);
+            };
+
+            MessageDistDeliverer notifier = new(owner, sender, owner.GetVisibilityRange());
+            Cell.VisitWorldObjects(owner, notifier, owner.GetVisibilityRange());
+        }
+
+        public static VignetteData Create(VignetteRecord vignetteData, WorldObject owner)
+        {
+            VignetteData vignette = new();
+            vignette.Guid = ObjectGuid.Create(HighGuid.Vignette, owner.GetMapId(), vignetteData.ID, owner.GetMap().GenerateLowGuid(HighGuid.Vignette));
+            vignette.Object = owner.GetGUID();
+            vignette.Position = owner.GetPosition();
+            vignette.Data = vignetteData;
+            vignette.ZoneID = owner.GetZoneId(); // not updateable
+            UpdatePosition(vignette, owner);
+
+            if (vignetteData.IsInfiniteAOI())
+                owner.GetMap().AddInfiniteAOIVignette(vignette);
+            else
+                SendVignetteAdded(vignette, owner);
+
+            return vignette;
+        }
+
+        public static void Update(VignetteData vignette, WorldObject owner)
+        {
+            UpdatePosition(vignette, owner);
+
+            if (vignette.Data.IsInfiniteAOI())
+                vignette.NeedUpdate = true;
+            else
+                SendVignetteUpdate(vignette, owner);
+        }
+
+        public static void Remove(VignetteData vignette, WorldObject owner)
+        {
+            if (vignette.Data.IsInfiniteAOI())
+                owner.GetMap().RemoveInfiniteAOIVignette(vignette);
+            else
+            {
+                VignetteUpdate vignetteUpdate = new();
+                vignetteUpdate.Removed.Add(vignette.Guid);
+                owner.SendMessageToSet(vignetteUpdate, true);
+            }
+        }
+
+        public static bool CanSee(Player player, VignetteData vignette)
+        {
+            if (vignette.Data.GetFlags().HasFlag(VignetteFlags.ZoneInfiniteAOI))
+                if (vignette.ZoneID != player.GetZoneId())
+                    return false;
+
+            if (vignette.Data.VisibleTrackingQuestID != 0)
+                if (player.IsQuestRewarded(vignette.Data.VisibleTrackingQuestID))
+                    return false;
+
+            var playerCondition = CliDB.PlayerConditionStorage.LookupByKey(vignette.Data.PlayerConditionID);
+            if (playerCondition != null && !ConditionManager.IsPlayerMeetingCondition(player, playerCondition))
+                return false;
+
+            return true;
+        }
+    }
+
+    public class VignetteData
+    {
+        public ObjectGuid Guid;
+        public ObjectGuid Object;
+        public Position Position;
+        public VignetteRecord Data;
+        public uint ZoneID;
+        public uint WMOGroupID;
+        public uint WMODoodadPlacementID;
+        public bool NeedUpdate;
+
+        public void FillPacket(VignetteDataSet dataSet)
+        {
+            dataSet.IDs.Add(Guid);
+
+            VignetteDataPkt data = new();
+            data.ObjGUID = Object;
+            data.Position = Position;
+            data.VignetteID = (int)Data.ID;
+            data.ZoneID = ZoneID;
+            data.WMOGroupID = WMOGroupID;
+            data.WMODoodadPlacementID = WMODoodadPlacementID;
+
+            dataSet.Data.Add(data);
+        }
+    }
+}