Difference between revisions of "Gkini"

Revision as of 12:11, 5 May 2008

These are functions to manipulate the games config file config.ini.

The format of the file looks like this:

[section]
key=value
.
.

value can either be a string or an integer all identifiers are case sensitive

Functions

ReadInt

Definition:
ReadInt(string section, string key, int default) -> int value

Description:
Read an integer from the given section and key

Arguments:
section a section of the config file
key key within a section
default value to return if key not found

Returns:

Example:

gkini.ReadInt("Vendetta", "showhelpstring", 1) -> 0 -- showhelpstring is ccurrently set to 0

ReadString

Definition:
ReadString(string section, string key, string default) -> string value

Description:
Read a string from the given section and key

Arguments:
section a section of the config file
key key within a section
default value to return if key not found

Returns:

Example:

gkini.ReadString("Vendetta", "Username", "dude") -> "hans" -- get the default username from the config file

WriteInt

Definition:
WriteInt(string section, string key, int value) -> nil

Description:
Write an integer to the given section and key

Arguments:
section a section of the config file
key key within a section
value value of a key as an integer

Returns:

Example:

gkini.WriteInt("Vendetta", "showhelpstring", 1) -- change the showhelpstring option to 1

WriteString

Definition:
WriteString(string section, string key, string value) -> nil

Description:
Write a string to the given section and key. String length is limited to 763 characters.

Arguments:
section a section of the config file
key key within a section
value value of a key as a string

Returns:

Example:

gkini.WriteString("Vendetta", "Username", "dude") -- change the Username option to dude