Configurable::GetSetting

Defined in: C4Configurable.h

Called to retrieve a particular setting for a configurable object.

Prototype

virtual Setting *GetSetting(long index) const;

Parameters

index The index of the setting to retrieve from the configurable object.

Description

The GetSetting function is called to retrieve a particular setting for a configurable object. An override implementation of this function should allocate a new Setting object corresponding the the setting index given by the index parameter and return a pointer to it. This function is called n times when building a configuration interface, where n is the number of settings returned by the Configurable::GetSettingCount function. The value of index ranges from 0 to n − 1.

The GetSetting function is allowed to return nullptr in the case that no setting should be presented to the user for a particular index.