cubex2.cs2.scripting

Class ScriptableConfig

java.lang.Object

cubex2.cs2.scripting.ScriptableConfig

public class ScriptableConfig
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptableConfig(cubex2.cs2.Mod mod)

Method Summary

Modifier and Type	Method and Description
void	addBooleanProperty(java.lang.String name, boolean defaultValue) Adds a boolean property to the config file.
void	addBooleanProperty(java.lang.String name, boolean defaultValue, java.lang.String comment) Adds a boolean property to the config file.
void	addBooleanProperty(java.lang.String name, java.lang.String category, boolean defaultValue) Adds a boolean property in the given category to the config file.
void	addBooleanProperty(java.lang.String name, java.lang.String category, boolean defaultValue, java.lang.String comment) Adds a boolean property with a comment in the given category to the config file.
void	addIntProperty(java.lang.String name, int defaultValue) Adds a int property to the config file.
void	addIntProperty(java.lang.String name, int defaultValue, java.lang.String comment) Adds a int property to the config file.
void	addIntProperty(java.lang.String name, java.lang.String category, int defaultValue) Adds a int property in the given category to the config file.
void	addIntProperty(java.lang.String name, java.lang.String category, int defaultValue, java.lang.String comment) Adds a int property with a comment in the given category to the config file.
void	addStringProperty(java.lang.String name, java.lang.String defaultValue) Adds a string property to the config file.
void	addStringProperty(java.lang.String name, java.lang.String category, java.lang.String defaultValue) Adds a string property in the given category to the config file.
void	addStringProperty(java.lang.String name, java.lang.String category, java.lang.String defaultValue, java.lang.String comment) Adds a string property with a comment in the given category to the config file.
boolean	getBoolean(java.lang.String name) Gets the value of a boolean property.
boolean	getBoolean(java.lang.String name, java.lang.String category) Gets the value of a boolean property in the given category.
boolean	getBooleanFrom(java.lang.String configFile, java.lang.String name) Gets the value of a boolean property from the given config file.
boolean	getBooleanFrom(java.lang.String configFile, java.lang.String name, java.lang.String category) Gets the value of a boolean property in the given category from the given config file
int	getInt(java.lang.String name) Gets the value of a int property.
int	getInt(java.lang.String name, java.lang.String category) Gets the value of a int property in the given category.
int	getIntFrom(java.lang.String configFile, java.lang.String name) Gets the value of a int property from the given config file.
int	getIntFrom(java.lang.String configFile, java.lang.String name, java.lang.String category) Gets the value of a int property in the given category from the given config file
java.lang.String	getString(java.lang.String name) Gets the value of a string property.
java.lang.String	getString(java.lang.String name, java.lang.String category) Gets the value of a string property in the given category.
java.lang.String	getStringFrom(java.lang.String configFile, java.lang.String name) Gets the value of a string property from the given config file.
java.lang.String	getStringFrom(java.lang.String configFile, java.lang.String name, java.lang.String category) Gets the value of a string property in the given category from the given config file

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptableConfig

public ScriptableConfig(cubex2.cs2.Mod mod)

Method Detail

addBooleanProperty

public void addBooleanProperty(java.lang.String name,
                               boolean defaultValue)

Adds a boolean property to the config file. Uses general as category.

Parameters:

name - The name of the property

defaultValue - The default value

addBooleanProperty

public void addBooleanProperty(java.lang.String name,
                               java.lang.String category,
                               boolean defaultValue)

Adds a boolean property in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

addBooleanProperty

public void addBooleanProperty(java.lang.String name,
                               boolean defaultValue,
                               java.lang.String comment)

Adds a boolean property to the config file. Uses general as category.

Parameters:

name - The name of the property

defaultValue - The default value

comment - The comment for the property

addBooleanProperty

public void addBooleanProperty(java.lang.String name,
                               java.lang.String category,
                               boolean defaultValue,
                               java.lang.String comment)

Adds a boolean property with a comment in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

comment - The comment for the property

addIntProperty

public void addIntProperty(java.lang.String name,
                           int defaultValue)

Adds a int property to the config file. Uses general as category.

Parameters:

name - The name of the property

defaultValue - The default value

addIntProperty

public void addIntProperty(java.lang.String name,
                           java.lang.String category,
                           int defaultValue)

Adds a int property in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

addIntProperty

public void addIntProperty(java.lang.String name,
                           int defaultValue,
                           java.lang.String comment)

Adds a int property to the config file. Uses general as category.

Parameters:

name - The name of the property

defaultValue - The default value

comment - The comment for the property

addIntProperty

public void addIntProperty(java.lang.String name,
                           java.lang.String category,
                           int defaultValue,
                           java.lang.String comment)

Adds a int property with a comment in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

comment - The comment for the property

addStringProperty

public void addStringProperty(java.lang.String name,
                              java.lang.String defaultValue)

Adds a string property to the config file. Uses general as category.

Parameters:

name - The name of the property

defaultValue - The default value

addStringProperty

public void addStringProperty(java.lang.String name,
                              java.lang.String category,
                              java.lang.String defaultValue)

Adds a string property in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

addStringProperty

public void addStringProperty(java.lang.String name,
                              java.lang.String category,
                              java.lang.String defaultValue,
                              java.lang.String comment)

Adds a string property with a comment in the given category to the config file.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

defaultValue - The default value

comment - The comment for the property

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws java.lang.Exception

Gets the value of a boolean property. Uses general as category.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getBoolean

public boolean getBoolean(java.lang.String name,
                          java.lang.String category)
                   throws java.lang.Exception

Gets the value of a boolean property in the given category.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception

getBooleanFrom

public boolean getBooleanFrom(java.lang.String configFile,
                              java.lang.String name)
                       throws java.lang.Exception

Gets the value of a boolean property from the given config file. Uses general as category.

Parameters:

configFile - The config file

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getBooleanFrom

public boolean getBooleanFrom(java.lang.String configFile,
                              java.lang.String name,
                              java.lang.String category)
                       throws java.lang.Exception

Gets the value of a boolean property in the given category from the given config file

Parameters:

configFile - The config file

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception

getInt

public int getInt(java.lang.String name)
           throws java.lang.Exception

Gets the value of a int property. Uses general as category.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getInt

public int getInt(java.lang.String name,
                  java.lang.String category)
           throws java.lang.Exception

Gets the value of a int property in the given category.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception

getIntFrom

public int getIntFrom(java.lang.String configFile,
                      java.lang.String name)
               throws java.lang.Exception

Gets the value of a int property from the given config file. Uses general as category.

Parameters:

configFile - The config file

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getIntFrom

public int getIntFrom(java.lang.String configFile,
                      java.lang.String name,
                      java.lang.String category)
               throws java.lang.Exception

Gets the value of a int property in the given category from the given config file

Parameters:

configFile - The config file

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception

getString

public java.lang.String getString(java.lang.String name)
                           throws java.lang.Exception

Gets the value of a string property. Uses general as category.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String category)
                           throws java.lang.Exception

Gets the value of a string property in the given category.

Parameters:

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception

getStringFrom

public java.lang.String getStringFrom(java.lang.String configFile,
                                      java.lang.String name)
                               throws java.lang.Exception

Gets the value of a string property from the given config file. Uses general as category.

Parameters:

configFile - The config file

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.Exception

getStringFrom

public java.lang.String getStringFrom(java.lang.String configFile,
                                      java.lang.String name,
                                      java.lang.String category)
                               throws java.lang.Exception

Gets the value of a string property in the given category from the given config file

Parameters:

configFile - The config file

name - The name of the property

category - The category of the property. No capitals.

Returns:

The value of the property

Throws:

java.lang.Exception