ConsolePlayerNumber: Difference between revisions

no edit summary
No edit summary
No edit summary
Tag: Source edit
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
int '''ConsolePlayerNumber''' (void)
int '''ConsolePlayerNumber''' (void)


==Usage==
== Usage ==
 
=== Return value ===
Returns the number of the local player. Returns -1 if called on the server. This function is only really meaningful in client-side scripting.
Returns the number of the local player. Returns -1 if called on the server. This function is only really meaningful in client-side scripting.


Note that in a DISCONNECT script, ConsolePlayerNumber() will return the last player number the local player had, even though PlayerNumber() no longer works.
Note that in a DISCONNECT script, ConsolePlayerNumber() will return the last player number the local player had, even though PlayerNumber() no longer works.


==Examples==
== Examples ==
This script tells the player what his player number is:
This script tells the player what their player number is:
 
<syntaxhighlight lang="c" line="1">
<syntaxhighlight lang="c" line="1">
Script 1 (void) NET CLIENTSIDE
Script 1 (void) NET CLIENTSIDE
Line 17: Line 18:
</syntaxhighlight>
</syntaxhighlight>


[[Category:ACS Functions]]
[[Category:ACS functions]]