Version
Wwise SDK 2021.1.9

◆ ak_wwise_plugin_undo_group_close_action

Action to apply once this undo group is closed.

The goal of an undo group is to keep a list of actions being executed that can be undone (for example, a property set modification). Once the operations are all done, this indicates what should be done with the internal operations.

  • AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY : The usual operation is to open an undo group, and then close and apply the group to the undo stack. This provides a valid Undo/Redo label, as well as a description of all the operations that need to be done.
  • AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME and AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME are convenience operations, where the Undo operation title is retrieved from either the first or the last event's name, instead of hard-coding it ourselves.
  • AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL cancels the undo operations. It happens when an abnormal termination occurs, such as an error, or the user cancelling a lengthy operation. Since the operation states aren't known, you are responsible to handle the stored undo yourself, and manually revert all operations first before closing the action. An example of this operation is doing a slider drag event, where the user presses the Escape key instead of doing a Mouse Up. Effectively, all the inner operations will simply be cancelled by storing the initial value before doing the cancel operation on close.
  • AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE temporarily closes the undo state, leaving it possible to reopen it later. This is useful during lengthy processes, such as a user dragging a slider. You are expected to temporarily close the undo group when going out of scope, and reopening it when receiving a new system mouse drag event in this particular example.
Enumerator
AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE 

Close this group session (going out of scope), but do not apply it yet.

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY 

Close this group session permanently, and apply its operations to the englobing group.

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME 

Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the first inner undo event as the name.

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME 

Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the last inner undo event as the name.

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL 

Close this group session permanently, and cancel all its internal operations. Undo operations are not applied.

Definition at line 946 of file PluginDef.h.