Skip to main content

Picker Params

Base:
struct
Type:
FNPickerParams
Header File:
NexusPicker/Public/NPickerParams.h

The base struct every shape-specific params type inherits from — see the per-shape pages under distributions/ for FNArcPickerParams, FNBoxPickerParams, and their siblings. Carries the point count, the cached UWorld* used for tracing/drawing, and the optional projection settings that snap generated points onto level geometry or the navmesh.

Properties

PropertyTypeCategoryDescription
Countint32BaseNumber of points to generate in a single pass. Default 1.
CachedWorldUWorld*BaseWorld used for line tracing and debug drawing. BlueprintReadOnly, VisibleInstanceOnly — populated automatically by every UN<Shape>PickerLibrary via N_GET_WORLD_FROM_CONTEXT if left null.
ProjectionModeENPickerProjectionModeProjection (advanced)Strategy used to snap a generated point to surrounding geometry. Default None.
ProjectionFVectorProjection (advanced)Direction and distance of the line trace when ProjectionMode == Trace. Default (0, 0, -500).
CollisionChannelECollisionChannelProjection (advanced)Trace channel used when ProjectionMode == Trace. Default ECC_WorldStatic.

Projection Mode

UENUM(BlueprintType)
enum class ENPickerProjectionMode : uint8
{
None = 0,
Trace = 1 UMETA(DisplayName="Line Trace (Collision)"),
NearestNavMeshV1 = 2 UMETA(DisplayName="Nearest NavMesh Point (V1)")
};
ValueBehaviour
NoneThe generated point is returned as-is.
TraceA line trace is cast from the point in direction Projection using CollisionChannel; if it hits, the hit location replaces the point.
NearestNavMeshV1The point is projected to the nearest reachable UNavigationSystemV1 location using FNPickerUtils's NavQueryExtent and NavAgentProperties. Falls back to the original location if the nav system is not initialized.

The projection metadata is marked AdvancedDisplay so it only shows up in the detail panel after clicking the disclosure chevron — picking without projection is the common case.

See Also

  • PickerUtils — owns the trace / nav-query defaults that the projection paths read from.
  • Distributions — one folder per shape, each subclassing this struct.