This is the constructor for the config object, which can take an optional string parameter that points to the config file to be loaded.

The path to the config file can be a relative or absolute file or URL path. All Flash domain security restrictions apply.

Note that the constructor is placed in the _global scope and can thus be accessed from anywhere within the Flash movie.

This property is a boolean which indicates whether or not data has loaded into the config file. If loadConfig() or parse() are called, then it will be set to false, and then set to true if the config file is successfully parsed.

Note, that this property can be used with Object.watch().

c = new Config("config.ini");

if(!c.loaded)
{
	trace("The config file has not been loaded");
}

Method that allows you to set the path to the config file.

The path to the config file can be a relative or absolute file or URL path. All Flash domain security restrictions apply.

Returns a string of the path to the current config file.

If a config file has not been specified, then it returns null;

Method which takes a Boolean value that indicates whether
or not double quotes surrounding names and values should be removed.

Default is false.

For example, if you had the following config.ini file:

Here is with setStripQuotes called with true:

c = new Config("config.ini");

c.setStripQuotes(true);

c.onConfigLoad = function(success)
{
	trace(this.get("foo")); //traces jar jar
}

And with setStripQuotes passed false (or not called) :

c = new Config("config.ini");

c.setStripQuotes(false);

c.onConfigLoad = function(success)
{
	trace(this.get("foo")); //traces "jar jar"
}

The difference being that when setStripQuotes is set to true, the value does not contain the quotes.

Note : for performance consideration, you should only call setStripQuotes(true) if there is a possibility that your ini file with have quotes surrounding the data.

Method which takes a Boolean value that indicates whether or not values that contain commas should be exploded into an array of values.

If set to true, calling get() on the name will return an Array.

If set to false, calling get() on the name will return a string.

The default is false.

For example if you had the following config file:

fruit = "apple,lemons,cherries"

c = new Config("config.ini");

c.setExplodeValues(false);

c.onConfigLoad = function(success)
{
	var t = this.get("fruits");
	trace("Value is String : " + (typeof(t) == "string")); //returns true
	trace("Value is Array : " + (t instanceof Array)); //returns false
}

And with pass true to setExplodeValues :

c = new Config("config.ini");

c.setExplodeValues(true);

c.onConfigLoad = function(success)
{
	var t = this.get("fruits");
	trace("Value is String : " + (typeof(t) == "string")); //returns false
	trace("Value is Array : " + (t instanceof Array)); //returns true
}

This is a convenience method that allows you to pass a string representing a config file to be parsed.

It returns true if the parsing succeed, and false if it did not.

Note, since the method returns immediately, you may access
the data in the object immediately after it has returned true.

For example:

var c = new Config();

var s = "foo=bar\n";

if(c.parse(s))
{
	trace(c.get("foo")); //traces "bar"
}

If the config object has already parsed data, then the new data will be added
to the config object, overwriting any duplicate values that already exist.

Takes a string and returns the value for that name in the config file.

For example if you had the following config file:

config.ini
foo=bar
name=mike

c = new Config("config.ini");

c.onConfigLoad = function(success)
{
	trace(c.get("foo")); //traces "bar"
	trace(c.get("name")); //traces "mike"
}

Returns an associative array containing the name value pairs contained within the object.

This method loads the config file specified in the constructor or setConfigFile() method, and then parses it.

Once it has been parsed, the onConfigLoad() method will be
called and passed a Boolean value indicating whether the
file was able to be parsed.

The onConfigLoad method should be over ridden in order to
allow the developer to know when the data has loaded and been parsed.

#include "Config.as"

config = new Config("config.ini");
config.onConfigLoad = function(success)
{
	trace("Accessing data from onConfigLoad : ClassGuid = " + this.get("ClassGuid"));
}
config.loadConfig();