API reference

FOvrPreemptableLatentAction Class

Extends FPendingLatentAction
An Interface for our latent actions that can be interrupted. It provide a way to handle OVR Platform requests that are initiated by blueprint nodes. These requests often involve network communication and require a response handler to be registered with the UOvrPlatformSubsystem.

Constructors

FOvrPreemptableLatentAction ( LatentInfo , RG , RP )
Signature
FOvrPreemptableLatentAction::FOvrPreemptableLatentAction(const FLatentActionInfo &LatentInfo, OvrPlatformRequestGenerator &&RG, OvrPlatformResponseProcessor &&RP)
Parameters
LatentInfo: const FLatentActionInfo &

Protected Fields

bIgnoreResponse : bool
This variable indicates whether the response from the Oculus VR Platform (OVRP) Subsystem should be ignored.
Signature
bool FOvrPreemptableLatentAction::bIgnoreResponse
CallbackTarget : FWeakObjectPtr
This is a weak pointer to an object that will be notified when the latent action is complete.
Signature
FWeakObjectPtr FOvrPreemptableLatentAction::CallbackTarget
ExecutionFunction : FName
This is the name of the function that will be executed when the latent action is triggered.
Signature
FName FOvrPreemptableLatentAction::ExecutionFunction
OutputLink : int32
This variable is used to store the output link.
Signature
int32 FOvrPreemptableLatentAction::OutputLink
RequestGenerator : OvrPlatformRequestGenerator
This is an instance of the OvrPlatformRequestGenerator class, which is used to generate requests to the Oculus Platform SDK.
Signature
OvrPlatformRequestGenerator FOvrPreemptableLatentAction::RequestGenerator
RequestID : ovrRequest
This is the ID of the request.
Signature
ovrRequest FOvrPreemptableLatentAction::RequestID
ResponseProcessor : OvrPlatformResponseProcessor
This is an instance of the OvrPlatformResponseProcessor class, which is used to process the response from the Oculus Platform SDK.
Signature
OvrPlatformResponseProcessor FOvrPreemptableLatentAction::ResponseProcessor

Protected Member Functions

GetOvrPlatform ()
This function returns a pointer to the UOvrPlatformSubsystem object, which provides access to the Oculus Platform SDK. The subsystem is used to perform various operations with the Oculus Platform, such as making requests and processing responses.
Signature
UOvrPlatformSubsystem* FOvrPreemptableLatentAction::GetOvrPlatform()
NotifyObjectDestroyed ()
This function is a virtual function that is called when the object associated with the latent action is destroyed.
Signature
virtual void FOvrPreemptableLatentAction::NotifyObjectDestroyed() override
Returns
void
UnlinkRequestDelegate ()
This function unlinks the request delegate from the Oculus Platform SDK. The request delegate is used to handle the response from the SDK, and unlinking it allows the latent action to ignore the response if desired.
Signature
void FOvrPreemptableLatentAction::UnlinkRequestDelegate()
Returns
void

Member Functions

IgnoreResponse ()
This function can be called to ignore the response from the Oculus Platform SDK. When this function is called, the latent action will not wait for a response from the SDK and will instead continue execution immediately.
Signature
void FOvrPreemptableLatentAction::IgnoreResponse()
Returns
void