Squirrel/Server/Functions/Ini/ReadIniBool

Revision as of 15:19, 4 March 2009

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

Syntax

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

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

Example

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

 
function OnPlayerJoin( player )
{
     if ( ReadIniBool( "Players.ini", "Frozen", GetPlayerName( player ) ) )
     {
          SetPlayerFrozen( player, true );
          MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
     }
}
 

Notes

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

Related Functions

Template:Squirrel/Functions/Ini