Difference between revisions of "IsPedFrozen"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{Server client function}}
 
{{Server client function}}
 +
{{Deprecated}}
 +
 +
Please use [[isElementFrozen]]
 +
 
This function retrieves whether the pedestrian is frozen or not.
 
This function retrieves whether the pedestrian is frozen or not.
  

Revision as of 18:13, 2 October 2011

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.


Please use isElementFrozen

This function retrieves whether the pedestrian is frozen or not.

Syntax

bool isPedFrozen ( ped thePed )

Required Arguments

  • thePed: The ped whose frozen state will be obtained.

Returns

Returns a bool indicating the pedestrians frozen state, 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 )
    setPedFrozen ( sourcePlayer, not isPedFrozen ( sourcePlayer ) )
end
addCommandHandler ( "togglefreeze", toggleFreeze )

See Also