Overhaul of Entity Transmit.

Author: CookStar

addons/source-python/packages/source-python/entities/_base.py

@@ -67,6 +67,7 @@
 # Source.Python Imports
 #   Entities
 from _entities._entity import BaseEntity
+from _entities._transmit import TransmitManager
 
 
 # =============================================================================
@@ -779,6 +780,71 @@ def set_parent(self, parent, attachment=INVALID_ATTACHMENT_INDEX):
 
         return [parent, attachment]
 
+    # =========================================================================
+    # >> ENTITY TRANSMIT FUNCTIONALITY
+    # =========================================================================
+    def hide(self):
+        """Hide the entity from all players."""
+        TransmitManager.hide(self.index)
+
+    def hide_from(self, player_index):
+        """Hide the entity from player.
+
+        :param int player_index:
+            The target player index to hide this entity.
+        """
+        TransmitManager.hide_from(self.index, player_index)
+
+    def show(self):
+        """Show the entity to all players."""
+        TransmitManager.show(self.index)
+
+    def show_from(self, player_index):
+        """Show the entity to player.
+
+        :param int player_index:
+            The target player index to show this entity.
+        """
+        TransmitManager.show_from(self.index, player_index)
+
+    def reset(self):
+        """Reset the entity's hidden/shown state."""
+        TransmitManager.reset(self.index)
+
+    def reset_from(self, player_index):
+        """Reset the player's entity hidden/shown state.
+
+        :param int player_index:
+            The target player index to reset the player's hidden/shown state.
+        """
+        TransmitManager.reset_from(self.index, player_index)
+
+    def is_hidden(self):
+        """Return True if the entity is hidden from any player.
+
+        :rtype: bool
+        """
+        return TransmitManager.is_hidden(self.index)
+
+    def is_hidden_from(self, player_index):
+        """Return True if the entity is hidden from the player.
+
+        :param int player_index:
+            The target player index to check if the entity is hidden.
+        :rtype: bool
+        """
+        return TransmitManager.is_hidden_from(self.index, player_index)
+
+    def get_hidden_player(self):
+        """Get the players where the entity is hidden.
+
+        :return:
+            A tuple containing :class:`players.entity.Player` instances
+            in which the entity is hidden.
+        :rtype: tuple
+        """
+        return TransmitManager.get_hidden_player(self.index)
+
 
 # =============================================================================
 # >> LISTENERS
@@ -814,3 +880,6 @@ def _on_entity_deleted(base_entity):
     # Invalidate the internal entity caches for this entity
     for cls in _entity_classes:
         cls.cache.pop(index, None)
+
+    # Reset the entity's hidden state.
+    TransmitManager.reset(index)

addons/source-python/packages/source-python/entities/transmit.py

@@ -15,26 +15,34 @@
 from filters.entities import EntityIter
 #   Listeners
 from listeners import on_entity_created_listener_manager
-from listeners import on_entity_deleted_listener_manager
 
 
 # ============================================================================
 # >> FORWARD IMPORTS
 # ============================================================================
 # Source.Python
 #   Entities
-from _entities._transmit import transmit_manager
+from _entities._transmit import TransmitManager
 
 
 # ============================================================================
 # >> ALL DECLARATION
 # ============================================================================
 __all__ = (
-    'transmit_manager',
+    'TransmitManager',
+    'reset_hidden_state',
 )
 
 
 # ============================================================================
 # >> CLASSES
 # ============================================================================
 
+
+# =============================================================================
+# >> FUNCTIONS
+# =============================================================================
+def reset_hidden_state():
+    """Reset all entities' hidden/shown state."""
+    TransmitManager.reset_all()
+

addons/source-python/packages/source-python/players/_base.py

@@ -73,6 +73,14 @@
 from auth.manager import auth_manager
 
 
+# =============================================================================
+# >> FORWARD IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Entities
+from _entities._transmit import TransmitManager
+
+
 # =============================================================================
 # >> CLASSES
 # =============================================================================
@@ -994,6 +1002,56 @@ def drop_weapon(self, weapon, target=None, velocity=None):
         """
         return [weapon, target, velocity]
 
+    # =========================================================================
+    # >> PLAYER TRANSMIT FUNCTIONALITY
+    # =========================================================================
+    def hide_entity(self, entity_index):
+        """Hide the entity from player.
+
+        :param int entity_index:
+            The target entity index to hide from the player.
+        """
+        TransmitManager.hide_from(entity_index, self.index)
+
+    def show_entity(self, entity_index):
+        """Show the entity to player.
+
+        :param int entity_index:
+            The target entity index to show the entity to player.
+        """
+        TransmitManager.show_from(entity_index, self.index)
+
+    def reset_entity(self, entity_index):
+        """Reset the player's entity hidden/shown state.
+
+        :param int entity_index:
+            The target entity_index to reset the player's hidden/shown state.
+        """
+        TransmitManager.reset_from(entity_index, self.index)
+
+    def reset_player(self):
+        """Reset the player's hidden/shown state on all entities."""
+        TransmitManager.reset_player(self.index)
+
+    def is_entity_hidden(self, entity_index):
+        """Return True if the entity is hidden from the player.
+
+        :param int entity_index:
+            The target entity index to check if the entity is hidden.
+        :rtype: bool
+        """
+        return TransmitManager.is_hidden_from(entity_index, self.index)
+
+    def get_hidden_entity(self):
+        """Get the entities that are hidden from the player.
+
+        :return:
+            A tuple containing :class:`entities.entity.Entity` instances
+            that are hidden from the player.
+        :rtype: tuple
+        """
+        return TransmitManager.get_hidden_entity(self.index)
+
 
 # =============================================================================
 # >> HELPER FUNCTIONS