feat: logout common event trigger (AscensionGameDev#2654)

* feat: logout common event trigger

* add all triggers on param setting

Author: WeylonSantana

Framework/Intersect.Framework.Core/GameObjects/Events/CommonEventTrigger.cs

@@ -41,4 +41,6 @@ public enum CommonEventTrigger
     UserVariableChange,
 
     LevelDown,
+
+    Logout,
 }

Intersect.Editor/Forms/Editors/Events/frmEvent.cs

@@ -1007,10 +1007,7 @@ public void InitEditor(bool disableNaming, bool disableTriggers, bool questEvent
         {
             grpEntityOptions.Hide();
             cmbTrigger.Items.Clear();
-            for (var i = 0; i < Strings.EventEditor.commontriggers.Count; i++)
-            {
-                cmbTrigger.Items.Add(Strings.EventEditor.commontriggers[i]);
-            }
+            cmbTrigger.Items.AddRange([.. Strings.EventEditor.CommonTriggers.Values]);
         }
         else
         {

Intersect.Editor/Localization/Strings.cs

@@ -2828,28 +2828,29 @@ public partial struct EventEditor
 
         public static LocalizedString commandlist = @"Commands:";
 
-        public static Dictionary<int, LocalizedString> commontriggers = new Dictionary<int, LocalizedString>
+        public static Dictionary<CommonEventTrigger, LocalizedString> CommonTriggers = new()
         {
-            {0, @"None"},
-            {1, @"Login"},
-            {2, @"Level Up"},
-            {3, @"On Respawn"},
-            {4, @"/Command"},
-            {5, @"Autorun"},
-            {6, @"PVP Kill"},
-            {7, @"PVP Death"},
-            {8, @"Player Interact"},
-            {9, @"Equipment Changed"},
-            {10, @"Player Variable Changed"},
-            {11, @"Server Variable Changed"},
-            {12, @"Guild Member Joined"},
-            {13, @"Guild Member Left"},
-            {14, @"Guild Member Kicked"},
-            {15, @"Guild Variable Changed"},
-            {16, @"Inventory Changed"},
-            {17, @"Map Changed"},
-            {18, @"User Variable Changed"},
-            {19, @"Level Down"},
+            {CommonEventTrigger.None, @"None"},
+            {CommonEventTrigger.Login, @"Login"},
+            {CommonEventTrigger.LevelUp, @"Level Up"},
+            {CommonEventTrigger.OnRespawn, @"On Respawn"},
+            {CommonEventTrigger.SlashCommand, @"/Command"},
+            {CommonEventTrigger.Autorun, @"Autorun"},
+            {CommonEventTrigger.PVPKill, @"PVP Kill"},
+            {CommonEventTrigger.PVPDeath, @"PVP Death"},
+            {CommonEventTrigger.PlayerInteract, @"Player Interact"},
+            {CommonEventTrigger.EquipChange, @"Equipment Changed"},
+            {CommonEventTrigger.PlayerVariableChange, @"Player Variable Changed"},
+            {CommonEventTrigger.ServerVariableChange, @"Server Variable Changed"},
+            {CommonEventTrigger.GuildMemberJoined, @"Guild Member Joined"},
+            {CommonEventTrigger.GuildMemberLeft, @"Guild Member Left"},
+            {CommonEventTrigger.GuildMemberKicked, @"Guild Member Kicked"},
+            {CommonEventTrigger.GuildVariableChange, @"Guild Variable Changed"},
+            {CommonEventTrigger.InventoryChanged, @"Inventory Changed"},
+            {CommonEventTrigger.MapChanged, @"Map Changed"},
+            {CommonEventTrigger.UserVariableChange, @"User Variable Changed"},
+            {CommonEventTrigger.LevelDown, @"Level Down"},
+            {CommonEventTrigger.Logout, @"Logout"},
         };
 
         public static LocalizedString conditions = @"Conditions";

Intersect.Server.Core/Entities/Player.cs

@@ -512,6 +512,11 @@ private void Logout(bool softLogout = false, TaskCompletionSource? logoutComplet
             instance.RemoveEntity(this);
         }
 
+        foreach (var player in OnlinePlayersById.Values)
+        {
+            player.StartCommonEventsWithTrigger(CommonEventTrigger.Logout, param: Name);
+        }
+
         RemoveFromInstanceController(MapInstanceId);
 
         //Update parties
@@ -7203,39 +7208,49 @@ public bool UnsafeStartCommonEvent(
                     switch (trigger)
                     {
                         case CommonEventTrigger.None:
-                            break;
                         case CommonEventTrigger.Login:
-                            break;
                         case CommonEventTrigger.LevelUp:
-                            break;
                         case CommonEventTrigger.OnRespawn:
-                            break;
                         case CommonEventTrigger.SlashCommand:
-                            break;
                         case CommonEventTrigger.Autorun:
+                        case CommonEventTrigger.EquipChange:
+                        case CommonEventTrigger.PlayerVariableChange:
+                        case CommonEventTrigger.ServerVariableChange:
+                        case CommonEventTrigger.GuildVariableChange:
+                        case CommonEventTrigger.InventoryChanged:
+                        case CommonEventTrigger.MapChanged:
+                        case CommonEventTrigger.UserVariableChange:
+                        case CommonEventTrigger.LevelDown:
                             break;
+
                         case CommonEventTrigger.PVPKill:
                             //Add victim as a parameter
                             newEvent.SetParam("victim", param);
-
                             break;
+
                         case CommonEventTrigger.PVPDeath:
                             //Add killer as a parameter
                             newEvent.SetParam("killer", param);
-
                             break;
+
                         case CommonEventTrigger.PlayerInteract:
                             //Interactee as a parameter
                             newEvent.SetParam("triggered", param);
-
                             break;
+
                         case CommonEventTrigger.GuildMemberJoined:
                         case CommonEventTrigger.GuildMemberKicked:
                         case CommonEventTrigger.GuildMemberLeft:
                             newEvent.SetParam("member", param);
                             newEvent.SetParam("guild", command);
+                            break;
 
+                        case CommonEventTrigger.Logout:
+                            newEvent.SetParam("player", param);
                             break;
+
+                        default:
+                            throw Exceptions.UnreachableInvalidEnum(trigger);
                     }
 
                     var newStack = new CommandInstance(newEvent.PageInstance.MyPage);