ConsolePlayerNumber: Difference between revisions

From Zandronum Wiki
(Created page with "{{Template:ACSWarning}} int '''ConsolePlayerNumber''' (void) ==Usage== Returns the number of the local player. Returns -1 if called on the server. This function is only real...")
 
No edit summary
Line 10: Line 10:
==Examples==
==Examples==
This script tells the player what his player number is:
This script tells the player what his player number is:
script 1 (void) net clientside {
<syntaxhighlight lang="c" line="1">
  {{zdw|PrintBold}}(s:"My player number is ", d:[[ConsolePlayerNumber]]());
Script 1 (void) NET CLIENTSIDE
}
{
    PrintBold(s: "My player number is ", d: ConsolePlayerNumber());
}
</syntaxhighlight>


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

Revision as of 16:09, 21 August 2016

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.

int ConsolePlayerNumber (void)

Usage

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 his player number is:

Script 1 (void) NET CLIENTSIDE
{
    PrintBold(s: "My player number is ", d: ConsolePlayerNumber());
}