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

FOvrParty Struct

Parties allow users to start a voice chat with other members of the party. Party voice chats persist across apps in VR and users can continue to interact while navigating between apps. You can load a user's party by using Party_GetCurrent().

Constructors

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

Fields

ID : FOvrId
A unique identifier of this party. It can be used by Party_Join(), Party_Leave(), and Party_Invite().
Signature
FOvrId FOvrParty::ID
InvitedUsers : FOvrUserPages
An array of users who are invited to this party. These users are not a part of the party yet but have been invited.
Signature
FOvrUserPages FOvrParty::InvitedUsers
Leader : FOvrUser
The user who initialized this party. It's also the first user who joined the party. The leader can invite and kick other users.
Signature
FOvrUser FOvrParty::Leader
An array that contains the users who are currently in this party. These users will remain in the party while navigating between apps.
Signature
FOvrUserPages FOvrParty::Users

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrParty::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 FOvrParty::Update(ovrPartyHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrPartyHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void