Add comment to clarify the relationship between CDAPlayer and CDAGame…

…Movement
shmopaloppa · Mar 29, 2016 · 5b858c8 · 5b858c8
1 parent b28bc34
commit 5b858c8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/mp/src/game/shared/sdk/sdk_gamemovement.cpp b/mp/src/game/shared/sdk/sdk_gamemovement.cpp
@@ -127,6 +127,9 @@ class CSDKGameMovement : public CGameMovement
 	bool ResolveStanding( void );
 	void TracePlayerBBoxWithStep( const Vector &vStart, const Vector &vEnd, unsigned int fMask, int collisionGroup, trace_t &trace );
 public:
+	// A reference to the player whose movement is currently being considered.
+	// If additional per-player data is needed, put it into CSDKPlayer and refer to it via m_pSDKPlayer.
+	// Do not put it directly into CSDKGameMovement, because there isn't an instance of that per player.
 	CSDKPlayer *m_pSDKPlayer;
 
 #ifdef STUCK_DEBUG