GetPlayerStatus: Difference between revisions
DrinkyBird (talk | contribs) (Documented GetPlayerStatus) Tag: Source edit |
DrinkyBird (talk | contribs) (Now in default) Tag: Source edit |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ACSWarning}}{{ | {{ACSWarning}} | ||
{{DevfeatureWarning|version=3.2|type=an [[ACS]] function}} | |||
int '''GetPlayerStatus''' (int ''player'') | int '''GetPlayerStatus''' (int ''player'') | ||
== Usage == | == Usage == | ||
Returns | Returns a [[Player statuses|player's status]], which is typically represented as an icon above their head. | ||
=== Parameters === | === Parameters === | ||
| Line 25: | Line 26: | ||
|} | |} | ||
If the player index is invalid, this function returns 0. | |||
== Examples == | == Examples == | ||
Latest revision as of 00:10, 15 March 2024
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
|
This article documents an ACS function which is only available in development builds of Zandronum 3.2 and newer. |
int GetPlayerStatus (int player)
Usage
Returns a player's status, which is typically represented as an icon above their head.
Parameters
- player: The player number to get the status of.
Return value
Returns an integer which can contain the following bits:
| Bit | Value | Name | Description |
|---|---|---|---|
| 1 | 1 | STATUS_CHATTING | The player is typing in text chat. |
| 2 | 2 | STATUS_TALKING | The player is speaking in voice chat. |
| 3 | 4 | STATUS_INCONSOLE | The player is using the console. |
| 4 | 8 | STATUS_INMENU | The player is in the menu. |
| 5 | 16 | STATUS_LAGGING | The player is lagging. |
If the player index is invalid, this function returns 0.
Examples
| This article lists no examples, please add one. |