Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

UE3:OnlineSubsystemPC (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemPC
Package: 
OnlineSubsystemPC
Implemented interfaces
OnlinePlayerInterface, OnlineStatsInterface, OnlineSystemInterface, OnlineVoiceInterface


Properties[edit]

AsyncTasks[edit]

Type: array<pointer{FOnlineAsyncTaskPC}>

Modifiers: native, const

This is the array of pending async tasks. Each tick these tasks are checked for completion. If complete, the delegate associated with them is called

CachedProfile[edit]

Type: OnlineProfileSettings

The cached profile for the player

FriendsChangeDelegates[edit]

Type: array<delegate<OnFriendsChange> >

The array of delegates that notify that the friends list has changed

LoggedInPlayerId[edit]

Type: OnlineSubsystem.UniqueNetId

Modifiers: const

The unique id of the logged in player

LoggedInPlayerName[edit]

Type: string

Modifiers: const

The name of the player that is logged in

Default value: "Player1"

MutingChangeDelegates[edit]

Type: array<delegate<OnMutingChange> >

The array of delegates that notify that the mute list has changed

ProfileDataDirectory[edit]

Type: string

Modifiers: config

The directory profile data should be stored in

ProfileDataExtension[edit]

Type: string

Modifiers: config

The file extension to use when saving profile data

ReadFriendsDelegates[edit]

Type: array<delegate<OnReadFriendsComplete> >

The array of delegates that notify read completion of the friends list data

ReadProfileSettingsDelegates[edit]

Type: array<delegate<OnReadProfileSettingsComplete> >

The array of delegates that notify read completion of profile data

SpeechRecognitionCompleteDelegates[edit]

Type: array<delegate<OnRecognitionComplete> >

List of callbacks to notify when speech recognition is complete

WriteProfileSettingsDelegates[edit]

Type: array<delegate<OnWriteProfileSettingsComplete> >

The array of delegates that notify write completion of profile data

Delegates[edit]

See OnlineSubsystemPC delegates.

Functions[edit]

Native functions[edit]

Init[edit]

native event bool Init ()

Overrides: OnlineSubsystem.Init

Called from engine start up code to allow the subsystem to initialize

Returns:

TRUE if the initialization was successful, FALSE otherwise

ReadProfileSettings[edit]

native function bool ReadProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Specified by: OnlinePlayerInterface.ReadProfileSettings

Reads the online profile settings for a given user

Parameters:

  • LocalUserNum - the user that we are reading the data for
  • ProfileSettings - the object to copy the results to and contains the list of items to read

Returns:

true if the call succeeds, false otherwise

WriteProfileSettings[edit]

native function bool WriteProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Specified by: OnlinePlayerInterface.WriteProfileSettings

Writes the online profile settings for a given user to the online data store

Parameters:

  • LocalUserNum - the user that we are writing the data for
  • ProfileSettings - the list of settings to write out

Returns:

true if the call succeeds, false otherwise

Events[edit]

GetPlayerNicknameFromIndex[edit]

event string GetPlayerNicknameFromIndex (int UserIndex)

Overrides: OnlineSubsystemCommonImpl.GetPlayerNicknameFromIndex

Returns the name of the player for the specified index

Parameters:

  • UserIndex - the user to return the name of

Returns:

the name of the player at the specified index

GetPlayerUniqueNetIdFromIndex[edit]

event OnlineSubsystem.UniqueNetId GetPlayerUniqueNetIdFromIndex (int UserIndex)

Overrides: OnlineSubsystemCommonImpl.GetPlayerUniqueNetIdFromIndex

Returns the unique id of the player for the specified index

Parameters:

  • UserIndex - the user to return the id of

Returns:

the unique id of the player at the specified index

Other instance functions[edit]

See OnlineSubsystemPC instance functions.