UE3:OnlineEventsInterfaceMcp (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
No edit summary
Line 75: Line 75:
'''Specified by:''' {{tl|UploadProfileData|OnlineEventsInterface}}
'''Specified by:''' {{tl|UploadProfileData|OnlineEventsInterface}}


''(Description copied from {{tl|UploadProfileData|OnlineEventsInterface}})''<br/>
Sends the profile data to the server for statistics aggregation
Sends the profile data to the server for statistics aggregation


Line 97: Line 96:
* ''UniqueId'' - the unique id for the player
* ''UniqueId'' - the unique id for the player
* ''PlayerNick'' - the player's nick name  
* ''PlayerNick'' - the player's nick name  
'''Returns:'''
:true if the async task was started successfully, false otherwise
====UploadMatchmakingSearchData====
{{code|function [[bool]]&nbsp;'''UploadMatchmakingSearchData''' ({{tl|UniqueNetId|OnlineSubsystem|structs}}&nbsp;'''UniqueId''', {{cl|OnlineGameSearch}}&nbsp;'''Search''', [[int]]&nbsp;'''SelectedIndex''', const&nbsp;out&nbsp;[[array]]<{{tl|PlayerReservation|PartyBeacon}}>&nbsp;'''Players''')}}
Uploads information about the matching search
'''Parameters:'''
* ''UniqueId'' - the unique id for the player uploading
* ''Search'' - the search object that was used
* ''SelectedIndex'' - the match that was chosen
* ''Players'' - the group of players that were used to make the search
'''Returns:'''
:true if the async task was started successfully, false otherwise
====UploadMatchmakingSessionData====
{{code|function [[bool]]&nbsp;'''UploadMatchmakingSessionData''' ({{cl|OnlineGameSettings}}&nbsp;'''GameSettings''', const&nbsp;out&nbsp;[[array]]<{{tl|PlayerReservation|PartyBeacon}}>&nbsp;'''Players''')}}
Uploads information about the match session that was found
'''Parameters:'''
* ''GameSettings'' - the game settings object that was used
* ''Players'' - the group of players that were used to register the session


'''Returns:'''
'''Returns:'''
:true if the async task was started successfully, false otherwise
:true if the async task was started successfully, false otherwise

Revision as of 05:24, 17 January 2010

UDK Object >> MCPBase >> OnlineEventsInterfaceMcp
Package:
IpDrv
Implemented interfaces:
OnlineEventsInterface

Provides an in game gameplay events/stats upload mechanism via the MCP backend

Properties

bBinaryStats

Type: bool

Modifiers: const, config

if true, the stats data will be sent as a binary blob instead of XML

DisabledUploadTypes

Type: array<EEventUploadType>

Modifiers: config

A list of upload types that are disabled (don't upload)

EventUploadConfigs

Type: array<EventUploadConfig>

Modifiers: const, config

This is the array of upload task configurations

HttpPostObjects

Type: array<pointer{class FHttpDownloadString}>

Modifiers: native, const

List of HTTP downloader objects that are POSTing the data

Enums

EEventUploadType

The types of events that are to be uploaded

EUT_GenericStats
EUT_ProfileData
EUT_HardwareData
EUT_MatchmakingData

Structs

EventUploadConfig

Modifiers: native

Holds the configuration and instance data for event uploading

EEventUploadType UploadType
The type of upload this config is for
string UploadUrl
The URL to send the data to
float TimeOut
The amount of time to wait before erroring out
bool bUseCompression
Whether to compress the data before sending or not

Functions

Native functions

UploadGameplayEventsData

native function bool UploadGameplayEventsData (OnlineGameplayEvents Events)

Specified by: OnlineEventsInterface.UploadGameplayEventsData

Sends the data contained within the gameplay events object to the online server for statistics

Parameters:

  • Events - the object that has the set of events in it

Returns:

true if the async send started ok, false otherwise

UploadProfileData

native function bool UploadProfileData (OnlineSubsystem.UniqueNetId UniqueId, string PlayerNick, OnlineProfileSettings ProfileSettings)

Specified by: OnlineEventsInterface.UploadProfileData

Sends the profile data to the server for statistics aggregation

Parameters:

  • UniqueId - the unique id for the player
  • PlayerNick - the player's nick name
  • ProfileSettings - the profile object that is being sent

Returns:

true if the async task was started successfully, false otherwise

Other instance functions

UploadHardwareData

function bool UploadHardwareData (OnlineSubsystem.UniqueNetId UniqueId, string PlayerNick)

Specified by: OnlineEventsInterface.UploadHardwareData

Sends the hardware data to the online server for statistics aggregation

Parameters:

  • UniqueId - the unique id for the player
  • PlayerNick - the player's nick name

Returns:

true if the async task was started successfully, false otherwise