Added OnPlayerCollision.

Author: jordanbriere

addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst

@@ -327,7 +327,7 @@ Called when a networked entity has been spawned.
 OnEntityCollision
 -----------------
 
-Called when an entity is about to collide with another.
+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` if you don't have dynamic conditions to test for.
 
@@ -337,8 +337,8 @@ Called when an entity is about to collide with another.
 
     @OnEntityCollision
     def on_entity_collision(entity, other):
-        # Disable teammates collisions
-        return entity.team_index != other.team_index
+        # Disable weapons/projectiles collisions with everything except players
+        return not (entity.is_weapon() and not other.is_player())
 
 
 OnLevelInit
@@ -423,6 +423,25 @@ 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` 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
+
+
 OnPlayerRunCommand
 --------------------
 

addons/source-python/packages/source-python/listeners/__init__.py

@@ -73,6 +73,7 @@
 from _listeners import on_server_activate_listener_manager
 from _listeners import on_tick_listener_manager
 from _listeners import on_server_output_listener_manager
+from _listeners import on_player_collision_listener_manager
 from _listeners import on_player_run_command_listener_manager
 from _listeners import on_button_state_changed_listener_manager
 
@@ -111,6 +112,7 @@
            'OnLevelEnd',
            'OnNetworkidValidated',
            'OnButtonStateChanged',
+           'OnPlayerCollision',
            'OnPlayerRunCommand',
            'OnPluginLoaded',
            'OnPluginLoading',
@@ -157,6 +159,7 @@
            'on_tick_listener_manager',
            'on_version_update_listener_manager',
            'on_server_output_listener_manager',
+           'on_player_collision_listener_manager',
            'on_player_run_command_listener_manager',
            'on_button_state_changed_listener_manager',
            )
@@ -498,6 +501,12 @@ class OnLevelEnd(ListenerManagerDecorator):
     _level_initialized = False
 
 
+class OnPlayerCollision(ListenerManagerDecorator):
+    """Register/unregister a OnPlayerCollision listener."""
+
+    manager = on_player_collision_listener_manager
+
+
 class OnPlayerRunCommand(ListenerManagerDecorator):
     """Register/unregister a run command listener."""
 

src/core/modules/entities/entities_collisions.cpp

@@ -301,6 +301,7 @@ bool CCollisionManager::EnterScope(HookType_t eHookType, CHook *pHook)
 	scope.m_nMask = nMask;
 	scope.m_bSolidContents = bSolidContents;
 	scope.m_uiIndex = uiIndex;
+	scope.m_bIsPlayer = ((CBaseEntityWrapper *)pWrapper->m_pPassEnt)->IsPlayer();
 	scope.m_pCache = pManager->GetCache(uiIndex);
 	scope.m_pExtraShouldHitCheckFunction = pWrapper->m_pExtraShouldHitCheckFunction;
 	pWrapper->m_pExtraShouldHitCheckFunction = (ShouldHitFunc_t)CCollisionManager::ShouldHitEntity;
@@ -400,8 +401,31 @@ bool CCollisionManager::ShouldHitEntity(IHandleEntity *pHandleEntity, int conten
 		}
 	}
 
-	static CEntityCollisionListenerManager *pListener = GetOnEntityCollisionListenerManager();
-	if (!pListener->GetCount()) {
+	if (scope.m_bIsPlayer) {
+		static CPlayerCollisionListenerManager *OnPlayerCollision = GetOnPlayerCollisionListenerManager();
+		if (!OnPlayerCollision->GetCount()) {
+			scope.m_pCache->SetResult(uiIndex, true);
+			return true;
+		}
+
+		static object Player = import("players.entity").attr("Player");
+		object oPlayer = Player(scope.m_uiIndex);
+
+		if (oOther.is_none()) {
+			oOther = Entity(uiIndex);
+		}
+
+		if (!OnPlayerCollision->CallCallbacks(oPlayer, oOther)) {
+			scope.m_pCache->SetResult(uiIndex, false);
+			return false;
+		}
+
+		scope.m_pCache->SetResult(uiIndex, true);
+		return true;
+	}
+
+	static CEntityCollisionListenerManager *OnEntityCollision = GetOnEntityCollisionListenerManager();
+	if (!OnEntityCollision->GetCount()) {
 		scope.m_pCache->SetResult(uiIndex, true);
 		return true;
 	}
@@ -414,14 +438,9 @@ bool CCollisionManager::ShouldHitEntity(IHandleEntity *pHandleEntity, int conten
 		oOther = Entity(uiIndex);
 	}
 
-	FOR_EACH_VEC(pListener->m_vecCallables, i) {
-		BEGIN_BOOST_PY()
-			object oResult = pListener->m_vecCallables[i](oEntity, oOther);
-			if (!oResult.is_none() && !extract<bool>(oResult)) {
-				scope.m_pCache->SetResult(uiIndex, false);
-				return false;
-			}
-		END_BOOST_PY_NORET()
+	if (!OnEntityCollision->CallCallbacks(oEntity, oOther)) {
+		scope.m_pCache->SetResult(uiIndex, false);
+		return false;
 	}
 
 	scope.m_pCache->SetResult(uiIndex, true);
@@ -579,15 +598,15 @@ list CCollisionHash::GetPairs(void *pEntity)
 
 
 //-----------------------------------------------------------------------------
-// CEntityCollisionListenerManager class.
+// CCollisionListenerManager class.
 //-----------------------------------------------------------------------------
-CEntityCollisionListenerManager::CEntityCollisionListenerManager():
+CCollisionListenerManager::CCollisionListenerManager():
 	m_bInitialized(false)
 {
 
 }
 
-void CEntityCollisionListenerManager::Initialize()
+void CCollisionListenerManager::Initialize()
 {
 	if (m_bInitialized) {
 		return;
@@ -597,7 +616,7 @@ void CEntityCollisionListenerManager::Initialize()
 	m_bInitialized = true;
 }
 
-void CEntityCollisionListenerManager::Finalize()
+void CCollisionListenerManager::Finalize()
 {
 	if (!m_bInitialized) {
 		return;
@@ -607,9 +626,36 @@ void CEntityCollisionListenerManager::Finalize()
 	m_bInitialized = false;
 }
 
-// Singleton accessor.
+bool CCollisionListenerManager::CallCallbacks(object oEntity, object oOther)
+{
+	FOR_EACH_VEC(m_vecCallables, i) {
+		BEGIN_BOOST_PY()
+			object oResult = m_vecCallables[i](oEntity, oOther);
+			if (!oResult.is_none() && !extract<bool>(oResult)) {
+				return false;
+			}
+		END_BOOST_PY_NORET()
+	}
+
+	return true;
+}
+
+
+//-----------------------------------------------------------------------------
+// CEntityCollisionListenerManager singleton accessor.
+//-----------------------------------------------------------------------------
 static CEntityCollisionListenerManager s_OnEntityCollision;
 CEntityCollisionListenerManager *GetOnEntityCollisionListenerManager()
 {
 	return &s_OnEntityCollision;
 }
+
+
+//-----------------------------------------------------------------------------
+// CPlayerCollisionListenerManager singleton accessor.
+//-----------------------------------------------------------------------------
+static CPlayerCollisionListenerManager s_OnPlayerCollision;
+CPlayerCollisionListenerManager *GetOnPlayerCollisionListenerManager()
+{
+	return &s_OnPlayerCollision;
+}

src/core/modules/entities/entities_collisions.h

@@ -33,6 +33,7 @@
 // Source.Python
 #include "sp_main.h"
 #include "modules/listeners/listeners_manager.h"
+#include "modules/entities/entities_entity.h"
 #include "modules/physics/physics.h"
 #include "modules/memory/memory_hooks.h"
 
@@ -84,6 +85,7 @@ struct CollisionScope_t
 {
 	bool m_bSkip;
 	unsigned int m_uiIndex;
+	bool m_bIsPlayer;
 	CTraceFilterSimpleWrapper *m_pFilter;
 	ShouldHitFunc_t m_pExtraShouldHitCheckFunction;
 	CCollisionCache *m_pCache;
@@ -171,7 +173,7 @@ class CCollisionManager
 {
 public:
 	friend CCollisionManager *GetCollisionManager();
-	friend class CEntityCollisionListenerManager;
+	friend class CCollisionListenerManager;
 
 private:
 	CCollisionManager();
@@ -228,22 +230,45 @@ inline CCollisionManager *GetCollisionManager()
 
 
 //-----------------------------------------------------------------------------
-// CEntityCollisionListenerManager class.
+// CCollisionListenerManager class.
 //-----------------------------------------------------------------------------
-class CEntityCollisionListenerManager: public CListenerManager
+class CCollisionListenerManager : public CListenerManager
 {
 public:
-	CEntityCollisionListenerManager();
+	CCollisionListenerManager();
 
 	void Initialize();
 	void Finalize();
 
+	bool CallCallbacks(object oEntity, object oOther);
+
 private:
 	bool m_bInitialized;
 };
 
+
+//-----------------------------------------------------------------------------
+// CEntityCollisionListenerManager class.
+//-----------------------------------------------------------------------------
+class CEntityCollisionListenerManager: public CCollisionListenerManager
+{
+
+};
+
 // Singleton accessor.
 CEntityCollisionListenerManager *GetOnEntityCollisionListenerManager();
 
 
+//-----------------------------------------------------------------------------
+// CPlayerCollisionListenerManager class.
+//-----------------------------------------------------------------------------
+class CPlayerCollisionListenerManager: public CCollisionListenerManager
+{
+
+};
+
+// Singleton accessor.
+CPlayerCollisionListenerManager *GetOnPlayerCollisionListenerManager();
+
+
 #endif // _ENTITIES_COLLISIONS_H

src/core/modules/listeners/listeners_wrap.cpp

@@ -174,6 +174,7 @@ void export_listener_managers(scope _listeners)
 	_listeners.attr("on_entity_deleted_listener_manager") = object(ptr(GetOnEntityDeletedListenerManager()));
 	_listeners.attr("on_networked_entity_deleted_listener_manager") = object(ptr(GetOnNetworkedEntityDeletedListenerManager()));
 	_listeners.attr("on_entity_collision_listener_manager") = object(ptr((CListenerManager *)GetOnEntityCollisionListenerManager()));
+	_listeners.attr("on_player_collision_listener_manager") = object(ptr((CListenerManager *)GetOnPlayerCollisionListenerManager()));
 
 	_listeners.attr("on_data_loaded_listener_manager") = object(ptr(GetOnDataLoadedListenerManager()));
 	_listeners.attr("on_combiner_pre_cache_listener_manager") = object(ptr(GetOnCombinerPreCacheListenerManager()));