aom.scripting.ui.config

Class Config

Object

Config

public class Config
extends Object

This package provides a collection of Console commands concerning Configs, combined with a list of all known ones. The configs are split across multiple classes, each representing a specific subcategory.

The types (int, bool, string, ...) of the configs listed here are mainly assigned using my "gut feeling", so there will probably be a couple of mistakes. If you spot an error please e-mail me the correct type.

To view a complete list of currently defined configs use the console command configDump().

Using configs

• Enabling a boolean config: use configDef(string) or +configName in a .cfg file.
• Disabling a boolean config: use configUndef(string) or -configName in a .cfg file.
• Assigning another value to a config: use configSet(string, string), configSetInt(string, int), configSetFloat(string, float) or configName newValue in a .cfg file.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call

Config settings are local only. Configs that directly impact gameplay (like {@link GameConfig#marketCostMin}) will typically be locked in order to prevent cheating.

Note

Enabling is the default action when a boolean config is found without a sign.

,

Quotes around strings are not required if that string does not contain spaces.

,

Configs are not case sensitive.

,

There's still plenty of configs that we don't quite understand, and even more that simply won't work anymore.

Field Summary

Fields

Modifier and Type	Field and Description
string	machineName
string	playerGuid The global unique id of the current profile, generated during installation.
string	playerProfileName Name for player profile.
float	requiredBuildVersion

Method Summary

Modifier and Type	Method and Description
void	config(string token) Changes configuration state just like a line in the *.cfg files.
void	configDef(string name) Defines or enabled a configuration variable, i.e.
void	configDump() Sends to output a list of all current configuration variables.
void	configGetByID(int value) Look up configuration by enumeration ID.
void	configHelp(string symbolFilter) Show all formally defined configuration variables that contain the filter string, or use no parameters for a full list.
void	configHelpPrefix(string symbolFilter) Show all formally defined configuration variables that start with the filter string, or use no parameters for a full list.
void	configSet(string name, string value) Sets a particular configuration variable to a string value.
void	configSetFloat(string name, float value) Sets a configuration variable to a floating point value.
void	configSetInt(string name, int value) Sets a configuration variable to an int value.
void	configToggle(string name) Defined variable becomes undefined, and vice versa.
void	configUndef(string name) Disables a configuration variable, i.e.

Methods inherited from class Object

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

Field Detail

playerGuid

public string playerGuid

The global unique id of the current profile, generated during installation.

playerProfileName

public string playerProfileName

Name for player profile.

requiredBuildVersion

public float requiredBuildVersion

machineName

public string machineName

Method Detail

configDump

public void configDump()

Sends to output a list of all current configuration variables.

configSet

public void configSet(string name,
                      string value)

Sets a particular configuration variable to a string value.

configSetInt

public void configSetInt(string name,
                         int value)

Sets a configuration variable to an int value.

configSetFloat

public void configSetFloat(string name,
                           float value)

Sets a configuration variable to a floating point value.

configDef

public void configDef(string name)

Defines or enabled a configuration variable, i.e. +config in a *.cfg file.

configUndef

public void configUndef(string name)

Disables a configuration variable, i.e. -config in a *.cfg file.

configToggle

public void configToggle(string name)

Defined variable becomes undefined, and vice versa.

config

public void config(string token)

Changes configuration state just like a line in the *.cfg files.

configGetByID

public void configGetByID(int value)

Look up configuration by enumeration ID. Note that an ID out of the array bounds will cause AoM to crash.

configHelp

public void configHelp(string symbolFilter)

Show all formally defined configuration variables that contain the filter string, or use no parameters for a full list.

configHelpPrefix

public void configHelpPrefix(string symbolFilter)

Show all formally defined configuration variables that start with the filter string, or use no parameters for a full list.