View Settings
Choose where a View appears, how it handles input, and what happens when it closes.
Select a View in Studio to open the VIEW Inspector. Save after changing its settings and wait for the connected Unreal package to update.
| Setting | What it controls |
|---|---|
| Name | The name shown in the View list and Blueprint Screen dropdown |
| Entry | The root .calmui file for the View |
| Layer | Whether it appears as a world (world-anchored, below HUD), HUD, screen, overlay, modal, or tooltip |
| Input Policy | Whether it receives input and blocks the content below |
| Show Mouse Cursor | Whether the mouse cursor should be visible |
| Retention | Whether closing keeps local component state or resets it |
Open it with Open CalmUI Screen. See the Blueprint steps. A View in Studio and a Screen in these nodes refer to the same interface.
Keep state when a View closes
Choose KeepAlive to retain local values, such as the selected tab, while the
View is hidden. Choose Destroy to remove its components after closing.
Unloading the package, changing maps, or removing the player clears the View
regardless of this setting.
Animate opening and closing
- Add the animation or transition to the View's component CSS.
- In the VIEW Inspector, set the enter or exit CSS class to apply.
- Set its duration in milliseconds, from
0to60000. - Save and test opening and closing the View in Unreal.
The duration tells CalmUI how long to keep the opening or closing phase active;
it does not create an animation by itself. Use 0 for an immediate change.
The runtime also adds state classes such as calmui-view-entering,
calmui-view-active, and calmui-view-exiting to the root element.
Closing immediately releases input and focus, even while an exit animation is
still visible. With Destroy, components and their timers are removed when the
exit duration ends. With KeepAlive, the View stays hidden until reopened.
Reopening during an exit interrupts the close. Closing during an entrance cancels that entrance. Check both paths when designing a transition.