Scripting/Squirrel/Functions/ReadIniBool

From Vice City Multiplayer
Revision as of 18:15, 30 January 2017 by Thijn (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

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", player.Name ) )
    {
         player.IsFrozen = true;
         MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
    }

}

Notes

The functions [player.Name ], [player.IsFrozen], [MessagePlayer] and call OnPlayerJoin were also used in in this example. More info about them in the corresponding pages.

Related Functions