FOvrUser
()
|
This is the default constructor for the struct, which initializes the ::ovrUserHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrUser::FOvrUser() |
FOvrUser
(
OvrHandle
, MessageHandlePtr
)
|
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrUser::FOvrUser(ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr) Parameters OvrHandle: ovrUserHandleMessageHandlePtr: TOvrMessageHandlePtr |
DisplayName
: FString |
A potentially non unique displayable name chosen by the user. Could also be the same as the oculus_ID. This is often the name shown to other users.
Signature
FString FOvrUser::DisplayName |
ID
: FOvrId |
The ID of the user, field FOvrUser::ID. This is a unique value for every individual user.
Signature
FOvrId FOvrUser::ID |
ImageUrl
: FString |
The url of the profile picture that is chosen by the user. Retrieve this url by using UOvrRequestsBlueprintLibrary::User_GetLoggedInUser().
Signature
FString FOvrUser::ImageUrl |
ManagedInfo
: FOvrManagedInfo |
Managed account info, FOvrManagedInfo, for the user which contains further metadata that is only available if the user is a Meta Managed Account(MMA). There must be user consent via dialog during installation, your app must have DUC enabled, and the app must be admin-approved.
Signature
FOvrManagedInfo FOvrUser::ManagedInfo |
OculusID
: FString |
The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.
Signature
FString FOvrUser::OculusID |
Presence
: FString |
Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated.
Signature
FString FOvrUser::Presence |
PresenceDeeplinkMessage
: FString |
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
Signature
FString FOvrUser::PresenceDeeplinkMessage |
PresenceDestinationApiName
: FString |
If provided, this is the unique API Name that refers to the FOvrDestination this user is currently at in the app. Read more about destinations here
Signature
FString FOvrUser::PresenceDestinationApiName |
PresenceLobbySessionId
: FString |
If provided, the lobby session this user is currently at in the application. If the ApplicationInvite is generated from rich presence, the lobby session id will be auto populated by calling field FOvrUser::PresenceLobbySessionId from the inviters' viewer context.
Signature
FString FOvrUser::PresenceLobbySessionId |
PresenceMatchSessionId
: FString |
If provided, the match session this user is currently at in the application. If the ApplicationInvite is generated from rich presence, the match session id will be auto populated by calling field FOvrUser::PresenceMatchSessionId from the inviters' viewer context.
Signature
FString FOvrUser::PresenceMatchSessionId |
PresenceStatus
: EOvrUserPresenceStatus |
An enum value for the different statuses representing what the user is currently doing. The different statuses can be EOvrUserPresenceStatus::Unknown, EOvrUserPresenceStatus::Offline, EOvrUserPresenceStatus::Online.
Signature
EOvrUserPresenceStatus FOvrUser::PresenceStatus |
SmallImageUrl
: FString |
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using field FOvrUser::SmallImageUrl.
Signature
FString FOvrUser::SmallImageUrl |
Clear
()
|
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrUser::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 FOvrUser::Update(ovrUserHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr) Parameters OvrHandle: ovrUserHandleMessageHandlePtr: TOvrMessageHandlePtrReturns void |