Actor component that discovers registered target points, resolves focus, tracks visible handles and surfaces, handles paging/progress, and requests command activation.
UCLASS(ClassGroup = (InteractionRuntime), meta = (BlueprintSpawnableComponent))
class INTERACTIONFRAMEWORKRUNTIME_API UInteractionRuntimeInteractorComponent : public UActorComponentMembers
AreInteractionFlowGuardsActive
Returns true while any presentation flow guard is active.
BeginInteractionFlowGuard
Starts or increments a presentation flow guard for this interactor.
ClearInteractionFlowGuards
Clears every active presentation flow guard on this interactor.
IsInteractionFlowGuardActive
Returns true while the supplied presentation flow guard reason is active.
On Interaction Flow Guard Ended
Fires when a flow guard reason count reaches zero.
On Interaction Flow Guard Started
Fires when a flow guard reason becomes active.
On Interaction Flow Guards Changed
Fires whenever the active flow guard set changes.
CalculateFocusedPointLookAtRotation
Calculates a control rotation looking from this interactor's resolved view origin toward the focused point.
ClearLocalPointVariantOverride
Clears a local point variant override for this interactor only.
ClearSavedLocalPointVariantOverride
Clears a saved local variant override for this interactor.
GetFocusedHandle
Returns the handle of the currently focused point, or an invalid handle if HasFocus() is false.
GetFocusGroupMembers
Returns all point handles that share a composite group with the focused point.
GetLocalPointVariantOverride
Returns a local point variant override for this interactor, when one exists.
GetProximityState
Returns the current proximity state relative to the focused point.
GetResolvedSurface
Returns the current resolved surface (command prompt layout) for the focused point.
GetVisiblePointHandles
Returns all point handles currently within POI range and displayable to this interactor.
HasFocus
Returns true if this interactor currently has a focused interaction point.
IsPointHandleInteractable
Returns true if the given handle is within interactable range.
RequestActivateSurfaceIndex
Requests activation of the command at the given surface index.
RequestActivateSurfaceIndexWithPhase
Same as RequestActivateSurfaceIndex but with an explicit phase token.
RequestPreviousCommandPage
Returns to the previous command page if paging is active.
ResolveInteractionSaveOwnerId
Resolves the stable owner save id used for owner-scoped interaction persistence.
SetInteractionSaveOwnerId
Sets the stable save owner id for owner-scoped persistence.
SetLocalPointVariant
Sets a local point variant override for this interactor only.
SetSavedLocalPointVariant
Sets and optionally saves a local point variant override for this interactor.
Use Cases
- Add to pawns or actors that should discover, focus, and activate interactions.
- Configure in Blueprint defaults for designer-authored interaction actors.
Notes
- This is a runtime component, not an editor-only helper.
- Local focus and prompt projection are read by UI and activation code.