IsPlayerDead: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns a boolean value (true or false) depending on whether the specified [[player]] is dead or not.
{{Deprecated|isPedDead|}}
 
This function checks if the specified [[player]] is dead or not.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool IsPlayerDead ( player player )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isPlayerDead ( player thePlayer )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
* '''player''': A [[player]] object referencing the specified player
* '''thePlayer''': A [[player]] object referencing the specified player
 
===Returns===
Returns ''true'' if the player is dead, ''false'' otherwise.


==Example==
==Example==
<syntaxhighlight lang="lua">player = GetRandomPlayer ( )
<section name="Server" class="server" show="true">
if ( IsPlayerDead ( player ) )
This example allows a player to use the command 'amidead' to see if they are dead or not.
  outputChatBox ( GetPlayerName ( player ) , " has bitten the dust." )
<syntaxhighlight lang="lua">
end</syntaxhighlight>
--Check if player is alive or dead and let them know in the chat box
function deathCheck ( thePlayer, commandName )
    if ( isPlayerDead ( thePlayer ) ) then
        outputChatBox ( "You're dead... prepare to become a zombie.", thePlayer )
    else
        outputChatBox ( "Count your lucky stars, you're alive.", thePlayer )
    end
end
addCommandHandler ( "amidead", deathCheck )
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Latest revision as of 16:14, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use isPedDead instead.


This function checks if the specified player is dead or not.

Syntax

bool isPlayerDead ( player thePlayer )

Required Arguments

  • thePlayer: A player object referencing the specified player

Returns

Returns true if the player is dead, false otherwise.

Example

Click to collapse [-]
Server

This example allows a player to use the command 'amidead' to see if they are dead or not. 

--Check if player is alive or dead and let them know in the chat box
function deathCheck ( thePlayer, commandName )
    if ( isPlayerDead ( thePlayer ) ) then
         outputChatBox ( "You're dead... prepare to become a zombie.", thePlayer )
    else
         outputChatBox ( "Count your lucky stars, you're alive.", thePlayer )
    end
end
addCommandHandler ( "amidead", deathCheck )

See Also

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerDead?oldid=44559"