Entity collision and transmission functionalities. (#484)

Adds entity collision and transmission functionalities.

Author: jordanbriere

Diff for: addons/source-python/data/source-python/entities/bms/CBaseEntity.ini

@@ -49,6 +49,12 @@
         offset_windows = 109
         arguments = POINTER
 
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 180
+        offset_windows = 179
+        return_type = UINT
+
 
 [input]
 

Diff for: addons/source-python/data/source-python/entities/csgo/CBaseEntity.ini

@@ -51,3 +51,9 @@ srv_check = False
         offset_linux = 105
         offset_windows = 104
         arguments = POINTER
+
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 169
+        offset_windows = 168
+        return_type = UINT

Diff for: addons/source-python/data/source-python/entities/gmod/CBaseEntity.ini

@@ -48,3 +48,9 @@
         offset_linux = 103
         offset_windows = 102
         arguments = POINTER
+
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 173
+        offset_windows = 172
+        return_type = UINT

Diff for: addons/source-python/data/source-python/entities/l4d2/CBaseEntity.ini

@@ -48,3 +48,9 @@
         offset_linux = 110
         offset_windows = 109
         arguments = POINTER
+
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 178
+        offset_windows = 177
+        return_type = UINT

Diff for: addons/source-python/data/source-python/entities/orangebox/CBaseEntity.ini

@@ -49,6 +49,12 @@
         offset_windows = 100
         arguments = POINTER
 
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 168
+        offset_windows = 167
+        return_type = UINT
+
 
 [input]
 

Diff for: addons/source-python/data/source-python/entities/orangebox/tf/CBaseEntity.ini

@@ -48,3 +48,9 @@
         offset_linux = 106
         offset_windows = 105
         arguments = POINTER
+
+    # _ZNK11CBasePlayer25PhysicsSolidMaskForEntityEv
+    [[get_solid_mask]]
+        offset_linux = 174
+        offset_windows = 173
+        return_type = UINT

Diff for: addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst

@@ -324,6 +324,48 @@ Called when a networked entity has been spawned.
         pass
 
 
+OnEntityCollision
+-----------------
+
+Called when a non-player entity is about to collide with another entity.
+
+.. note::
+
+    This listener can be extremely noisy. Use :class:`entities.collisions.CollisionHash`,
+    :class:`entities.collisions.CollisionMap`, or :class:`entities.collisions.CollisionSet`
+    if you don't have dynamic conditions to test for.
+
+.. code-block:: python
+
+    from listeners import OnEntityCollision
+
+    @OnEntityCollision
+    def on_entity_collision(entity, other):
+        # Disable weapons/projectiles collisions with everything except players
+        return not (entity.is_weapon() and not other.is_player())
+
+
+OnEntityTransmit
+----------------
+
+Called when a non-player entity is about to be transmitted to a player.
+
+.. note::
+
+    This listener can be extremely noisy. Use :class:`entities.transmit.TransmitHash`,
+    :class:`entities.transmit.TransmitMap`, or :class:`entities.transmit.TransmitSet`
+    if you don't have dynamic conditions to test for.
+
+.. code-block:: python
+
+    from listeners import OnEntityTransmit
+
+    @OnEntityTransmit
+    def on_entity_transmit(player, entity):
+        # Never transmit hostages
+        return entity.classname != 'hostage_entity'
+
+
 OnLevelInit
 -----------
 
@@ -406,6 +448,50 @@ Called when the button state of a player changed.
     button or button combination has been pressed or released.
 
 
+OnPlayerCollision
+-----------------
+
+Called when a player is about to collide with an entity.
+
+.. note::
+
+    This listener can be extremely noisy. Use :class:`entities.collisions.CollisionHash`,
+    :class:`entities.collisions.CollisionMap`, or :class:`entities.collisions.CollisionSet`
+    if you don't have dynamic conditions to test for.
+
+.. code-block:: python
+
+    from listeners import OnPlayerCollision
+
+    @OnPlayerCollision
+    def on_player_collision(player, entity):
+        # Disable teammates collisions
+        if not entity.is_player():
+            return
+        return player.team_index != entity.team_index
+
+
+OnPlayerTransmit
+----------------
+
+Called when a player is about to be transmitted to another.
+
+.. note::
+
+    This listener can be extremely noisy. Use :class:`entities.transmit.TransmitHash`,
+    :class:`entities.transmit.TransmitMap`, or :class:`entities.transmit.TransmitSet`
+    if you don't have dynamic conditions to test for.
+
+.. code-block:: python
+
+    from listeners import OnPlayerTransmit
+
+    @OnPlayerTransmit
+    def on_player_transmit(player, other):
+        # Don't transmit teammates
+        return player.team != other.team
+
+
 OnPlayerRunCommand
 --------------------
 

Diff for: addons/source-python/docs/source-python/source/developing/modules/entities.collisions.rst

@@ -0,0 +1,7 @@
+entities.collisions module
+==========================
+    
+.. automodule:: entities.collisions
+    :members:
+    :undoc-members:
+    :show-inheritance:

Diff for: addons/source-python/docs/source-python/source/developing/modules/entities.transmit.rst

@@ -0,0 +1,7 @@
+entities.transmit module
+========================
+    
+.. automodule:: entities.transmit
+    :members:
+    :undoc-members:
+    :show-inheritance:

Diff for: addons/source-python/packages/source-python/entities/collisions.py

@@ -0,0 +1,87 @@
+# ../entities/collisions.py
+
+"""Provides entity collisions functionality."""
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Core
+from core import AutoUnload
+from core import WeakAutoUnload
+
+
+# =============================================================================
+# >> FORWARD IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Entities
+from _entities._collisions import BaseCollisionRules
+from _entities._collisions import CollisionHash
+from _entities._collisions import CollisionManager
+from _entities._collisions import CollisionMap
+from _entities._collisions import CollisionMode
+from _entities._collisions import CollisionSet
+from _entities._collisions import collision_manager
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = ('BaseCollisionRules',
+           'CollisionHash',
+           'CollisionHook',
+           'CollisionManager',
+           'CollisionMap',
+           'CollisionMode',
+           'CollisionSet',
+           'collision_manager',
+           )
+
+
+# =============================================================================
+# >> INITIALIZATION
+# =============================================================================
+# Inject WeakAutoUnload into BaseCollisionRules's hierarchy.
+if not issubclass(BaseCollisionRules, WeakAutoUnload):
+    BaseCollisionRules.__bases__ = (
+        WeakAutoUnload,) + BaseCollisionRules.__bases__
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class CollisionHook(AutoUnload):
+    """Decorator used to create collision hooks that auto unload.
+
+    Example:
+
+    .. code:: python
+
+        from engines.trace import ContentFlags
+        from entities.collisions import CollisionHook
+
+        @CollisionHook
+        def collision_hook(entity, other, trace_filter, mask):
+            # Prevent hostages from being killed by bullets
+            if not mask & ContentFlags.HITBOX:
+                return
+            return other.classname != 'hostage_entity'
+    """
+
+    def __init__(self, callback):
+        """Registers the collision hook.
+
+        :param function callback:
+            Function to register as a collision hook callback.
+        """
+        self.callback = callback
+        collision_manager.register_hook(callback)
+
+    def _unload_instance(self):
+        """Unregisters the collision hook.
+
+        :param function callback:
+            Function to unregister as a collision hook callback.
+        """
+        collision_manager.unregister_hook(self.callback)

Diff for: addons/source-python/packages/source-python/entities/transmit.py

@@ -0,0 +1,90 @@
+# ../entities/transmit.py
+
+"""Provides entity transmission functionality."""
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Core
+from core import AutoUnload
+from core import WeakAutoUnload
+
+
+# =============================================================================
+# >> FORWARD IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Entities
+from _entities._transmit import BaseTransmitRules
+from _entities._transmit import TransmitHash
+from _entities._transmit import TransmitManager
+from _entities._transmit import TransmitMap
+from _entities._transmit import TransmitMode
+from _entities._transmit import TransmitSet
+from _entities._transmit import TransmitStates
+from _entities._transmit import transmit_manager
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = ('BaseTransmitRules',
+           'TransmitHash',
+           'TransmitHook',
+           'TransmitManager',
+           'TransmitMap',
+           'TransmitMode',
+           'TransmitSet',
+           'TransmitStates',
+           'transmit_manager',
+           )
+
+
+# =============================================================================
+# >> INITIALIZATION
+# =============================================================================
+# Inject WeakAutoUnload into BaseTransmitRules's hierarchy.
+if not issubclass(BaseTransmitRules, WeakAutoUnload):
+    BaseTransmitRules.__bases__ = (
+        WeakAutoUnload,) + BaseTransmitRules.__bases__
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class TransmitHook(AutoUnload):
+    """Decorator used to create transmit hooks that auto unload.
+
+    Example:
+
+    .. code:: python
+
+        from entities.transmit import TransmitHook
+
+        @TransmitHook
+        def transmit_hook(player, indexes, states):
+            # Don't transmit anything to this player except himself
+            player_index = player.index
+            for index in indexes:
+                if index == player_index:
+                    continue
+                states[index] = False
+    """
+
+    def __init__(self, callback):
+        """Registers the transmit hook.
+
+        :param function callback:
+            Function to register as a transmit hook callback.
+        """
+        self.callback = callback
+        transmit_manager.register_hook(callback)
+
+    def _unload_instance(self):
+        """Unregisters the transmit hook.
+
+        :param function callback:
+            Function to unregister as a transmit hook callback.
+        """
+        transmit_manager.unregister_hook(self.callback)