Blueprint

Universal Virtual Cursor

← All docs
Overview DependenciesSet upSettings
APIBlueprintC++Examples
DiagnosticsTroubleshootingChangelog Report bug
Roadmap Plugin page Marketplace
Universal Virtual Cursor

Blueprint

Blueprint-callable functions, events, and properties for Universal Virtual Cursor — subsystem, widget base, target component, parallax, and settings. Order matches the plugin blueprint map.

UVirtualCursorSubsystem

Get from Local Player → Get Subsystem (type Virtual Cursor Subsystem). One instance per local player.

On Gamepad Input Detected
Multicast delegate — gamepad input was detected while the virtual cursor is relevant.
On Virtual Cursor Target Entered
Cursor entered a widget with UVirtualCursorTargetComponent .
On Virtual Cursor Target Exited
Cursor exited a virtual cursor target.
On Virtual Cursor Target Overlap Changed
Overlap state changed for the active target.
Enable Virtual Cursor
Turn on virtual cursor handling for this player. Safe to call more than once.
Disable Virtual Cursor
Disable virtual cursor for this player.
Snap Virtual Cursor To Nearest Target In Direction
Direction
Return Value
Snap to the nearest snap target in the given direction ( EUniversalVirtualCursorSnapDirection ).
Snap Virtual Cursor To Adjacent Snap Target
Cycle Direction
Return Value
Move snap focus to an adjacent target ( EUniversalVirtualCursorSnapCycleDirection ).
Get Owning Player Controller
Return Value
Player controller that owns this subsystem.
Get Local Slate User Index
Return Value
Slate user index for this local player.
Is Virtual Cursor Active For Slate User
Return Value
Whether virtual cursor is enabled for the Slate user.
Is Virtual Cursor Driving For Slate User
Return Value
Whether the analog virtual cursor is currently driving position.
Get Virtual Cursor Target Host Widget
Return Value
Widget hosting the current virtual cursor target context, if any.
Get Virtual Cursor Target Outer From Host Parent
Return Value
Outer object used when resolving target geometry from a host parent chain.
Is Virtual Cursor Target Overlapping
Return Value
Whether the cursor overlaps a registered virtual cursor target.

UUniversalVirtualCursorWidget

Optional widget base: drag/drop helpers and forwards target overlap events to Blueprint.

On Drag Drop Started
Implementable event — drag started.
On Drag Drop Ended
Implementable event — drag ended.
On Virtual Cursor Target Entered
Forwarded when the cursor enters a virtual cursor target relevant to this widget.
On Virtual Cursor Target Exited
Forwarded when the cursor exits a virtual cursor target.
On Virtual Cursor Target Overlap Changed
Forwarded when target overlap state changes.
Is Owning Player Drag Dropping
Return Value
True while the owning player has an active drag-drop operation.
Get Current Drag Drop Operation
Return Value
Current UDragDropOperation, if any.
Try Get Drag Source Widget From Current Drag
Return Value
Out Widget
Resolve the source widget from the active drag operation.
Try Get Drag Source Widget From Operation
Operation
Return Value
Out Widget
Resolve the source widget from a specific drag-drop operation.
Is Drag Cursor Over This Widget
Return Value
Whether the drag cursor is over this widget.
Is Virtual Cursor Target Overlapping
Return Value
Overlap test for virtual cursor targets (widget context).

UVirtualCursorTargetComponent

Add to widgets that participate in sticky slowdown or snap. Configure properties in the Details panel.

Get Owning Subsystem
Return Value
Returns the UVirtualCursorSubsystem for this component.

UVirtualCursorParallaxOverlay

UMG overlay that offsets children based on virtual cursor position. Properties: bUseProjectParallaxDefaults, ParallaxStrength, MaxParallaxOffset, ParallaxInterpSpeed, bInvertParallaxDirection.

UUniversalVirtualCursorSettings

Project Settings → Plugins → Universal Virtual Cursor. See the Settings page for field descriptions.

Get
Return Value
Static — read-only defaults.
Get Mutable
Return Value
Static — mutable settings object for runtime changes.

Blueprint enums

EUniversalVirtualCursorStickySlowdownSource , EUniversalVirtualCursorSnapDirection , EUniversalVirtualCursorSnapCycleDirection , EUniversalVirtualCursorSnapPoint , EUniversalVirtualCursorAnalogDriveMode

Native helpers (reference)

FVirtualAnalogCursor — analog cursor simulation. GetUniversalVirtualCursorTargetDebug() — diagnostics overlay hook; pair with the Diagnostics page.