IsPlayerDead: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated|isPedDead|}}
This function checks if the specified [[player]] is dead or not.
This function checks if the specified [[player]] is dead or not.


Line 13: Line 15:


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

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