Tala Esenlikler

UInteractionCommandBeginFlowGuardAction

Execution action that starts a per-interactor flow guard for controlled UI transitions.

Interaction Framework 1.0.0 UE5.7 Class InteractionCommandBeginFlowGuardAction.h

Execution action that starts a per-interactor flow guard for controlled UI transitions.

Use this before an action that disables the final visible command, changes state so the current page becomes empty, leaves the currently projected variant, or otherwise makes the prompt surface collapse while a custom widget still needs to finish a transition.

The action stores the route context on the interactor and broadcasts OnInteractionFlowGuardStarted to the owning client. The guard retains the current interaction presentation and blocks prompt-driven activation until Blueprint or widget code ends the guard.

Module InteractionFrameworkRuntime
Category execution 
UCLASS(DisplayName = "Interaction Action Begin Flow Guard")
class INTERACTIONFRAMEWORKRUNTIME_API UInteractionCommandBeginFlowGuardAction : public UInteractionCommandExecutionAction

Properties

Interaction Command Begin Flow Guard Action

Begin On Started

If true, starts the guard when command execution starts.

bool
Interaction Command Begin Flow Guard Action

Event Tag

Optional project-defined event tag for widget branching.

FName
Interaction Command Begin Flow Guard Action

Reason

Stable key used to begin and later end the same flow guard.

FName

Use Cases

  • Start a guarded custom UI transition before the final visible command disables itself.
  • Notify the local widget to play a close animation before prompt state collapses.
  • Hold presentation state while Blueprint clears a custom overlay.

Notes

  • End the same Reason from widget or Blueprint code when the flow finishes.
  • Use EventTag to branch between completed, cancelled, or custom transition flows.
  • The guard does not bypass runtime validation or authority checks.

Related Docs