CalmUI
How To

Show a Notification

Configure the per-player notification queue and enqueue a completed host event.

Use this workflow for events such as Operation completed. The queue belongs to the Local Player subsystem and continues running even when its View is hidden.

Prepare the notification View

Start with the GameUI starter's Notifications View and notifications.entries keyed-array Store field. Keep notifications.exitSeconds as a float field. Save package Gameplay and wait for Unreal to receive the update.

Configure once, then enqueue

In BP_PlayerController, use Load CalmUI Package on BeginPlay. From Completed, configure the queue with Player Controller = Self.

Notification setup

Load CalmUI Package

CalmUI|Advanced

In: Player Controller: Self · Package: Gameplay

Out: Completed · Failed

Configure CalmUI Notifications

CalmUI|Notifications

In: Player Controller: Self · Package: Gameplay · Options: visible 3, pending 32, exit 0.18 · Entries Field: notifications.entries

Out: Success

Set CalmUI Float

CalmUI|Store

In: Player Controller: Self · Field: notifications.exitSeconds · Value: 0.18

Out: Boolean

Open CalmUI Screen

CalmUI

In: Package: Gameplay · Screen: Notifications

Out: Completed · Failed

On a completed host event, call Enqueue CalmUI Notification with the same Player Controller. Use a unique Event Id such as the completed objective's persistent ID. Set Duration Seconds to 4, Priority to 0, and fill Content with localized Title and Body. Check Result: Added or Grouped means accepted.

The mounted View should show the message, animate its exit, and remove it. If Result is Full, decide whether your host retries or drops the event; CalmUI does not silently evict another message.

Advanced: interactive notifications

Add Listen for CalmUI Action for Notifications.Dismiss and Notifications.Activate. Read id and actionId with Read CalmUI Action String. For queue-level request validation and action resolution, get the advanced Local Player subsystem and use Request CalmUI Notification Dismiss or Resolve CalmUI Notification Action only after the readers succeed. Resolution checks the current entry; it does not authorize the host operation.

If no notification appears

  • Print Load CalmUI Package → Failed and Open CalmUI Screen errors.
  • Check Configure's Success result and the Enqueue Result.
  • Read Get CalmUI Notification Error.
  • Confirm the View uses the same notifications.entries field reference.
  • Do not enqueue a second event ID merely because Store publication is retrying.

On this page