CalmUI
Blueprint

Open and Switch Screens

Choose the right Blueprint node for menus, HUDs, and dialogs.

Use Open CalmUI Screen to display a View from Studio. Connect the player's controller, choose the package, then choose Screen from that package's list. The first-screen tutorial shows every connection.

Use the result

  • Completed runs after the package loads and the screen opens. Save its Screen Reference to close that screen later. Set game values and subscribe to actions from this output.
  • Failed runs if the screen cannot open. Send Error Message to Print String to find out why.
  • The upper, unlabeled execution output continues immediately. Do not use it for work that requires the loaded package.
Open CalmUI Screen Completed output saving Screen Reference into the MenuScreen variable; Failed prints Error Message
Save Screen Reference from Completed so you can close that screen later.

Choose a screen type

What you needNode
Display a View using its Studio layer and input settingsOpen CalmUI Screen
Put a menu on top of the current Screen layerPush CalmUI Screen, using the version with Package and Screen inputs
Remove the top menu from that layerPop CalmUI Screen
Display health, score, or other HUD informationOpen CalmUI HUD
Display a confirmation dialogOpen CalmUI Modal
Close a specific screenClose CalmUI Screen, using the saved Screen Reference
Custom event OpenSettings driving Push CalmUI Screen with Screen Settings, and custom event Back driving Pop CalmUI Screen
Push CalmUI Screen (the version with Package and Screen inputs) puts a menu on top; Pop CalmUI Screen removes it.

The custom event OpenSettings drives Push CalmUI Screen with Screen = Settings, layering it above the current menu. The separate custom event Back drives Pop CalmUI Screen with just the Player Controller, removing whichever screen is on top of that layer.

Open CalmUI HUD with Screen Hud and Open CalmUI Modal with Screen ConfirmModal, each with Failed connected to Print String
Open CalmUI HUD and Open CalmUI Modal use the same Completed and Failed outputs as Open CalmUI Screen.

Open CalmUI HUD takes Screen = Hud; Open CalmUI Modal takes Screen = ConfirmModal. Both are driven from their own custom events and both route Failed to Print String, exactly like Open CalmUI Screen.

Opening HUDs and modals uses the same Completed and Failed outputs as opening a screen. Set the View's input and mouse cursor options in Studio. For example, a clickable confirmation dialog needs block-below input and a visible mouse cursor when used with a mouse.

Each local player has their own open screens. Pass the same controller when opening and closing a screen. See Layers and navigation.

On this page