Close a Screen

Close a specific menu

1. From Open CalmUI Screen → Completed, save Screen Reference in a variable, for example MenuScreen.
2. On the event that should close the menu, add Close CalmUI Screen.
3. Connect MenuScreen to Screen Reference and the same Player Controller used to open it to Player Controller.
4. Check Return Value. true means the close request succeeded.

The custom event CloseMenu calls Close CalmUI Screen with the saved MenuScreen variable on Screen Reference. Its Return Value feeds a Branch, printing Menu closed on true or Close request failed on false.

Use a button action to trigger this event from your UI. For a Back button that removes whichever menu is on top, use Pop CalmUI Screen.

Close a HUD or dialog

Close CalmUI HUD removes the active HUD entry. Close CalmUI Modal removes the top dialog. Both take the player's controller. Pop CalmUI Screen removes whichever screen is on top of its layer. Each is driven from its own custom event (HideHud, DismissDialog, Back) with the Player Controller wired in directly.

Keep or reset the menu next time

Select the View in Studio and set its retention option:

• KeepAlive keeps local component values while the View is hidden, so reopening can preserve a selected tab or unfinished local interaction.
• Destroy removes the hidden View's components. Reopening creates fresh local component state.

Closing a View does not unload its package. To open it again, call Open CalmUI Screen with the same package and Screen. If it has an exit animation, it can remain visible briefly after closing, but it stops receiving input immediately. See View settings.