Removed the entire custom position and role sync API, replaced via patches enumerating through ExPlayer collections instead of ReferenceHub

Author: marchellcx

LabExtended/API/Containers/RoleContainer.cs

@@ -426,29 +426,6 @@ public bool IsWearingScp1344
     public ZombieRole? ZombieRole => Role as ZombieRole;
     #endregion
 
-    /// <summary>
-    /// Gets the role type that the current player appears to have from the perspective of the specified target player.
-    /// </summary>
-    /// <param name="target">The player whose perspective is used to determine the appearance. Cannot be null.</param>
-    /// <param name="allowOverwatchSpoof">Indicates whether Overwatch role spoofing should be considered when determining the appearance. If <see
-    /// langword="true"/>, the returned role may be spoofed for Overwatch purposes; otherwise, the actual role is used.</param>
-    /// <returns>The role type identifier representing how the current player appears to the target player.</returns>
-    /// <exception cref="ArgumentNullException">Thrown if <paramref name="target"/> is null or does not have a valid reference hub.</exception>
-    public RoleTypeId GetAppearance(ExPlayer target, bool allowOverwatchSpoof = true)
-    {
-        if (target?.ReferenceHub == null)
-            throw new ArgumentNullException(nameof(target));
-
-        var appearance = allowOverwatchSpoof
-            ? RoleSync.GetSpoofedRoleToSend(Player, target)
-            : RoleSync.GetRoleToSend(Player, target);
-
-        if (CustomRole != null)
-            appearance = CustomRole.GetAppearance(Player, target, appearance, ref customRoleData);
-
-        return appearance;
-    }
-
     /// <summary>
     /// Sets the player's current role.
     /// </summary>

LabExtended/API/ExPlayer.cs

@@ -66,10 +66,13 @@
 using VoiceChat;
 
 using System.Text;
+
 using InventorySystem.Items.Firearms;
 using InventorySystem.Items.Firearms.Modules;
 using InventorySystem.Items.Firearms.ShotEvents;
+
 using LabExtended.Core;
+
 using PlayerStatsSystem;
 
 #pragma warning disable CS8602 // Dereference of a possibly null reference.
@@ -726,18 +729,6 @@ public ExPlayer(ReferenceHub referenceHub, SwitchContainer toggles) : base(refer
     public HashSet<PersonalHintElement> HintElements { get; internal set; } =
         HashSetPool<PersonalHintElement>.Shared.Rent();
 
-    /// <summary>
-    /// Gets a list of sent role cache.
-    /// </summary>
-    public Dictionary<uint, RoleTypeId> SentRoles { get; private set; } =
-        DictionaryPool<uint, RoleTypeId>.Shared.Rent();
-    
-    /// <summary>
-    /// Gets a list of sent positions.
-    /// </summary>
-    public Dictionary<uint, PositionSync.SentPosition> SentPositions { get; private set; } =
-        DictionaryPool<uint, PositionSync.SentPosition>.Shared.Rent();
-
     /// <summary>
     /// Gets the currently spectated player.
     /// </summary>
@@ -1461,9 +1452,6 @@ public void Dispose()
             if (ply == null) 
                 return;
 
-            ply.SentRoles.Remove(NetworkId);
-            ply.SentPositions.Remove(NetworkId);
-
             ply.PersonalGhostFlags &= ~GhostBit;
         });
 
@@ -1519,12 +1507,6 @@ public void Dispose()
 
         if (Hints != null)
             ObjectPool<HintCache>.Shared.Return(Hints);
-        
-        if (SentRoles != null)
-            DictionaryPool<uint, RoleTypeId>.Shared.Return(SentRoles);
-        
-        if (SentPositions != null)
-            DictionaryPool<uint, PositionSync.SentPosition>.Shared.Return(SentPositions);
 
         if (infoBuilder != null)
             StringBuilderPool.Shared.Return(infoBuilder);
@@ -1541,9 +1523,6 @@ public void Dispose()
 
         Hints = null;
 
-        SentRoles = null!;
-        SentPositions = null!;
-
         Position = null!;
         Rotation = null!;
     }

LabExtended/Core/ApiLoader.cs

@@ -375,9 +375,6 @@ private static void InvokeApi(bool isPreload)
 
             FirearmModuleCache.Internal_Init();
 
-            PositionSync.Internal_Init();
-            RoleSync.Internal_Init();
-
             PlayerLoopHelper.Internal_InitLast(); // has to be last
         }
     }

LabExtended/Core/ApiVersion.cs

@@ -20,7 +20,7 @@ public static class ApiVersion
     /// <summary>
     /// The build version part.
     /// </summary>
-    public const int Build = 4;
+    public const int Build = 5;
 
     /// <summary>
     /// The patch version part.
@@ -35,8 +35,7 @@ public static class ApiVersion
     /// <summary>
     /// Gets the game's current version.
     /// </summary>
-    public static Version Game { get; } =
-        new(GameCore.Version.Major, GameCore.Version.Minor, GameCore.Version.Revision);
+    public static Version Game { get; } = new(GameCore.Version.Major, GameCore.Version.Minor, GameCore.Version.Revision);
 
     /// <summary>
     /// Gets the loader's game version compatibility.

LabExtended/Core/Configs/Objects/ConfigEffect.cs

@@ -256,7 +256,9 @@ public bool Apply(ExPlayer player)
             }
             else
             {
-                ApiLog.Warn("LabExtended", $"Tried to apply an invalid config effect (&3{Name}&r)!");
+                if (!string.IsNullOrEmpty(Name))
+                    ApiLog.Warn("LabExtended", $"Tried to apply an invalid config effect (&3{Name}&r)!");
+
                 return false;
             }
         }
@@ -275,7 +277,7 @@ private void TryGet()
                 this.customEffect = customEffect;
             else if (BaseEffects.TryGetFirst(x => string.Equals(x.Name, Name, StringComparison.OrdinalIgnoreCase), out var baseEffect))
                 this.baseEffect = baseEffect;
-            else
+            else if (!string.IsNullOrEmpty(Name))
                 ApiLog.Warn("LabExtended", $"Effect &3{Name}&r could not be found in config.");
         }
     }

LabExtended/Events/SingletonBooleanEventArgs.cs

@@ -0,0 +1,29 @@
+namespace LabExtended.Events
+{
+    /// <summary>
+    /// Provides event data for singleton event scenarios, using a single shared instance of the event type.
+    /// </summary>
+    /// <remarks>This class is intended for use in event patterns where a single, reusable instance of event
+    /// data is sufficient. The static singleton instance is created using the default constructor of the specified
+    /// event type. This can help reduce allocations in high-frequency event scenarios. The ResetEvent method can be
+    /// overridden to reset the state of the singleton event data before it is reused.</remarks>
+    /// <typeparam name="TEvent">The type of the event data to be used as a singleton instance.</typeparam>
+    public class SingletonBooleanEventArgs<TEvent> : BooleanEventArgs
+    {
+        /// <summary>
+        /// Gets a singleton instance of the event type.
+        /// </summary>
+        /// <remarks>The singleton instance is created using the default constructor of the event type.
+        /// This property is useful when a single, shared instance of the event is sufficient for application logic. The
+        /// instance is created once and reused for all subsequent accesses.</remarks>
+        public static TEvent Singleton { get; } = Activator.CreateInstance<TEvent>();
+
+        /// <summary>
+        /// Resets the event to its initial state.
+        /// </summary>
+        public virtual void ResetEvent()
+        {
+            IsAllowed = true;
+        }
+    }
+}

LabExtended/Events/SingletonEventArgs.cs

@@ -0,0 +1,29 @@
+namespace LabExtended.Events
+{
+    /// <summary>
+    /// Provides event data for singleton event scenarios, using a single shared instance of the event type.
+    /// </summary>
+    /// <remarks>This class is intended for use in event patterns where a single, reusable instance of event
+    /// data is sufficient. The static singleton instance is created using the default constructor of the specified
+    /// event type. This can help reduce allocations in high-frequency event scenarios. The ResetEvent method can be
+    /// overridden to reset the state of the singleton event data before it is reused.</remarks>
+    /// <typeparam name="TEvent">The type of the event data to be used as a singleton instance.</typeparam>
+    public class SingletonEventArgs<TEvent> : EventArgs
+    {
+        /// <summary>
+        /// Gets a singleton instance of the event type.
+        /// </summary>
+        /// <remarks>The singleton instance is created using the default constructor of the event type.
+        /// This property is useful when a single, shared instance of the event is sufficient for application logic. The
+        /// instance is created once and reused for all subsequent accesses.</remarks>
+        public static TEvent Singleton { get; } = Activator.CreateInstance<TEvent>();
+
+        /// <summary>
+        /// Resets the event to its initial state.
+        /// </summary>
+        public virtual void ResetEvent()
+        {
+
+        }
+    }
+}

LabExtended/Extensions/EventExtensions.cs

@@ -15,6 +15,29 @@ namespace LabExtended.Extensions;
 /// </summary>
 public static class EventExtensions
 {
+    /// <summary>
+    /// Resets the event state for the specified event argument instance, if supported.
+    /// </summary>
+    /// <remarks>This method has an effect only if <paramref name="obj"/> is an instance of a supported
+    /// singleton event argument type, such as <see cref="SingletonEventArgs{TEvent}"/> or <see
+    /// cref="SingletonBooleanEventArgs{TEvent}"/>. For other types, the method performs no action.</remarks>
+    /// <typeparam name="TEvent">The type of the event argument object. Must be compatible with supported singleton event argument types.</typeparam>
+    /// <param name="obj">The event argument instance whose event state is to be reset.</param>
+    public static void ResetEvent<TEvent>(this TEvent obj)
+    {
+        if (obj is SingletonEventArgs<TEvent> singletonEventArgs)
+        {
+            singletonEventArgs.ResetEvent();
+            return;
+        }
+
+        if (obj is SingletonBooleanEventArgs<TEvent> singletonBooleanEventArgs)
+        {
+            singletonBooleanEventArgs.ResetEvent();
+            return;
+        }
+    }
+
     /// <summary>
     /// Invokes the <see cref="ExVoiceChatEvents.ReceivingVoiceMessageEventHandler"/> delegate.
     /// </summary>

LabExtended/LabExtended.csproj

@@ -4,8 +4,8 @@
         <TargetFramework>net48</TargetFramework>
         <Nullable>enable</Nullable>
         <LangVersion>preview</LangVersion>
-        <AssemblyVersion>1.2.0.0</AssemblyVersion>
-        <FileVersion>1.2.0.0</FileVersion>
+        <AssemblyVersion>1.5.0.0</AssemblyVersion>
+        <FileVersion>1.5.0.0</FileVersion>
         <ImplicitUsings>enable</ImplicitUsings>
         <AssemblyName>0LabExtended</AssemblyName>
         <AllowUnsafeBlocks>True</AllowUnsafeBlocks>

LabExtended/Patches/Events/Player/PlayerSpawningPatch.cs

@@ -10,7 +10,12 @@
 using LabExtended.Utilities;
 using LabExtended.Extensions;
 
+using LabExtended.Patches.Functions.Players;
+
+using Mirror;
+
 using PlayerRoles;
+using PlayerRoles.FirstPersonControl.NetworkMessages;
 
 namespace LabExtended.Patches.Events.Player;
 
@@ -68,14 +73,8 @@ changingArgs.NewRole is RoleTypeId.Spectator &&
                 __instance.InitializeNewRole(newRole, reason, spawnFlags);
 
                 beforeSendAction?.InvokeSafe(__instance.CurrentRole);
-                
-                if (RoleSync.IsEnabled)
-                    RoleSync.Internal_Resync(player);
-                else
-                    __instance.SendNewRoleInfo();
-                
-                if (PositionSync.IsEnabled)
-                    PositionSync.Internal_Reset(player);
+
+                SendNewRoleInfo(player);
 
                 PlayerEvents.OnChangedRole(new PlayerChangedRoleEventArgs(player.ReferenceHub,
                     curRole?.RoleTypeId ?? RoleTypeId.None,
@@ -90,4 +89,29 @@ changingArgs.NewRole is RoleTypeId.Spectator &&
             return true;
         }
     }
+
+    private static void SendNewRoleInfo(ExPlayer player)
+    {
+        for (var x = 0; x < ExPlayer.AllCount; x++)
+        {
+            var receiver = ExPlayer.AllPlayers[x];
+
+            if (receiver?.ReferenceHub == null) continue;
+            if (receiver.ReferenceHub.isLocalPlayer) continue;
+
+            var visibleRole = FpcServerPositionDistributor.GetVisibleRole(receiver.ReferenceHub, player.ReferenceHub);
+
+            using var writer = NetworkWriterPool.Get();
+
+            var baseRoleEvent = FpcServerPositionDistributor.InvokeRoleSyncEvent(player.ReferenceHub, receiver.ReferenceHub, visibleRole, writer);
+            var roleEvent = PlayerPositionSyncPatch.InvokeEvent(player, receiver, visibleRole, writer);
+
+            if (baseRoleEvent != null) visibleRole = baseRoleEvent.Value;
+            if (roleEvent != null) visibleRole = roleEvent.Value;
+
+            receiver.ReferenceHub.connectionToClient.Send(new RoleSyncInfo(player.ReferenceHub, visibleRole, receiver.ReferenceHub, writer), 0);
+
+            player.ReferenceHub.roleManager.PreviouslySentRole[receiver.ReferenceHub.netId] = visibleRole;
+        }
+    }
 }