View source for Squirrel/Client/Functions/Players/Frozen

This function allows you to freeze a player. You can also get the player's frozen state.

== Syntax == 

Returning the frozen state:
<code>bool LocalPlayer.Frozen</code>

Setting the frozen state:
<code>LocalPlayer.Frozen = bool frozen</code>

== Arguments ==

* '''frozen''' - A boolean representing if the player is frozen or not ( true for frozen, false for not frozen ).

== Example ==

This example command Freeze The player.

<code lang="squirrel">
player <- FindLocalPlayer();

function onClientCommand( cmd, text )
{
     if ( cmd == "Freeze" )
     {
       player.Frozen = true;
     }
     
     return 1;
}
</code>