GetPlayerLivesLeft: Difference between revisions

VisualWikitext

Revision as of 18:27, 2 July 2022

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

int GetPlayerLivesLeft (int player)

Usage

Parameters

player: player to query the lives of.

Return value

Returns the number of lives the player has left. Lives are only reduced upon respawning; a value of 2 indicates the player has 3 lives, and a value of 0 indicates the player is on their last life.

To check whether a player is dead or not, use PlayerIsSpectator.

Examples

This article lists no examples, please add one.

@@ Line 1: / Line 1: @@
-{{ACSWarning}}{{Stub}}
+{{ACSWarning}}
+int '''GetPlayerLivesLeft''' (int ''player'')
-int '''GetPlayerLivesLeft''' (int ''player'')
+== Usage ==
+=== Parameters ===
+*''player'': player to query the lives of.
-*''player'': player to query lives left of.
+=== Return value ===
+Returns the number of lives the player has left. Lives are only reduced upon respawning; a value of 2 indicates the player has 3 lives, and a value of 0 indicates the player is on their last life.
-Returns the amount the player has left. Lives are only reduced on respawning, an amount of 2 here indicates the player has 3 lives. An amount of 0 indicates last life.
+To check whether a player is dead or not, use [[PlayerIsSpectator]].
-To check whether a player is dead or not, [[PlayerIsSpectator]] should be used.
+== Examples ==
+{{noexamples}}
 [[Category: ACS Functions]]