UE3:OnlinePartyChatInterface (UDK)

Interface >> OnlinePartyChatInterface

Package: 

Engine

This interface provides extended player functionality not supported by all platforms. The OnlineSubsystem will return NULL when requesting this interface on a platform where it is not supporeted.

Delegates

OnSendPartyGameInvitesComplete

delegate OnSendPartyGameInvitesComplete (bool bWasSuccessful)

Called when the async invite send has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

Instance functions

AddSendPartyGameInvitesCompleteDelegate

function AddSendPartyGameInvitesCompleteDelegate (byte LocalUserNum, delegate<OnSendPartyGameInvitesComplete> SendPartyGameInvitesCompleteDelegate)

Sets the delegate used to notify the gameplay code that the achievements read request has completed

Parameters:

• LocalUserNum - the user to sending the invites
• SendPartyGameInvitesCompleteDelegate - the delegate to use for notifications

ClearSendPartyGameInvitesCompleteDelegate

function ClearSendPartyGameInvitesCompleteDelegate (byte LocalUserNum, delegate<OnSendPartyGameInvitesComplete> SendPartyGameInvitesCompleteDelegate)

Clears the delegate used to notify the gameplay code that the achievements read request has completed

Parameters:

• LocalUserNum - the user to sending the invites
• SendPartyGameInvitesCompleteDelegate - the delegate to use for notifications

GetPartyBandwidth

function int GetPartyBandwidth ()

Determines the amount of data that has been sent in the last second

Returns:

0 if able to get the bandwidth used over the last second, < 0 upon an error

GetPartyMemberInformation

function bool GetPartyMemberInformation (out array<OnlineSubsystem.OnlinePartyMember> PartyMembers)

Gets the party member information from the platform, including the application specific data

Parameters:

• PartyMembers - the array to be filled out of party member information

Returns:

true if the call could populate the array, false otherwise

SendPartyGameInvites

function bool SendPartyGameInvites (byte LocalUserNum)

Sends an invite to everyone in the existing party session

Parameters:

• LocalUserNum - the user to sending the invites

Returns:

true if it was able to send them, false otherwise

SetPartyMemberCustomData

function bool SetPartyMemberCustomData (byte LocalUserNum, Object.qword Data1, Object.qword Data2)

Sets a party member's application specific data

Parameters:

• LocalUserNum - the user that you are setting the data for
• Data1 - the first 8 bytes of custom data
• Data2 - the second 8 bytes of custom data

Returns:

true if the data could be set, false otherwise

ShowCommunitySessionsUI

function bool ShowCommunitySessionsUI (byte LocalUserNum)

Opens the community sessions UI for the user

Parameters:

• LocalUserNum - the user requesting the UI

ShowPartyUI

function bool ShowPartyUI (byte LocalUserNum)

Opens the party UI for the user

Parameters:

• LocalUserNum - the user requesting the UI

ShowVoiceChannelUI

function bool ShowVoiceChannelUI (byte LocalUserNum)

Opens the voice channel UI for the user

Parameters:

• LocalUserNum - the user requesting the UI