Squirrel/Server/Functions/Players/Immune

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Player.Frozen}} This ''Player'' class member returns whether the player is immune or not. == Syntax == You can either return or set a new value using this memb…')
 
 
Line 1: Line 1:
−
{{Squirrel/Title|Player.Frozen}}
+
{{Squirrel/Title|Player.Immune}}
 
This ''Player'' class member returns whether the player is immune or not.
 
This ''Player'' class member returns whether the player is immune or not.
  

Latest revision as of 17:07, 4 October 2010

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Player class member returns whether the player is immune or not.

[edit] Syntax

You can either return or set a new value using this member: 

  1. bool Player.Immune
  1. Player.Immune = bool immune

[edit] Arguments

  • frozen - A boolean representing whether the player is immune (true) or not (false)

[edit] Example 1. Returning 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "immune" )
  5. 	{
  6. 		MessagePlayer( "Your immune state is currently set to " + pPlayer.Immune, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

[edit] Example 2. Setting 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "immune2" )
  5. 	{
  6. 		pPlayer.Immune = true;
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The event onPlayerCommand was used in this example. More info about this in the corresponding page.

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Players/Immune&oldid=1808"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox