IsPlayerDead: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Check if a player is dead.}}


{{FuncSyntax|IsPlayerDead(player)}}
{{FuncSyntax|IsPlayerDead(player)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
AddCommand("acceptdeath", function(playerid)
    if not IsPlayerDead(player) then
        return AddPlayerChat(playerid, "You are not dead.")
    end
 
    AddPlayerChat(playerid, "You have accepted death and will respawn shortly.")
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ServerPlayerFunctions}}

Latest revision as of 14:50, 26 June 2021

IsPlayerDead

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Check if a player is dead.

Syntax

IsPlayerDead(player)

Parameters

  • player
    The player identifier.

Return Value

  • Returns true on success.

Example

AddCommand("acceptdeath", function(playerid)
    if not IsPlayerDead(player) then
        return AddPlayerChat(playerid, "You are not dead.")
    end

    AddPlayerChat(playerid, "You have accepted death and will respawn shortly.")
end)

See also

Retrieved from "https://dev.playonset.com/index.php?title=IsPlayerDead&oldid=4858"