SetPedChoking: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Added OOP syntax)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function can be used to force the ped to do the choking animation (teargas etc...) until he respawns or toggled off using this function. The animation can not be cancelled by a player it's applied to, and he will not loose health.
This function can be used to force the ped to do the choking (coughing) animation until he respawns or toggled off using this function. The animation can not be cancelled by a player it's applied to, and he will not loose health.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPedChoking ( ped thePed, bool choking )
bool setPedChoking ( ped thePed, bool choking )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[ped]]:setChoking|choking}}


===Required Arguments===  
===Required Arguments===  

Revision as of 17:15, 26 November 2014

This function can be used to force the ped to do the choking (coughing) animation until he respawns or toggled off using this function. The animation can not be cancelled by a player it's applied to, and he will not loose health.

Syntax

bool setPedChoking ( ped thePed, bool choking )

OOP Syntax Help! I don't understand this!

Method: ped:setChoking(...)
Variable: .choking


Required Arguments

  • thePed: The ped whose choking status to toggle
  • choking: true to make the ped choke, false to no longer force his choking animation

Returns

Returns true if successful, false otherwise (e.g. player handle is invalid)

Example

This script will make all players choke on resource start 

-- Choke all the players when the resource starts
function ResourceStart ()
    setPedChoking ( root, true )
end
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource () ), ResourceStart, true )

-- Unchoke all the players when the resource stops
function ResourceStop ()
    setPedChoking ( root, false )
end
addEventHandler ( "onResourceStop", getResourceRootElement ( getThisResource () ), ResourceStop, true )

-- Choke players spawning
function PlayerSpawn ()
    setPedChoking ( source, true )
end
addEventHandler ( "onPlayerSpawn", root, PlayerSpawn )

See Also

Shared

Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedChoking?oldid=43052"