Home › System plugins › AFS_UX_Select

System

AFS_UX_Select

Selection by fingertip, laser or desktop click, with priority resolution and interface-based vetoes.

What it gives you

One interaction that works with mouse, laser and fingertip
Priority resolution when objects overlap
Hit-location override for precise pointing

Requires

AFM_Abilities AFM_WidgetInteraction AFS_Libraries

Required by

AFE_Showroom AFS_UX_Grip AFS_UX_Laser AFS_UX_Teleporter AF_Examples

8 assets21 API members

Description

Select is the smallest complete interaction stack in the framework and the best one to read when learning the pattern.

BPC_PawnAbility_Select traces from the pawn and resolves the highest-priority selectable component under the cursor. BPC_Interaction_Select on the target declares selectability and fires On Select. Interface_Select on the owning actor can veto, or redirect where a pointer appears to hit.

The same interaction serves all three input methods, because the ability supplies the trace and the target only cares about the resulting Source Info.

Setup

Enable AFS_UX_Select.
Confirm BPC_PawnAbility_Select is on the pawn, and BPC_ControllerAbility_Hand_Laser or _Hand_Finger on the motion controllers for VR.
Add BPC_Interaction_Select to any actor and bind On Select.

Usage

Basic selection

See Make an object selectable.

Vetoing

Implement Interface_Select and return Override = true with Is Selectable = false.

Redirecting the pointer

Implement Select_HitLocationOverride to make a laser terminate at a chosen point rather than the raw trace hit — useful for snapping to a control's centre.

The object selected in play, highlight active

Key properties

Property When to change

Select Sound Feedback on selection

Relevant Components Restrict which meshes are clickable

Select Interaction Style The cursor and accent colour shown while hovering something selectable

Min / Max Laser Length On the laser ability, to change reach

Property	When to change
`Select Sound`	Feedback on selection
`Relevant Components`	Restrict which meshes are clickable
`Select Interaction Style`	The cursor and accent colour shown while hovering something selectable
`Min` / `Max Laser Length`	On the laser ability, to change reach

Extending

Copy this stack's shape when adding your own interaction type — it is the reference implementation. See Extending the framework.

Multiplayer notes

Multiplayer

BPC_Interaction_Select implements IOutsidePawnRPCInterface, so selection replicates without routing through the pawn. Requires AFPNetDriver.

Example map

Map_Examples_Select covers click, laser and fingertip selection with vetoes.

Troubleshooting

Nothing is selectable. The pawn is missing BPC_PawnAbility_Select, or the object's meshes have no collision on the trace channel.

API reference

Every blueprint asset in this plugin. Expand an asset to see its members.

Components/ControllerAbilities

BPC_ControllerAbility_Hand_Finger1 members

extends BPC_ControllerAbility

Kind	Name	Signature	Description
var	`Trace Distance`Settings	`float`	How far ahead of the fingertip the selection trace reaches.

BPC_ControllerAbility_Hand_Laser7 members

extends BPC_ControllerAbility

Kind	Name	Signature	Description
var	`MinLaserLength`Settings	`float`	Shortest the laser is drawn when it hits something close by.
var	`MaxLaserLength`Settings	`float`	Maximum reach of the selection laser.
var	`Mapping Contexts Default`Input	`ST_MappingContext_Side`	Input mapping contexts applied for the left and right hand.
var	`Thickness`Settings	`float`	Thickness of the laser beam.
var	`Color`Settings	`LinearColor`	Colour of the laser beam.
fn	`SetHoverState`	`(out AlternateLocation: bool, out Location: Vector)`	Updates the laser's hover appearance and returns an alternate endpoint when the target overrides its hit location.
fn	`HandleSelect`	`()`	Runs a selection against whatever the laser is currently pointing at.

Components/Interactions

BPC_Interaction_Select5 members

extends BPC_Interaction · implements OutsidePawnRPCInterface

Kind	Name	Signature	Description
var	`SelectSound`Sound	`SoundBase`	Sound played at the hit location when this object is selected.
fn	`Can be Selected`Select	`(ref const HitComponent: PrimitiveComponent, SourceInfo: ST_SourceInfo, out CanBeSelected: bool)`	Returns whether this object may currently be selected by the given source, consulting Interface Select on the owner if implemented.
fn	`OverrideHitLocation`Select	`(out Override: bool, out HitLocation: Vector)`	Lets the owner supply a different hit location, so a laser can terminate on a chosen point rather than the raw trace hit.
fn	`HandleSelect`	`(SourceInfo: ST_SourceInfo, HitResult: HitResult)`	Broadcasts On Select without playing feedback, for triggering a selection from code.
event	`SelectPressed`	`(SourceInfo: ST_SourceInfo, HitResult: HitResult)`	Fires when the object is selected, playing sound and haptics. Bind to On Select to react.

Components/PawnAbility

BPC_PawnAbility_Select3 members

extends BPC_PawnAbility

Kind	Name	Signature	Description
var	`Input_Select`Input	`InputMappingContext`	Input mapping context enabled while this ability is active, carrying the select action.
var	`SelectInteractionStyle`Style	`PDA_InteractionState`	Interaction state requested while hovering something selectable, controlling the cursor and accent colour.
event	`Select`	`()`	Runs a selection against whatever the pawn is currently pointing at.

BPC_PawnAbility_Widget2 members

extends BPC_PawnAbility

Kind	Name	Signature	Description
var	`Input_Widget`Input	`InputMappingContext`	Input mapping context enabled while this ability is active, carrying the widget interaction actions.
var	`WidgetInteractionStyle`Style	`PDA_InteractionState`	Interaction state requested while hovering a widget.

Helpers

BP_Helper_ControllerAbility_Hand_Finger0 members

extends BP_Helper_ControllerAbility

No editor-visible members; this asset configures defaults only.

BP_Helper_ControllerAbility_Hand_Laser1 members

extends BP_Helper_ControllerAbility

Kind	Name	Signature	Description
var	`ControllerAbilityHandLaser`	`BPC_ControllerAbility_Hand_Laser`	The laser ability this helper draws for.

Interfaces

Interface_Select2 members

extends Interface

Kind	Name	Signature	Description
fn	`CanBeSelected`Select	`(SelectComponent: BPC_Interaction_Select, SourceInfo: ST_SourceInfo, out Override: bool, out IsSelectable: bool)`	Implement on an actor to veto or allow selection under your own conditions. Return Override true and Is Selectable false to block; not implementing the interface means always selectable.
fn	`Select_HitLocationOverride`Select	`(out Override: bool, out NewHitLocation: Vector)`	Implement to redirect where a pointer appears to hit this object, for example snapping a laser to a control's centre.