setPedChoking | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setPedChoking

Client-side
Server-side
Shared

Pair: isPedChoking

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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.

OOP Syntax Help! I don't understand this!

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

Syntax 

bool setPedChoking ( ped thePed, bool 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

  • bool: value

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

Code Examples

shared

This script will make all players choke on resource start

-- Choke all the players when the resource starts


function onResourceStart()
    setPedChoking(root, true)
end
addEventHandler("onResourceStart", resourceRoot, onResourceStart)


-- Unchoke all the players when the resource stops


function onResourceStop()
    setPedChoking(root, false)
end
addEventHandler("onResourceStop", resourceRoot, onResourceStop)


-- Choke players spawning


function onPlayerSpawn()
    setPedChoking(source, true)
end
addEventHandler("onPlayerSpawn", root, onPlayerSpawn)

See Also

Ped Functions
Ped Events
Reference