C4 Engine Terathon Software C4 Engine API Documentation

• Interface Manager

API Links
Developer Links

class Setting

Defined in:  C4Configuration.h
Every user-configurable setting is a subclass of the Setting class.
Definition

class Setting : public ListElement<Setting>, public Packable

Member Functions
Setting::GetSettingType Returns the setting type.
Setting::GetSettingIdentifier Returns the setting's unique identifier.
Constructor

Setting(SettingType type, Type identifier);

Parameters
type The setting type.
identifier The setting's unique identifier.
Description
The Setting class is the base class for all user-configurable setting objects.
kSettingHeading A setting that simply displays a heading and has no value.
kSettingBoolean A boolean setting represented by a check box.
kSettingInteger An integer setting represented by a slider.
kSettingPowerTwo A power-of-two setting represented by a slider.
kSettingFloat A floating-point setting represented by a slider.
kSettingText A text setting represented by an editable text box.
kSettingMenu A multi-valued setting represented by a popup menu.
kSettingColor A color setting represented by a color box.
kSettingCheckColor A color setting represented by a color box with a check box for enable/disable.
kSettingResource A resource name setting represented by a text box and a browse button.
kSettingMultiResource A setting showing a list of resource names in a text box with a browse button.
Base Classes
ListElement<Setting> Used internally by the Interface Manager.
Packable A setting can be packed for storage in resources.
See Also

Configurable