com.GameInterface.DistributedValue

Shared variables, which can be observed and changed by any UI module, and some game systems. A basic tool for data sharing, configuration settings and event triggers.

Uniquely identified by name in a single, global, namespace. It may be a good practice to prefix all personal DVs with a short unique mod/author id to reduce the risk of conflict with other mods or game settings.

DVs of basic types can be changed using the chat interface using the '/setoption' or '/option' commands. Tab completion and a unique prefix can help locate your settings amongst the many settings exposed through this system.

Persistent DVs can be predefined in preference xml files (CharPrefs.xml or LoginPrefs.xml). These end up at the top level of the related settings file. For cleaner organization of multiple variables, at the cost of chat command access, use an Archive.

com.GameInterface.DistributedValue

Functions

Create

public static function Create(name: String)

Static wrapper for the constructor.

DistributedValue

public function DistributedValue(name: String)

Creates a reference to the DV with the given name, registering the name if it does not already exist.

public static function Create(name: String)
public function DistributedValue(name: String)
Close