Squirrel/Server/Functions/Ini/ReadIniBool

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
 
Line 21: Line 21:
 
     if ( ReadIniBool( "Players.ini", "Frozen", player.Name ) )
 
     if ( ReadIniBool( "Players.ini", "Frozen", player.Name ) )
 
     {
 
     {
           player.IsFrozen = true;
+
           player.Frozen = true;
 
           MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
 
           MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
 
     }
 
     }
Line 29: Line 29:
 
=== Notes ===
 
=== Notes ===
  
The functions [[Squirrel/Server/Functions/Players/IsFrozen|Player.IsFrozen]], [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and call [[Squirrel/Server/Events/Player/onPlayerJoin|onPlayerJoin]] were also used in in this example. More info about them in the corresponding pages.
+
The functions [[Squirrel/Server/Functions/Players/Frozen|Player.Frozen]], [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and call [[Squirrel/Server/Events/Player/onPlayerJoin|onPlayerJoin]] were also used in in this example. More info about them in the corresponding pages.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Ini}}
 
{{Squirrel/Server/Functions/Ini}}

Latest revision as of 19:29, 19 December 2012

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events
Note: This function requires the external module lu_ini.

This function reads a boolean value from an .ini file.

[edit] Syntax

  1. bool ReadIniBool( string filename, string section, string var )

[edit] Arguments

  • filename This is the name of the file
  • section The section that contains the value you want read
  • var The name of the variable

[edit] Example

This example will check whether the player has been frozen earlier and if so, freezes them on join.

  1.  
  2. function onPlayerJoin( player )
  3. {
  4. if ( ReadIniBool( "Players.ini", "Frozen", player.Name ) )
  5. {
  6. player.Frozen = true;
  7. MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
  8. }
  9. }
  10.  

[edit] Notes

The functions Player.Frozen, MessagePlayer and call onPlayerJoin were also used in in this example. More info about them in the corresponding pages.

[edit] Related Functions

These functions are provided by the official module lu_ini.

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox