Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/WriteIniString

2016-06-22T05:38:00Z

King: Created page with "__NOTOC__ This function writes a string value to an .ini file. If the file does not exist, the function will create it. == Syntax == <code>bool WriteIniString( string filena..."

__NOTOC__
This function writes a string value to an .ini file. If the file does not exist, the function will create it.

== Syntax ==

<code>bool WriteIniString( string filename, string section, string var, string value )</code>

== Arguments ==

* '''filename''' This is the name of the file
* '''section''' The section that contains the value you want to create/edit
* '''var''' The name of the variable
* '''value''' The string value

== Example ==
This example will save player's IP to file 'IPs.ini' when they join.

<code lang="squirrel">
function onPlayerJoin( player )
{
WriteIniString( "IPs.ini", "IP", player.Name, player.IP );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Name|Player.Name]], [[Scripting/Squirrel/Functions/Players.IP|Player.IP]] and call [[OnPlayerJoin]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/WriteIniNumber

2016-06-22T05:36:24Z

King: Created page with "__NOTOC__ This function writes an integer value to an .ini file. If the file does not exist, the function will create it. == Syntax == <code>bool WriteIniInteger( string fil..."

__NOTOC__
This function writes an integer value to an .ini file. If the file does not exist, the function will create it.

== Syntax ==

<code>bool WriteIniInteger( string filename, string section, string var, int value )</code>

== Arguments ==

* '''filename''' This is the name of the file
* '''section''' The section that contains the value you want to create/edit
* '''var''' The name of the variable
* '''value''' The integer value for the variable

== Example ==
This example will save player's cash to a file 'PlayerCash.ini' when they leave the game.

<code lang="squirrel">
function onPlayerPart( player, reason )
{
WriteIniInteger( "PlayerCash.ini", "Cash", player.Name, player.Cash );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/Player.Cash|player.Cash]] and call [[OnPlayerPart]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/WriteIniInteger

2016-06-22T05:28:24Z

Scripting/Squirrel/Functions/WriteIniBool

2016-06-22T05:21:28Z

King: Created page with "__NOTOC__ This function writes a boolean value to an .ini file. If the file does not exist, the function will create it. == Syntax == <code>bool WriteIniBool( string filenam..."

__NOTOC__
This function writes a boolean value to an .ini file. If the file does not exist, the function will create it.

== Syntax ==

<code>bool WriteIniBool( string filename, string section, string var, bool value )</code>

== Arguments ==

* '''filename''' This is the name of the file
* '''section''' The section that contains the value you want to create/edit
* '''var''' The name of the variable
* '''value''' The boolean true/false

== Example ==
This example will freeze a player and store the control state to an ini file when they type '/c freezeme'.

<code lang="squirrel">
function onPlayerCommand( player, command, text )
{
if ( command = "freezeme" )
{
player.IsFrozen = true;
WriteIniBool( "Players.ini", "Frozen", player.Name, true );

MessagePlayer( "Buhaha! You can't move anymore!", player );
}
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.IsFrozen|player.IsFrozen]], [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and call [[OnPlayerCommand]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/RemoveIniValue

2016-06-22T05:20:01Z

King: Created page with "__NOTOC__ This function deletes a selected value from an ini file. == Syntax == <code>RemoveIniValue( string FileName, string Section, string Value )</code> == Arguments ==..."

__NOTOC__
This function deletes a selected value from an ini file.

== Syntax ==

<code>RemoveIniValue( string FileName, string Section, string Value )</code>

== Arguments ==

* '''FileName''' - This is the file name
* '''Section''' - The section name. Use without "[" and "]"
* '''Value''' - What do you want delete

== Example ==

To see how this works, let's create (again) a sample ini file 'numbers.ini'. You can copy and paste this:
<code>
[no idea for name]
1 = 1
2 = fgh
[spam]
2 = 1
asd = 69
[end]
end = yeah
</code>

Now we want to delete the line where is '2 = 1'. Let's do this, when the server starts.

<code lang="squirrel">
function onServerStart()
{
RemoveIniValue( "numbers.ini", "spam", "2" );
}
</code>

After this check the ini file. It should look like this:
<code>
[no idea for name]
1 = 1
2 = fgh
[spam]
asd = 69
[end]
end = yeah
</code>

=== Notes ===

The call [[OnServerStart]] was used in in this example. More info about this in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniString

2016-06-22T05:18:52Z

King: Created page with "__NOTOC__ This function reads a string saved to an .ini file. == Syntax == <code>string ReadIniString( string filename, string section, string var )</code> == Arguments ==..."

__NOTOC__
This function reads a string saved to an .ini file.

== Syntax ==

<code>string ReadIniString( string filename, string section, string var )</code>

== 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 check whether the player connects from the same IP than earlier and auto-logs them in.

<code lang="squirrel">
function onPlayerJoin( player )
{
if ( ReadIniString( "IPs.ini", "IP", player.Name ) == player.IP )
{
/* some nice autologin stuff here */
MessagePlayer( "You have auto-logged in successfully!", player );
}
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.IP|player.IP]], [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and call [[OnPlayerJoin]] were also used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniNumber

2016-06-22T05:17:23Z

King:

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

== Syntax ==

<code>float ReadIniNumber( string filename, string section, string var )</code>

== 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 '/c gotoloc LocationName'.

<code lang ="squirrel">
function onPlayerCommand( player, command, text )
{
local x = ReadIniNumber( "Locations.ini", text, "x" ),
y = ReadIniNumber( "Locations.ini", text, "y" ),
z = ReadIniNumber( "Locations.ini", text, "z" );
if ( x )
{
local pos = Vector( x, y, z );
player.Pos = pos;
MessagePlayer( "Teleporting to " + text + "...", player );
}
else MessagePlayer( "Location " + text + " not found.", player );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Pos|player.Pos]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and call [[OnPlayerCommand]] were also used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniNumber

2016-06-22T05:16:27Z

King:

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

== Syntax ==

<code>float ReadIniNumber( string filename, string section, string var )</code>

== 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 '/c gotoloc LocationName'.

<code>
function onPlayerCommand( player, command, text )
{
local x = ReadIniNumber( "Locations.ini", text, "x" ),
y = ReadIniNumber( "Locations.ini", text, "y" ),
z = ReadIniNumber( "Locations.ini", text, "z" );

if ( x )
{
local pos = Vector( x, y, z );
player.Pos = pos;

MessagePlayer( "Teleporting to " + text + "...", player );
}

else MessagePlayer( "Location " + text + " not found.", player );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Pos|player.Pos]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and call [[OnPlayerCommand]] were also used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniNumber

2016-06-22T05:15:35Z

King: Created page with "__NOTOC__ This function reads a float value from an .ini file. == Syntax == <code>float ReadIniNumber( string filename, string section, string var )</code> == Arguments ==..."

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

== Syntax ==

<code>float ReadIniNumber( string filename, string section, string var )</code>

== 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 '/c gotoloc LocationName'.

<code lang="squirrel">
function onPlayerCommand( player, command, text )
{
local x = ReadIniNumber( "Locations.ini", text, "x" ),
y = ReadIniNumber( "Locations.ini", text, "y" ),
z = ReadIniNumber( "Locations.ini", text, "z" );

if ( x )
{
local pos = Vector( x, y, z );
player.Pos = pos;

MessagePlayer( "Teleporting to " + text + "...", player );
}

else MessagePlayer( "Location " + text + " not found.", player );
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Pos|player.Pos]], [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and call [[OnPlayerCommand]] were also used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniInteger

2016-06-22T05:13:51Z

King: Created page with "__NOTOC__ This function reads an integer value from an .ini file. == Syntax == <code>int ReadIniInteger( string filename, string section, string var )</code> == Arguments =..."

__NOTOC__
This function reads an integer value from an .ini file.

== Syntax ==

<code>int ReadIniInteger( string filename, string section, string var )</code>

== 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 restore the cash amount player had on a previous visit.

<code lang="squirrel">
function onPlayerJoin( player )
{
local cash = ReadIniInteger( "PlayerCash.ini", "Cash", player.Name );

if ( cash )
{
player.Cash = cash;
}
}
</code>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Player.Name|player.Name]], [[Scripting/Squirrel/Functions/Player.Cash|player.Cash]] and call [[OnPlayerJoin]] were also used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniBool

2016-06-22T05:06:58Z

King:

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

== Syntax ==

<code>bool ReadIniBool( string filename, string section, string var )</code>

== 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.

<code lang="squirrel">
function onPlayerJoin( player )
{
if ( ReadIniBool( "Players.ini", "Frozen", player.Name ) )
{
player.IsFrozen = true;
MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
}
}
</code>

=== Notes ===

The functions [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/player.Name| player.Name ]], [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/player.IsFrozen| player.IsFrozen]], [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/MessagePlayer| MessagePlayer]] and call [[OnPlayerJoin]] were also used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ReadIniBool

2016-06-22T04:59:25Z

King: Created page with "__NOTOC__ This function reads a boolean value from an .ini file. == Syntax == <code>bool ReadIniBool( string filename, string section, string var )</code> == Arguments ==..."

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

== Syntax ==

<code>bool ReadIniBool( string filename, string section, string var )</code>

== 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.

<code lang="squirrel">
function onPlayerJoin( player )
{
if ( ReadIniBool( "Players.ini", "Frozen", player.Name ) )
{
player.IsFrozen = true;
MessagePlayer( "Sorry, you have been frozen earlier! :)", player );
}
}
</code>

=== 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 ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/CountIniSection

2016-06-22T04:56:25Z

King:

__NOTOC__
This function says, how many values/lines are in a selected section in an ini file.

== Syntax ==

<code>CountIniSection( string FileName, string Section )</code>

== Arguments ==

* '''FileName''' - This is the file name
* '''Section''' - The section name. Use without "[" and "]"

== Example ==

To see how this works, let's create (oh yeah, again) a sample ini file 'hola.ini'. You can copy and paste this:
<code>
[Players]
1 = TheTammer
2 = TheSpaner
3 = TheHaxor
4 = TheCheatzor
[Nothing]
Nothing = true
</code>

We want to know how many values/lines are in the '[Players]' section. As you can see, there are 4 values in the section. But we want, that the script will tell us this.

<code lang="squirrel">
function onServerStart()
{
print( "There are " + CountIniSection( "hola.ini", "Players" ) + " players saved." );
}
</code>

== Notes ==
The call [[OnServerStart]] was used in in this example. More info about this in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/ClearIni

2016-06-22T04:55:04Z

King:

__NOTOC__
This function clears the content of a ini file. Note: the ini file won't be deleted.

== Syntax ==

<code>ClearIni( string FileName )</code>

== Arguments ==

* '''FileName''' - This is the file name

== Example ==

In this example we will clear the ini file 'somespam.ini' when the server will be closed/scripts unloaded from the server

<code lang="squirrel">
function onScriptUnload()
{
ClearIni( "somespam.ini" );
print( "INI file cleared" );
}
</code>

=== Notes ===

The call [[OnScriptUnload]] was used in in this example. More info about this in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/DeleteIniSection

2016-06-22T04:47:48Z

King: Created page with "__NOTOC__ This function deletes a selected section from a ini file. == Syntax == <code>DeleteIniSection( string FileName, string Section )</code> == Arguments == * '''File..."

__NOTOC__
This function deletes a selected section from a ini file.

== Syntax ==

<code>DeleteIniSection( string FileName, string Section )</code>

== Arguments ==

* '''FileName''' - This is the file name
* '''Section''' - The section name. Use without "[" and "]"

== Example ==

To see how this works, let's create a sample ini file 'hastalavista.ini'. You can copy and paste this:
<code>
[useful info]
A = aaa

b = BBB

[spam]
Nothing to see here = true
[players]
1 = nub

2 = nab

3 = noob

</code>

Now we want to delete the '[spam]' section. Let's do this, when the server starts.

<code lang="squirrel">
function onServerStart()
{
DeleteIniSection( "hastalavista.ini", "spam" );
}
</code>

After this check the ini file. It should look like this:
<code>
[useful info]

A = aaa

b = BBB

[players]

1 = nub

2 = nab

3 = noob
</code>

=== Notes ===

The call [[OnServerStart]] was used in in this example. More info about this in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Functions/INI Functions}}

Scripting/Squirrel/Functions/CountIniSection

2016-06-22T04:02:42Z

King: Created page with "__NOTOC__ This function says, how many values/lines are in a selected section in an ini file. == Syntax == <code>CountIniSection( string FileName, string Section )</code> =..."

Scripting/Squirrel/Functions/ClearIni

2016-06-22T03:58:23Z

King: Created page with "__NOTOC__ This function clears the content of a ini file. Note: the ini file won't be deleted. == Syntax == <code>ClearIni( string FileName )</code> == Arguments == * '''F..."

__NOTOC__
This function clears the content of a ini file. Note: the ini file won't be deleted.

== Syntax ==

<code>ClearIni( string FileName )</code>

== Arguments ==

* '''FileName''' - This is the file name

== Example ==

In this example we will clear the ini file 'somespam.ini' when the server will be closed/scripts unloaded from the server

<code lang="squirrel">
function onScriptUnload()
{
ClearIni( "somespam.ini" );
print( "INI file cleared" );
}
</code>

=== Notes ===

The call [[Scripting/Squirrel/Events/Misc/onScriptUnload|onScriptUnload]] was used in in this example. More info about this in the corresponding page.