ConsolePlayerNumber: Difference between revisions
DrinkyBird (talk | contribs) mNo edit summary Tag: Source edit |
DrinkyBird (talk | contribs) No edit summary Tag: Source edit |
||
| 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 | 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 | ||
Latest revision as of 02:24, 3 July 2022
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
int ConsolePlayerNumber (void)
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.
Note that in a DISCONNECT script, ConsolePlayerNumber() will return the last player number the local player had, even though PlayerNumber() no longer works.
Examples
This script tells the player what their player number is:
Script 1 (void) NET CLIENTSIDE
{
PrintBold(s: "My player number is ", d: ConsolePlayerNumber());
}