Version

menu_open
Wwise SDK 2023.1.5

◆ OpenGroup()

ak_wwise_plugin_undo_group_id AK.Wwise::Plugin::V1::UndoManager::OpenGroup ( ak_wwise_plugin_undo_group_id  in_reopenGroupId = 0)
inline

Open a group that will contain all subsequent undo events.

This must be done prior to performing any action on PropertySets, or adding custom events, as it is important to have one unique element on the undo stack. You can open multiple groups at once, like a stack, as long as you close them before exiting your function.

in_reopenGroupId should be set to 0 for a new group.

Example: ak_wwise_plugin_undo_group_id m_dragAndDropGroupId = 0; m_dragAndDropGroupId = OpenGroup(this, m_dragAndDropGroupId); if (m_dragAndDropGroupId == 0) return; CloseGroup(this, m_done ? AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY : AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE, "Drag and drop"); if (m_done) m_dragAndDropGroupId = 0;

Parameters
[in]in_reopenGroupIdPreviously opened undo group, or 0 for a new group.
Returns
The new undo group that just got created, or 0 if the system cannot open a group at the moment.

Definition at line 537 of file HostUndoManager.h.

References AK.Wwise::Plugin::CBaseInterfaceGlue< CHostUndoManager >::g_cinterface, and ak_wwise_plugin_host_undo_manager_v1::OpenGroup.

Referenced by AK.Wwise::Plugin::AutoUndoGroup::AutoUndoGroup().


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