CalmUI
Blueprint

Load a Package Before Opening a View

Prepare game values and action listeners before a screen is created.

Use this sequence when a View needs initial game data or an action listener before it opens. For an ordinary clickable menu, the shorter Open CalmUI Screen workflow is enough.

Load without displaying anything

  1. Add Load CalmUI Package from CalmUI | Advanced. Choose the version with Player Controller, Package, Completed, and Failed pins.
  2. Connect your Player Controller and select the imported package asset.
  3. Connect Failed to Print String, using its Error text.
  4. From Completed, set initial Store values or start Listen for CalmUI Action nodes with the same Player Controller. Completed carries the loaded Package; Failed carries Error, the same (Package, Error) signature used by Open/Push CalmUI Screen and the other async CalmUI nodes.
  5. After setup, call Open CalmUI Screen with the same controller and package.
Event BeginPlay calling Load CalmUI Package; Completed starts Listen for CalmUI Action and then Open CalmUI Screen; Failed prints Package load failed
Event BeginPlay → Load CalmUI Package; Completed → Listen for CalmUI Action → Open CalmUI Screen; Failed → Print String.

Event BeginPlay calls Load CalmUI Package. Its Completed output starts Listen for CalmUI Action and then calls Open CalmUI Screen with the same package, so listeners are registered before the screen appears. Its Failed output runs Print String with the load error.

Start listeners only after loading succeeds. Connect each listener's Failed output to a visible error path and keep its Listener output if you need to stop it before its owner is destroyed. The following Open node can reuse the loaded package.

Loading also prepares reusable presentation state from the validated compiled package before the first Screen is shown. Use this route for a critical menu when you want package validation, initial Store writes, listeners, and cold preparation to happen before its entrance. If preparation cannot be reused, the first Screen retries it and Unreal logs the reason.

Release a package

Custom event ReleaseMenuPackage calling Unload CalmUI Package on the Local Player Subsystem with the Gameplay package
Unload CalmUI Package on the player's subsystem only when no View from the package is needed.

The custom event ReleaseMenuPackage gets the Get CalmUI Local Player Subsystem for the Player Controller and calls Unload CalmUI Package on it with the Gameplay package.

Use Unload CalmUI Package on the player's subsystem only when you no longer need any View from it. Use Close CalmUI Screen when you only want to dismiss a menu. Unloading removes the package's Views, including hidden Views that were keeping local state.

On this page