SetPedFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:
*'''thePed:''' The [[ped]] whose frozen state will be changed.
*'''thePed:''' The [[ped]] whose frozen state will be changed.
*'''frozen:''' A [[bool]] value as to whether the ped is frozen or not.
*'''frozen:''' A [[bool]] value as to whether the ped is frozen or not.
===Returns===
Returns ''true'' if the frozen state was set successfully, or ''false'' if invalid arguments were passed.


==Example==  
==Example==  

Revision as of 20:57, 14 July 2009

This function freezes (or un-freezes) a pedestrian, meaning they cannot move, jump, aim, shoot, etcetera.

Syntax

bool setPedFrozen ( ped thePed, bool frozen )

Required Arguments

  • thePed: The ped whose frozen state will be changed.
  • frozen: A bool value as to whether the ped is frozen or not.

Returns

Returns true if the frozen state was set successfully, or false if invalid arguments were passed.

Example

This example adds a 'togglefreeze' console command that lets players alternate their frozen state. 

function toggleFreeze ( sourcePlayer, command )
    local frozen = getPedFrozen ( sourcePlayer )
    setPedFrozen ( sourcePlayer, not frozen )
end
addCommandHandler ( "togglefreeze", toggleFreeze )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedFrozen?oldid=20615"