API reference
UMetaXRHapticsFunctionLibrary Class
Extends UBlueprintFunctionLibrary
Blueprint function library with helper functions.
Static Member Functions
static UMetaXRHapticsPlayerComponent * SpawnHapticsPlayerComponent
( AActor * ActorToAttachTo,
UMetaXRHapticClip * HapticClip,
const EMetaXRHapticController Controller,
const int32 Priority,
const float Amplitude,
const float FrequencyShift,
const bool bIsLooping )
Spawns a UMetaXRHapticsPlayerComponent and attaches it to an Actor.Always spawn new player components using this method. It is a known issue that Unreal's built-in "Add Haptics SDK Player" will lead to initialization errors.When playback finishes, the component will not automatically destroy itself.
Parameters
ActorToAttachTo
Actor to which this component will be attached.
HapticClip
Haptic clip to load.
Controller
Controller used to play haptics.
Priority
Playback priority, ranging from 0 (low priority) to 1024 (high priority).
Amplitude
Amplitude scale, ranging from 0.0 to infinity.
FrequencyShift
Frequency shift, ranging from -1.0 to 1.0.
bIsLooping
Whether playback should loop.
Returns
A UMetaXRHapticsPlayerComponent that plays back the haptic clip and can be used to control playback.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta