API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrUserCapability Struct

This object represents a permission or capability for the logged in user, which can be retrieved by UOvrRequestsBlueprintLibrary::User_GetLoggedInUser(). It's a type of array and there is a unique name for every user capability.

Constructors

FOvrUserCapability ()
This is the default constructor for the struct, which initializes the ::ovrUserCapabilityHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrUserCapability::FOvrUserCapability()
FOvrUserCapability ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrUserCapability::FOvrUserCapability(ovrUserCapabilityHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrUserCapabilityHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

Description : FString
The human readable description of the capability describing what possessing it entails for a given FOvrUser.
Signature
FString FOvrUserCapability::Description
IsEnabled : bool
Whether the capability is currently enabled for the user. When false, this field will gate the FOvrUser from the specified services.
Signature
bool FOvrUserCapability::IsEnabled
Name : FString
The unique identifier for the capability. An example capability could be "earn_achievements".
Signature
FString FOvrUserCapability::Name
ReasonCode : FString
This field specifies the reason the capability was enabled or disabled for the given FOvrUser. List of Reason Codes:
  • REASON_UNKOWN
  • SOCIAL_DISTANCING
  • VERBAL_ABUSE
  • TEXT_ABUSE
  • PARENTAL_CONTROL
  • DEVELOPER_ACTION
  • SALSA_RESTRICTION
  • SOCIAL_SUSPENSION
  • PAYMENT_SUSPENSION
  • PAYMENT_GIFTING_SUSPENSION
Signature
FString FOvrUserCapability::ReasonCode

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrUserCapability::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrUserCapability::Update(ovrUserCapabilityHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrUserCapabilityHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void