Configurable::BeginConfigurationCommit

Defined in: C4Configurable.h

Called when the settings for a configurable object are about to be updated.

Prototype

virtual void *BeginConfigurationCommit(void);

Description

The BeginConfigurationCommit function is called right before the settings for a configurable object are going to be updated through calls to the Configurable::CommitSetting function. After all of the settings have been updated, the Configurable::EndConfigurationCommit function is called. Implementing this pair of functions allows an object to take specific actions when it is being reconfigured by the user in the World Editor.

The pointer returned by the BeginConfigurationCommit function is passed to the cookie parameter of the EndConfigurationCommit function. This pointer is for use by the implementation of the overriding class and is not used by the engine. For example, an implementation may allocate a data structure to hold some previous settings, return a pointer to that structure from the BeginConfigurationCommit function, and then use the data is holds in the EndConfigurationCommit function to determine if specific settings have changed that require some additional action to be taken. (The EndConfigurationCommit function should then deallocate the data structure, if necessary.)