Documentation

Represents an open configuration file.

Opens a config file and returns an opaque reference to the file. You must close this reference using close when you're done reading the file.

Closes a configuration file.

Returns a boolean value from a configuration file. Returns False if the value is not defined in the file. Example:

someVal = true

Returns a string value from a configuration file. Returns the empty string if the value is not defined in the file. Example:

someVal = "foo"

Returns an integer value from a configuration file. Example:

someVal = 2

Returns a double value from a configuration file. Example:

someVal = 3.1415926

Returns a list of strings (i.e. a Lua table in which the keys are integers and the values are strings) from a configuration file. Example:

someVal = { "foo", "bar", "baz" }

Returns a list of lists, i.e. a Lua table of tables. In the outer table, the keys are integers and the values are tables, and in the inner tables, the keys are integers and the values are strings. Example:

someVal = {
   { "foo one", "foo two", "foo three" },
   { "bar one", "bar two", "bar three" }
}

Returns an association list, i.e. a Lua table in which the keys and values are strings. Example:

someVal = {
   one = "foo",
   two = "bar",
   three = "baz"
}

Returns a list of association lists, i.e. a Lua table of tables. In the outer table, the keys are integers and the values are tables, and in the inner tables, the keys and values are strings. Example:

someVal = {
   {
      foo = "aaa",
      bar = "bbb",
      baz = "ccc"
   },
   {
      foo = "ddd",
      bar = "eee",
      baz = "fff"
   }
}

Returns an association list of association lists, i.e. a Lua table of tables. In the outer table, the keys are strings and the values are tables, and in the inner tables, the keys and values are strings. Example:

someVal = {
   something = {
      foo = "aaa",
      bar = "bbb",
      baz = "ccc"
   },
   somethingElse = {
      foo = "ddd",
      bar = "eee",
      baz = "fff"
   }
}

Thrown when an error occurs in reading a configuration file.