Squirrel/Server/Functions/Ini/ReadIniFloat

Revision as of 01:06, 27 November 2009

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

Syntax

float ReadIniFloat( string filename, string section, string var )

Arguments

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

Example

This example will teleport the player to a previously saved location when they type '/gotoloc LocationName'.

 
function onPlayerCommand( player, command, text )
{
     local x = ReadIniFloat( "Locations.ini", text, "x" ),
           y = ReadIniFloat( "Locations.ini", text, "y" ),
           z = ReadIniFloat( "Locations.ini", text, "z" );
 
     if ( x && y && z )
     {
          local pos = Vector( x, y, z );
          player.Pos = pos;
 
          MessagePlayer( "Teleporting to " + text + "...", player );
     }
 
     else MessagePlayer( "Location " + text + " not found.", player );
}
 

Notes

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

Related Functions

These functions are provided by the official module lu_ini.

• ClearIni
• CountIniSection
• DeleteIniSection
• ReadIniBool
• ReadIniFloat
• ReadIniIndex
• ReadIniInteger
• ReadIniString
• RemoveIniValue
• WriteIniBool
• WriteIniFloat
• WriteIniInteger
• WriteIniString