Defined in:Called when the settings for a configurable object are about to be updated.
virtual void *BeginConfigurationCommit(void);
BeginConfigurationCommitfunction is called right before the settings for a configurable object are going to be updated through calls to the
Configurable::CommitSettingfunction. After all of the settings have been updated, the
Configurable::EndConfigurationCommitfunction 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
BeginConfigurationCommitfunction is passed to the
cookieparameter of the
EndConfigurationCommitfunction. 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
BeginConfigurationCommitfunction, and then use the data is holds in the
EndConfigurationCommitfunction to determine if specific settings have changed that require some additional action to be taken. (The
EndConfigurationCommitfunction should then deallocate the data structure, if necessary.)