From 2b6e8c5442282644548bcc2580ce380526ca934b Mon Sep 17 00:00:00 2001 From: uniboi Date: Mon, 21 Feb 2022 16:21:18 +0100 Subject: [PATCH] Apply review changes - GetPlayerArrayEx accepts "any", "pilot" and "titan" - compare function can't be of type void - GetPersistentSpawnLoadoutIndex playerClass accepts "pilot" "titan" --- docs/source/reference/respawn/player.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/reference/respawn/player.rst b/docs/source/reference/respawn/player.rst index 50917629..7e368e59 100644 --- a/docs/source/reference/respawn/player.rst +++ b/docs/source/reference/respawn/player.rst @@ -15,9 +15,9 @@ Functions for getting player, and methods of the player object .. cpp:function:: array GetPlayerArray() -.. cpp:function:: array GetPlayerArrayEx( string affected, int team, vector origin, float radius ) +.. cpp:function:: array GetPlayerArrayEx( string class, int team, vector origin, float radius ) - returns a list of every player in radius relative to origin. I only found ``"any"`` to work and assume the first parameter describes the affected types. + returns a list of every player of the specified class in radius relative to origin. The parameter ``class`` must be one of these strings: ``titan``, ``pilot`` or ``any``. .. cpp:function:: array GetPlayerArrayOfTeam( int team ) @@ -36,7 +36,7 @@ Functions for getting player, and methods of the player object .. code-block:: javascript - GetSortedPlayers(function(entity player1, entity player2) { + GetSortedPlayers(int function(entity player1, entity player2) { if(player1.GetPlayerGameStat(PGS_PING)>player2.GetPlayerGameStat(PGS_PING)) return 1 @@ -127,7 +127,7 @@ Functions for getting player, and methods of the player object .. cpp:function:: int GetPersistentSpawnLoadoutIndex( entity player, string playerClass ) - playerClasses: ``"pilot"`` ``"titan"`` (``"spectator"``) + playerClasses: ``"pilot"`` ``"titan"``. This returns null for every other string. .. cpp:function:: entity GetPetTitan()