Version
menu_open

◆ CloseGroup

bool(* ak_wwise_plugin_host_undo_manager_v1::CloseGroup) (struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this, ak_wwise_plugin_undo_group_close_action in_action, ak_wwise_plugin_undo_group_id in_groupId, const char *in_szApplyEventName)

Closes the last opened group, in stack ordering.

Close the current group (_CLOSE) and add its content as a unique entry to the previous group, or to the Undo stack (_APPLY), or cancel its contents (_CANCEL).

in_szApplyEventName is only used for _APPLY. It is ignored elsewhere, and needs to be nullptr on _APPLY_FIRST_EVENT_NAME or _APPLY_LAST_EVENT_NAME.

in_groupId is only for validation, you can pass 0 if you do not wish to provide this validation.

Warning: Cancelling contents doesn't undo all the grouped actions. You are responsible for doing all the proper undoing before closing the group.

Warning:

Parameters
[in] in_this Current instance of this interface.
[in] in_action Action to perform when closing the group. Should usually be AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY.
[in] in_groupId (Optional, pass 0) Validation to make sure the group being closed has the proper ID.
[in] in_szApplyEventName Event name. Added after "Undo " and "Redo " in the menu.
Returns
true if successful.

Definition at line 192 of file HostUndoManager.h.

Referenced by AK.Wwise::Plugin::V1::UndoManager::CloseGroup().

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise