UE3:OnlineSubsystemGameSpy (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search
UT3 Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemGameSpy
Package: 
OnlineSubsystemGameSpy
Implemented interfaces
OnlineAccountInterface, OnlineNewsInterface, OnlinePlayerInterface, OnlinePlayerInterfaceEx, OnlineStatsInterface, OnlineSystemInterface, OnlineVoiceInterface

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

See OnlineSubsystemGameSpy properties.

Enums

EMuteType

The types of global muting we support

MUTE_None 
MUTE_AllButFriends 
MUTE_All 

Structs

ControllerConnectionState

Modifiers: native

Struct to hold current and previous frame's game state

int bIsControllerConnected 
Whether the controller is connected or not
int bLastIsControllerConnected 
Last frame's version of the above

LocalTalkerGS

Extends: OnlineSubsystem.LocalTalker

Modifiers: native

Adds to the local talker definition so we can support muting

EMuteType MuteType 

OnlineStatusMapping

Modifiers: native

Holds the items used to map an online status string to its format string

int StatusId 
The id of the status string
string StatusString 
The format string to use to apply the passed in properties/strings

PendingPlayerStats

Modifiers: native

This stores the stats for a single player before being written out to the backend

OnlineSubsystem.UniqueNetId Player 
The player for which stats are being written
string PlayerName 
The name of the player to report with
string StatGuid 
This is a per-player guid that needs to be passed to the backend
array<PlayerStat> Stats 
The stats for this player
OnlineSubsystem.OnlinePlayerScore Score 
The score for this player
string Place 
This player's place when sorted against the other players. Calculated at reporting time

PerUserDelegateLists

Modifiers: native

Since the static array of dynamic array syntax appears to be broken

array<delegate<OnUnlockAchievementComplete> > AchievementDelegates 
The array of delegates for notifying when an achievement write has completed

PerUserProfileDelegates

Modifiers: native

array<delegate<OnReadProfileSettingsComplete> > Delegates 
The array of delegates that notify read completion of profile data

PlayerStat

Modifiers: native

This holds a single stat waiting to be written out

int KeyId 
The GameSpy key for this stat
Settings.SettingsData Data 
The stat's value

ViewPropertyToKeyId

Modifiers: native

Maps a view and property to a gamespy stats key If only PropertyId is 0, then this is the KeyId for the View itself

int ViewId 
The id of the view
int PropertyId 
The id of the property
int KeyId 
The id of the gamespy stats key

Delegates

See OnlineSubsystemGameSpy delegates.

Functions

Native functions

See OnlineSubsystemGameSpy native functions.

Events

GetPlayerNicknameFromIndex

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

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

See OnlineSubsystemGameSpy instance functions.