feat: VoiceLinesEventArgs VoiceLinesName ClipId Scp3114VoiceLines & fix issue that it's was called too early (#826)

Author: louis1706

EXILED/Exiled.Events/EventArgs/Scp3114/VoiceLinesEventArgs.cs

@@ -21,20 +21,17 @@ public class VoiceLinesEventArgs : IScp3114Event, IDeniableEvent
         /// <summary>
         /// Initializes a new instance of the <see cref="VoiceLinesEventArgs" /> class.
         /// </summary>
-        /// <param name="player">
-        /// <inheritdoc cref="Player" />
-        /// </param>
-        /// <param name="voiceLine">
-        /// <inheritdoc cref="VoiceLine" />
-        /// </param>
-        /// <param name="isAllowed">
-        /// <inheritdoc cref="IsAllowed" />
-        /// </param>
-        public VoiceLinesEventArgs(ReferenceHub player, VoiceLinesDefinition voiceLine, bool isAllowed = true)
+        /// <param name="scp3114VoiceLines"><inheritdoc cref="Scp3114VoiceLines" /> </param>
+        /// <param name="voiceLineDefinition"><inheritdoc cref="VoiceLine" /> </param>
+        /// <param name="clipId"><inheritdoc cref="ClipId" /> </param>
+        /// <param name="isAllowed"><inheritdoc cref="IsAllowed" /></param>
+        public VoiceLinesEventArgs(PlayerRoles.PlayableScps.Scp3114.Scp3114VoiceLines scp3114VoiceLines, VoiceLinesDefinition voiceLineDefinition, byte clipId, bool isAllowed = true)
         {
-            Player = Player.Get(player);
+            Scp3114VoiceLines = scp3114VoiceLines;
+            Player = Player.Get(scp3114VoiceLines.Owner);
             Scp3114 = Player.Role.As<Scp3114Role>();
-            VoiceLine = voiceLine;
+            VoiceLine = voiceLineDefinition;
+            ClipId = clipId;
             IsAllowed = isAllowed;
         }
 
@@ -44,11 +41,53 @@ public VoiceLinesEventArgs(ReferenceHub player, VoiceLinesDefinition voiceLine,
         /// <inheritdoc/>
         public Scp3114Role Scp3114 { get; }
 
+        /// <summary>
+        /// Gets the <see cref="PlayerRoles.PlayableScps.Scp3114.Scp3114VoiceLines" />.
+        /// </summary>
+        public PlayerRoles.PlayableScps.Scp3114.Scp3114VoiceLines Scp3114VoiceLines { get; }
+
         /// <summary>
         /// Gets or sets the <see cref="VoiceLinesDefinition" />.
         /// </summary>
         public VoiceLinesDefinition VoiceLine { get; set; }
 
+        /// <summary>
+        /// Gets or sets the <see cref="PlayerRoles.PlayableScps.Scp3114.Scp3114VoiceLines.VoiceLinesName" />.
+        /// </summary>
+        public VoiceLinesName VoiceLinesName
+        {
+            get => VoiceLine.Label;
+            set
+            {
+                if (value == VoiceLine.Label)
+                    return;
+
+                foreach (VoiceLinesDefinition voiceLinesDefinition in Scp3114VoiceLines._voiceLines)
+                {
+                    if (voiceLinesDefinition.Label != value)
+                        continue;
+
+                    VoiceLine = voiceLinesDefinition;
+                    return;
+                }
+
+                Log.Error($"[{typeof(VoiceLinesEventArgs)}.{nameof(VoiceLinesName)}] didn't found VoiceLinesName: {value}");
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the <see cref="VoiceLinesDefinition" />.
+        /// </summary>
+        public byte ClipId
+        {
+            get => (byte)VoiceLine._lastIndex;
+            set
+            {
+                value = (byte)(value % VoiceLine._order.Count);
+                VoiceLine._lastIndex = value;
+            }
+        }
+
         /// <inheritdoc/>
         public bool IsAllowed { get; set; }
     }

EXILED/Exiled.Events/Patches/Events/Scp3114/VoiceLines.cs

@@ -20,6 +20,7 @@ namespace Exiled.Events.Patches.Events.Scp3114
     using PlayerRoles.PlayableScps.Scp3114;
 
     using static HarmonyLib.AccessTools;
+    using static PlayerRoles.PlayableScps.Scp3114.Scp3114VoiceLines;
 
     /// <summary>
     ///     Patches <see cref="Scp3114VoiceLines.ServerPlayConditionally" />.
@@ -37,29 +38,31 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
 
             LocalBuilder ev = generator.DeclareLocal(typeof(VoiceLinesEventArgs));
 
-            int offset = 1;
-            int index = newInstructions.FindIndex(instruction => instruction.opcode == OpCodes.Blt_S) + offset;
+            int offset = 3;
+            int index = newInstructions.FindIndex(instruction => instruction.Calls(Method(typeof(VoiceLinesDefinition), nameof(VoiceLinesDefinition.TryDrawNext)))) + offset;
 
             newInstructions.InsertRange(index, new CodeInstruction[]
             {
-                // this.Owner
-                new(OpCodes.Ldarg_0),
-                new(OpCodes.Callvirt, PropertyGetter(typeof(Scp3114VoiceLines), nameof(Scp3114VoiceLines.Owner))),
+                // this
+                new CodeInstruction(OpCodes.Ldarg_0).MoveLabelsFrom(newInstructions[index]),
 
                 // voiceLinesDefinition
                 new(OpCodes.Ldloc_0),
 
+                // clipId
+                new(OpCodes.Ldloc_2),
+
                 // true
                 new(OpCodes.Ldc_I4_1),
 
-                // VoiceLinesEventArgs ev = new VoiceLinesEventArgs(ReferenceHub, VoiceLinesDefinition, bool);
+                // VoiceLinesEventArgs ev = new VoiceLinesEventArgs(Scp3114VoiceLines, VoiceLinesDefinition, byte, bool);
                 new(OpCodes.Newobj, GetDeclaredConstructors(typeof(VoiceLinesEventArgs))[0]),
                 new(OpCodes.Dup),
                 new(OpCodes.Dup),
                 new(OpCodes.Stloc_S, ev.LocalIndex),
 
                 // Handlers.Scp3114.OnVoiceLines(ev);
-                new(OpCodes.Call, Method(typeof(Handlers.Scp3114), nameof(Handlers.Scp3114.OnVoiceLines))),
+                new(OpCodes.Call, Method(typeof(Scp3114), nameof(Scp3114.OnVoiceLines))),
 
                 // if(!ev.IsAllowed)
                 //     return;
@@ -70,6 +73,11 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
                 new(OpCodes.Ldloc_S, ev.LocalIndex),
                 new(OpCodes.Callvirt, PropertyGetter(typeof(VoiceLinesEventArgs), nameof(VoiceLinesEventArgs.VoiceLine))),
                 new(OpCodes.Stloc_S, 0),
+
+                // clipId = ev.ClipId;
+                new(OpCodes.Ldloc_S, ev.LocalIndex),
+                new(OpCodes.Callvirt, PropertyGetter(typeof(VoiceLinesEventArgs), nameof(VoiceLinesEventArgs.ClipId))),
+                new(OpCodes.Stloc_S, 2),
             });
 
             newInstructions[newInstructions.Count - 1].labels.Add(returnLabel);