GetPlayerStatus: Difference between revisions

From Zandronum Wiki
(Reword to link to Player statuses instead)
Tag: Source edit
m (typo)
Tag: Source edit
Line 25: Line 25:
|}
|}


IF the player index is invalid, this function returns 0.
If the player index is invalid, this function returns 0.


== Examples ==
== Examples ==

Revision as of 03:48, 28 January 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 the acs-getplayerstatus Mercurial topic.

Also see the following merge request: !13: ACS function: "GetPlayerStatus"

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.