UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FActiveForceFeedbackEffect Struct Reference

#include <ForceFeedbackEffect.h>

Public Member Functions

 FActiveForceFeedbackEffect ()
 
 FActiveForceFeedbackEffect (UForceFeedbackEffect *InEffect, FForceFeedbackParameters InParameters, FPlatformUserId InPlatformUser)
 
ENGINE_API ~FActiveForceFeedbackEffect ()
 
ENGINE_API bool Update (float DeltaTime, FForceFeedbackValues &Values)
 
ENGINE_API void ActivateDeviceProperties ()
 
ENGINE_API void ResetDeviceProperties ()
 
ENGINE_API void GetValues (FForceFeedbackValues &Values) const
 

Public Attributes

TObjectPtr< class UForceFeedbackEffectForceFeedbackEffect
 
FForceFeedbackParameters Parameters
 
float PlayTime
 
FPlatformUserId PlatformUser = PLATFORMUSERID_NONE
 
bool bActivatedDeviceProperties
 
TSet< FInputDevicePropertyHandleActiveDeviceProperties
 

Constructor & Destructor Documentation

◆ FActiveForceFeedbackEffect() [1/2]

FActiveForceFeedbackEffect::FActiveForceFeedbackEffect ( )
inline

◆ FActiveForceFeedbackEffect() [2/2]

FActiveForceFeedbackEffect::FActiveForceFeedbackEffect ( UForceFeedbackEffect InEffect,
FForceFeedbackParameters  InParameters,
FPlatformUserId  InPlatformUser 
)
inline

◆ ~FActiveForceFeedbackEffect()

FActiveForceFeedbackEffect::~FActiveForceFeedbackEffect ( )

Member Function Documentation

◆ ActivateDeviceProperties()

void FActiveForceFeedbackEffect::ActivateDeviceProperties ( )

◆ GetValues()

void FActiveForceFeedbackEffect::GetValues ( FForceFeedbackValues Values) const

◆ ResetDeviceProperties()

void FActiveForceFeedbackEffect::ResetDeviceProperties ( )

Reset any device properties that may need to be after the duration of this effect has ended.

◆ Update()

bool FActiveForceFeedbackEffect::Update ( float  DeltaTime,
FForceFeedbackValues Values 
)

Member Data Documentation

◆ ActiveDeviceProperties

TSet<FInputDevicePropertyHandle> FActiveForceFeedbackEffect::ActiveDeviceProperties

Array of device properties that have been activated by this force feedback effect

◆ bActivatedDeviceProperties

bool FActiveForceFeedbackEffect::bActivatedDeviceProperties

Set to true after this force feedback effect has activated it's device properties

◆ ForceFeedbackEffect

TObjectPtr<class UForceFeedbackEffect> FActiveForceFeedbackEffect::ForceFeedbackEffect

◆ Parameters

FForceFeedbackParameters FActiveForceFeedbackEffect::Parameters

◆ PlatformUser

FPlatformUserId FActiveForceFeedbackEffect::PlatformUser = PLATFORMUSERID_NONE

The platform user that should receive this effect

◆ PlayTime

float FActiveForceFeedbackEffect::PlayTime

The documentation for this struct was generated from the following files: