IsPlayerChoking: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated}}
This function checks if the specified [[player]] is choking (coughing) or not.  This happens as a result of weapons that produce smoke - smoke grenades, fire extinguisher and the spray can.  
This function checks if the specified [[player]] is choking (coughing) or not.  This happens as a result of weapons that produce smoke - smoke grenades, fire extinguisher and the spray can.  



Revision as of 14:16, 20 January 2009

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.

This function checks if the specified player is choking (coughing) or not. This happens as a result of weapons that produce smoke - smoke grenades, fire extinguisher and the spray can.

Syntax

bool isPlayerChoking ( player thePlayer )

Required Arguments

  • thePlayer: The player you wish to check

Returns

Returns true if the player is choking, false otherwise.

Example

This example checks if a random player is choking or not, and if so displays a message in the chat box.

aPlayer = getRandomPlayer ( )
if ( isPlayerChoking ( aPlayer ) ) then
	outputChatBox ( getClientName ( aPlayer ) .. " is choking.  Keep away from those cigarettes!" )
end

See Also