CToolMouse

Overview

Mouse world intersection and screen position utilities.

Struct: FCMouseData

Name Description
success Whether the mouse intersection succeeded.
intersectionResult World location of the intersection.
mouseScreenPosition Mouse position in screen coordinates.
hitResult Full FHitResult from the trace.

Functions

Name Description
mouseLocation Deproject mouse to world. If atZeroPosition=true, intersects with Z=0 plane. Otherwise performs a line trace against specified collision channels.
mouseLocation2 Simplified version using GetHitResultUnderCursorByChannel.
// Intersect with Z=0 plane
FCMouseData data = mouseLocation(myActor, true, {ECC_WorldStatic});

// Line trace against world
FCMouseData data2 = mouseLocation(myActor, false, {ECC_WorldStatic, ECC_Pawn, ECC_WorldDynamic});
if (data2.success) {
    FVector hitLocation = data2.hitResult.Location;
}

// Simple cursor hit
FCMouseData data3 = mouseLocation2(myActor, ECC_Visibility, true);