Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

IpDrv.OnlineGameInterfaceImpl

Extends
Object
Modifiers
within OnlineSubsystemCommonImpl native implements ( OnlineGameInterface ) config ( Engine )

Class that implements a cross platform version of the game interface

Core.Object
|   
+-- IpDrv.OnlineGameInterfaceImpl

Direct Known Subclasses:

OnlineGameInterfaceSteamworks

Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
array<delegate<OnCancelFindOnlineGamesComplete>>CancelFindOnlineGamesCompleteDelegates
array<delegate<OnCreateOnlineGameComplete>>CreateOnlineGameCompleteDelegates
EOnlineGameStateCurrentGameState
array<delegate<OnDestroyOnlineGameComplete>>DestroyOnlineGameCompleteDelegates
array<delegate<OnEndOnlineGameComplete>>EndOnlineGameCompleteDelegates
array<delegate<OnFindOnlineGamesComplete>>FindOnlineGamesCompleteDelegates
OnlineGameSearchGameSearch
OnlineGameSettingsGameSettings
array<delegate<OnJoinMigratedOnlineGameComplete>>JoinMigratedOnlineGameCompleteDelegates
array<delegate<OnJoinOnlineGameComplete>>JoinOnlineGameCompleteDelegates
intLanAnnouncePort
pointerLanBeacon
ELanBeaconStateLanBeaconState
intLanGameUniqueId
byteLanNonce[8]
intLanPacketPlatformMask
floatLanQueryTimeLeft
floatLanQueryTimeout
array<delegate<OnMigrateOnlineGameComplete>>MigrateOnlineGameCompleteDelegates
OnlineSubsystemCommonImplOwningSubsystem
array<delegate<OnRecalculateSkillRatingComplete>>RecalculateSkillRatingCompleteDelegates
pointerSessionInfo
array<delegate<OnStartOnlineGameComplete>>StartOnlineGameCompleteDelegates
array<delegate<OnUpdateOnlineGameComplete>>UpdateOnlineGameCompleteDelegates
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Delegates Summary
delegate OnArbitrationRegistrationComplete (name SessionName, ool bWasSuccessful)
delegate OnCancelFindOnlineGamesComplete (bool bWasSuccessful)
delegate OnCreateOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnDestroyOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnEndOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnFindOnlineGamesComplete (bool bWasSuccessful)
delegate OnGameInviteAccepted (const out OnlineGameSearchResult InviteResult)
delegate OnJoinMigratedOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnJoinOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnMigrateOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnQosStatusChanged (int NumComplete, nt NumTotal)
delegate OnRecalculateSkillRatingComplete (name SessionName, ool bWasSuccessful)
delegate OnRegisterPlayerComplete (name SessionName, niqueNetId PlayerId, ool bWasSuccessful)
delegate OnStartOnlineGameComplete (name SessionName, ool bWasSuccessful)
delegate OnUnregisterPlayerComplete (name SessionName, niqueNetId PlayerId, ool bWasSuccessful)
delegate OnUpdateOnlineGameComplete (name SessionName, ool bWasSuccessful)

Functions Summary
functionbool AcceptGameInvite (byte LocalUserNum, ame SessionName)
function AddArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)
function AddCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate))
function AddCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate))
function AddDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate))
function AddEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate))
function AddFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate))
function AddGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)
function AddJoinMigratedOnlineGameCompleteDelegate (delegate<OnJoinMigratedOnlineGameComplete> JoinMigratedOnlineGameCompleteDelegate))
function AddJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate))
function AddMigrateOnlineGameCompleteDelegate (delegate<OnMigrateOnlineGameComplete> MigrateOnlineGameCompleteDelegate)
function AddQosStatusChangedDelegate (delegate<OnQosStatusChanged> QosStatusChangedDelegate)
function AddRecalculateSkillRatingCompleteDelegate (delegate<OnRecalculateSkillRatingComplete> RecalculateSkillRatingCompleteDelegate)
function AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)
function AddStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate))
function AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)
function AddUpdateOnlineGameCompleteDelegate (delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate))
functionbool BindPlatformSpecificSessionToSearch (byte SearchingPlayerNum, nlineGameSearch SearchSettings, yte PlatformSpecificInfo[80])
functionbool CancelFindOnlineGames ()
function ClearArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)
function ClearCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate))
function ClearCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate))
function ClearDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate))
function ClearEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate))
function ClearFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate))
function ClearGameInviteAcceptedDelegate (byte LocalUserNum, elegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)
function ClearJoinMigratedOnlineGameCompleteDelegate (delegate<OnJoinMigratedOnlineGameComplete> JoinMigratedOnlineGameCompleteDelegate))
function ClearJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate))
function ClearMigrateOnlineGameCompleteDelegate (delegate<OnMigrateOnlineGameComplete> MigrateOnlineGameCompleteDelegate)
function ClearQosStatusChangedDelegate (delegate<OnQosStatusChanged> QosStatusChangedDelegate)
function ClearRecalculateSkillRatingCompleteDelegate (delegate<OnRecalculateSkillRatingComplete> RecalculateSkillRatingGameCompleteDelegate)
function ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)
function ClearStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate))
function ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)
function ClearUpdateOnlineGameCompleteDelegate (delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate))
functionbool CreateOnlineGame (byte HostingPlayerNum, ame SessionName, nlineGameSettings NewGameSettings)
functionbool DestroyOnlineGame (name SessionName)
functionbool EndOnlineGame (name SessionName)
functionbool FindOnlineGames (byte SearchingPlayerNum, nlineGameSearch SearchSettings)
functionbool FreeSearchResults (OnlineGameSearch Search)
functionarray<OnlineArbitrationRegistrant> GetArbitratedPlayers (name SessionName)
functionOnlineGameSearch GetGameSearch ()))
functionOnlineGameSettings GetGameSettings (name SessionName))
functionbool GetResolvedConnectString (name SessionName, ut string ConnectInfo)
functionbool JoinMigratedOnlineGame (byte PlayerNum, ame SessionName, onst out OnlineGameSearchResult DesiredGame)
functionbool JoinOnlineGame (byte PlayerNum, ame SessionName, onst out OnlineGameSearchResult DesiredGame)
functionbool MigrateOnlineGame (byte HostingPlayerNum, ame SessionName)
functionbool QueryNonAdvertisedData (int StartAt, nt NumberToQuery)
functionbool ReadPlatformSpecificSessionInfo (const out OnlineGameSearchResult DesiredGame, ut byte PlatformSpecificInfo[80])
functionbool ReadPlatformSpecificSessionInfoBySessionName (name SessionName, ut byte PlatformSpecificInfo[80])
functionbool RecalculateSkillRating (name SessionName, onst out array<UniqueNetId> Players)
functionbool RegisterForArbitration (name SessionName)
functionbool RegisterPlayer (name SessionName, niqueNetId PlayerId, ool bWasInvited)
functionbool RegisterPlayers (name SessionName, onst out array<UniqueNetId> Players)
functionbool StartOnlineGame (name SessionName)
functionbool UnregisterPlayer (name SessionName, niqueNetId PlayerId)
functionbool UnregisterPlayers (name SessionName, onst out array<UniqueNetId> Players)
functionbool UpdateOnlineGame (name SessionName, nlineGameSettings UpdatedGameSettings, ptional bool bShouldRefreshOnlineData = false)
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=


Variables Detail

CancelFindOnlineGamesCompleteDelegates Source code

var array<delegate<OnCancelFindOnlineGamesComplete>> CancelFindOnlineGamesCompleteDelegates;
Array of delegates to multicast with for game search notification

CreateOnlineGameCompleteDelegates Source code

var array<delegate<OnCreateOnlineGameComplete>> CreateOnlineGameCompleteDelegates;
Array of delegates to multicast with for game creation notification

CurrentGameState Source code

var const EOnlineGameState CurrentGameState;
The current game state as the Live layer understands it

DestroyOnlineGameCompleteDelegates Source code

var array<delegate<OnDestroyOnlineGameComplete>> DestroyOnlineGameCompleteDelegates;
Array of delegates to multicast with for game destruction notification

EndOnlineGameCompleteDelegates Source code

var array<delegate<OnEndOnlineGameComplete>> EndOnlineGameCompleteDelegates;
Array of delegates to multicast with for game ending notification

FindOnlineGamesCompleteDelegates Source code

var array<delegate<OnFindOnlineGamesComplete>> FindOnlineGamesCompleteDelegates;
Array of delegates to multicast with for game search notification

GameSearch Source code

var const OnlineGameSearch GameSearch;
The current game search object in use

GameSettings Source code

var const OnlineGameSettings GameSettings;
The current game settings object in use

JoinMigratedOnlineGameCompleteDelegates Source code

var array<delegate<OnJoinMigratedOnlineGameComplete>> JoinMigratedOnlineGameCompleteDelegates;
Array of delegates to multicast with for migrated game join notification

JoinOnlineGameCompleteDelegates Source code

var array<delegate<OnJoinOnlineGameComplete>> JoinOnlineGameCompleteDelegates;
Array of delegates to multicast with for game join notification

LanAnnouncePort Source code

var const config int LanAnnouncePort;
Port to listen on for LAN queries/responses

LanBeacon Source code

var const native transient pointer LanBeacon;
LAN announcement socket used to send/receive discovery packets

LanBeaconState Source code

var const ELanBeaconState LanBeaconState;
The current state the lan beacon is in

LanGameUniqueId Source code

var const config int LanGameUniqueId;
Unique id to keep UE3 games from seeing each others' lan packets

LanNonce[8] Source code

var const byte LanNonce[8];
Used by a client to uniquely identify itself during lan match discovery

LanPacketPlatformMask Source code

var const config int LanPacketPlatformMask;
Mask containing which platforms can cross communicate

LanQueryTimeLeft Source code

var float LanQueryTimeLeft;
The amount of time before the lan query is considered done

LanQueryTimeout Source code

var config float LanQueryTimeout;
The amount of time to wait before timing out a lan query request

MigrateOnlineGameCompleteDelegates Source code

var array<delegate<OnMigrateOnlineGameComplete>> MigrateOnlineGameCompleteDelegates;
Array of delegates to multicast with for game migration notification

OwningSubsystem Source code

var OnlineSubsystemCommonImpl OwningSubsystem;
The owning subsystem that this object is providing an implementation for

RecalculateSkillRatingCompleteDelegates Source code

var array<delegate<OnRecalculateSkillRatingComplete>> RecalculateSkillRatingCompleteDelegates;
Array of delegates to multicast with for skill rating update notification

SessionInfo Source code

var native const transient private pointer SessionInfo;
The session information used to connect to a host

StartOnlineGameCompleteDelegates Source code

var array<delegate<OnStartOnlineGameComplete>> StartOnlineGameCompleteDelegates;
Array of delegates to multicast with for game starting notification

UpdateOnlineGameCompleteDelegates Source code

var array<delegate<OnUpdateOnlineGameComplete>> UpdateOnlineGameCompleteDelegates;
Array of delegates to multicast with for game update notification


Delegates Detail

OnArbitrationRegistrationComplete Source code

delegate OnArbitrationRegistrationComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when the online game has completed registration for arbitration
@param SessionName the name of the session the that had arbitration pending
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnCancelFindOnlineGamesComplete Source code

delegate OnCancelFindOnlineGamesComplete ( bool bWasSuccessful )
Delegate fired when the cancellation of a search for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnCreateOnlineGameComplete Source code

delegate OnCreateOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when a create request has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnDestroyOnlineGameComplete Source code

delegate OnDestroyOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when a destroying an online game has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnEndOnlineGameComplete Source code

delegate OnEndOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when the online game has transitioned to the ending game state
@param SessionName the name of the session the that was ended
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnFindOnlineGamesComplete Source code

delegate OnFindOnlineGamesComplete ( bool bWasSuccessful )
Delegate fired when the search for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnGameInviteAccepted Source code

delegate OnGameInviteAccepted ( const out OnlineGameSearchResult InviteResult )
Called when a user accepts a game invitation. Allows the gameplay code a chance to clean up any existing state before accepting the invite. The invite must be accepted by calling AcceptGameInvite() on the OnlineGameInterface after clean up has completed
@param InviteResult the search/settings for the game we're joining via invite

OnJoinMigratedOnlineGameComplete Source code

delegate OnJoinMigratedOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when the joing process for a migrated online game has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnJoinOnlineGameComplete Source code

delegate OnJoinOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when the joing process for an online game has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnMigrateOnlineGameComplete Source code

delegate OnMigrateOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when a create request has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnQosStatusChanged Source code

delegate OnQosStatusChanged ( int NumComplete,int NumTotal )
Delegate fired when QoS status has changed for a given search
@param NumComplete the number completed thus far
@param NumTotal the number of QoS requests total

OnRecalculateSkillRatingComplete Source code

delegate OnRecalculateSkillRatingComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when a skill rating request has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnRegisterPlayerComplete Source code

delegate OnRegisterPlayerComplete ( name SessionName,UniqueNetId PlayerId,bool bWasSuccessful )
Delegate fired when the registration process has completed
@param SessionName the name of the session the player joined or not
@param PlayerId the player that was unregistered from the online service
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnStartOnlineGameComplete Source code

delegate OnStartOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when the online game has transitioned to the started state
@param SessionName the name of the session the that has transitioned to started
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnUnregisterPlayerComplete Source code

delegate OnUnregisterPlayerComplete ( name SessionName,UniqueNetId PlayerId,bool bWasSuccessful )
Delegate fired when the unregistration process has completed
@param SessionName the name of the session the player left
@param PlayerId the player that was unregistered from the online service
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnUpdateOnlineGameComplete Source code

delegate OnUpdateOnlineGameComplete ( name SessionName,bool bWasSuccessful )
Delegate fired when a update request has completed
@param SessionName the name of the session this callback is for
@param bWasSuccessful true if the async action completed without error, false if there was an error


Functions Detail

AcceptGameInvite Source code

function bool AcceptGameInvite ( byte LocalUserNum,name SessionName )
Tells the online subsystem to accept the game invite that is currently pending
@param LocalUserNum the local user accepting the invite
@param SessionName the name of the session this invite is to be known as
@return true if the game invite was able to be accepted, false otherwise

AddArbitrationRegistrationCompleteDelegate Source code

function AddArbitrationRegistrationCompleteDelegate ( delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate )
Sets the notification callback to use when arbitration registration has completed
@param ArbitrationRegistrationCompleteDelegate the delegate to use for notifications

AddCancelFindOnlineGamesCompleteDelegate Source code

function AddCancelFindOnlineGamesCompleteDelegate ( delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate) )
Adds the delegate to the list to notify with
@param CancelFindOnlineGamesCompleteDelegate the delegate to use for notifications

AddCreateOnlineGameCompleteDelegate Source code

function AddCreateOnlineGameCompleteDelegate ( delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process
@param CreateOnlineGameCompleteDelegate the delegate to use for notifications

AddDestroyOnlineGameCompleteDelegate Source code

function AddDestroyOnlineGameCompleteDelegate ( delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the online game they destroyed has completed the destruction process
@param DestroyOnlineGameCompleteDelegate the delegate to use for notifications

AddEndOnlineGameCompleteDelegate Source code

function AddEndOnlineGameCompleteDelegate ( delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the online game has transitioned to the ending state.
@param EndOnlineGameCompleteDelegate the delegate to use for notifications

AddFindOnlineGamesCompleteDelegate Source code

function AddFindOnlineGamesCompleteDelegate ( delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate) )
Adds the delegate used to notify the gameplay code that the search they kicked off has completed
@param FindOnlineGamesCompleteDelegate the delegate to use for notifications

AddGameInviteAcceptedDelegate Source code

function AddGameInviteAcceptedDelegate ( byte LocalUserNum,delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate )
Sets the delegate used to notify the gameplay code when a game invite has been accepted
@param LocalUserNum the user to request notification for
@param GameInviteAcceptedDelegate the delegate to use for notifications

AddJoinMigratedOnlineGameCompleteDelegate Source code

function AddJoinMigratedOnlineGameCompleteDelegate ( delegate<OnJoinMigratedOnlineGameComplete> JoinMigratedOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the join request for a migrated session they kicked off has completed
@param JoinMigratedOnlineGameCompleteDelegate the delegate to use for notifications

AddJoinOnlineGameCompleteDelegate Source code

function AddJoinOnlineGameCompleteDelegate ( delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the join request they kicked off has completed
@param JoinOnlineGameCompleteDelegate the delegate to use for notifications

AddMigrateOnlineGameCompleteDelegate Source code

function AddMigrateOnlineGameCompleteDelegate ( delegate<OnMigrateOnlineGameComplete> MigrateOnlineGameCompleteDelegate )
Sets the delegate used to notify the gameplay code when the session migration completes
@param MigrateOnlineGameCompleteDelegate the delegate to use for notifications

AddQosStatusChangedDelegate Source code

function AddQosStatusChangedDelegate ( delegate<OnQosStatusChanged> QosStatusChangedDelegate )
Adds a delegate to the list of objects that want to be notified
@param QosStatusChangedDelegate the delegate to use for notifications

AddRecalculateSkillRatingCompleteDelegate Source code

function AddRecalculateSkillRatingCompleteDelegate ( delegate<OnRecalculateSkillRatingComplete> RecalculateSkillRatingCompleteDelegate )
Adds a delegate to the list of objects that want to be notified
@param RecalculateSkillRatingCompleteDelegate the delegate to use for notifications

AddRegisterPlayerCompleteDelegate Source code

function AddRegisterPlayerCompleteDelegate ( delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate )
Sets the delegate used to notify the gameplay code that the player registration request they submitted has completed
@param RegisterPlayerCompleteDelegate the delegate to use for notifications

AddStartOnlineGameCompleteDelegate Source code

function AddStartOnlineGameCompleteDelegate ( delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the online game has transitioned to the started state.
@param StartOnlineGameCompleteDelegate the delegate to use for notifications

AddUnregisterPlayerCompleteDelegate Source code

function AddUnregisterPlayerCompleteDelegate ( delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate )
Sets the delegate used to notify the gameplay code that the player unregistration request they submitted has completed
@param UnregisterPlayerCompleteDelegate the delegate to use for notifications

AddUpdateOnlineGameCompleteDelegate Source code

function AddUpdateOnlineGameCompleteDelegate ( delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate) )
Adds a delegate to the list of objects that want to be notified
@param UpdateOnlineGameCompleteDelegate the delegate to use for notifications

BindPlatformSpecificSessionToSearch Source code

native function bool BindPlatformSpecificSessionToSearch ( byte SearchingPlayerNum,OnlineGameSearch SearchSettings,byte PlatformSpecificInfo[80] )
Creates a search result out of the platform specific data and adds that to the specified search object
@param SearchingPlayerNum the index of the player searching for a match
@param SearchSettings the desired search to bind the session to
@param PlatformSpecificInfo the platform specific information to convert to a server object
@return true if successful searching for sessions, false otherwise

CancelFindOnlineGames Source code

native function bool CancelFindOnlineGames ( )
Cancels the current search in progress if possible for that search type
@return true if successful searching for sessions, false otherwise

ClearArbitrationRegistrationCompleteDelegate Source code

function ClearArbitrationRegistrationCompleteDelegate ( delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate )
Removes the specified delegate from the notification list
@param ArbitrationRegistrationCompleteDelegate the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate Source code

function ClearCancelFindOnlineGamesCompleteDelegate ( delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate) )
Removes the delegate from the notify list
@param CancelFindOnlineGamesCompleteDelegate the delegate to use for notifications

ClearCreateOnlineGameCompleteDelegate Source code

function ClearCreateOnlineGameCompleteDelegate ( delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate) )
Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process
@param CreateOnlineGameCompleteDelegate the delegate to use for notifications

ClearDestroyOnlineGameCompleteDelegate Source code

function ClearDestroyOnlineGameCompleteDelegate ( delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate) )
Removes the delegate from the notification list
@param DestroyOnlineGameCompleteDelegate the delegate to use for notifications

ClearEndOnlineGameCompleteDelegate Source code

function ClearEndOnlineGameCompleteDelegate ( delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate) )
Removes the delegate from the notify list
@param EndOnlineGameCompleteDelegate the delegate to use for notifications

ClearFindOnlineGamesCompleteDelegate Source code

function ClearFindOnlineGamesCompleteDelegate ( delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate) )
Removes the delegate from the notify list
@param FindOnlineGamesCompleteDelegate the delegate to use for notifications

ClearGameInviteAcceptedDelegate Source code

function ClearGameInviteAcceptedDelegate ( byte LocalUserNum,delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate )
Removes the specified delegate from the notification list
@param LocalUserNum the user to request notification for
@param GameInviteAcceptedDelegate the delegate to use for notifications

ClearJoinMigratedOnlineGameCompleteDelegate Source code

function ClearJoinMigratedOnlineGameCompleteDelegate ( delegate<OnJoinMigratedOnlineGameComplete> JoinMigratedOnlineGameCompleteDelegate) )
Removes the delegate from the list of notifications
@param JoinMigratedOnlineGameCompleteDelegate the delegate to use for notifications

ClearJoinOnlineGameCompleteDelegate Source code

function ClearJoinOnlineGameCompleteDelegate ( delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate) )
Removes the delegate from the notify list
@param JoinOnlineGameCompleteDelegate the delegate to use for notifications

ClearMigrateOnlineGameCompleteDelegate Source code

function ClearMigrateOnlineGameCompleteDelegate ( delegate<OnMigrateOnlineGameComplete> MigrateOnlineGameCompleteDelegate )
Removes the delegate from the list of notifications
@param MigrateOnlineGameCompleteDelegate the delegate to use for notifications

ClearQosStatusChangedDelegate Source code

function ClearQosStatusChangedDelegate ( delegate<OnQosStatusChanged> QosStatusChangedDelegate )
Removes the delegate from the list of notifications
@param QosStatusChangedDelegate the delegate to use for notifications

ClearRecalculateSkillRatingCompleteDelegate Source code

function ClearRecalculateSkillRatingCompleteDelegate ( delegate<OnRecalculateSkillRatingComplete> RecalculateSkillRatingGameCompleteDelegate )
Removes a delegate from the list of objects that want to be notified
@param RecalculateSkillRatingCompleteDelegate the delegate to use for notifications

ClearRegisterPlayerCompleteDelegate Source code

function ClearRegisterPlayerCompleteDelegate ( delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate )
Removes the delegate from the notify list
@param RegisterPlayerCompleteDelegate the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate Source code

function ClearStartOnlineGameCompleteDelegate ( delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate) )
Removes the delegate from the notify list
@param StartOnlineGameCompleteDelegate the delegate to use for notifications

ClearUnregisterPlayerCompleteDelegate Source code

function ClearUnregisterPlayerCompleteDelegate ( delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate )
Removes the delegate from the notify list
@param UnregisterPlayerCompleteDelegate the delegate to use for notifications

ClearUpdateOnlineGameCompleteDelegate Source code

function ClearUpdateOnlineGameCompleteDelegate ( delegate<OnUpdateOnlineGameComplete> UpdateOnlineGameCompleteDelegate) )
Removes a delegate from the list of objects that want to be notified
@param UpdateOnlineGameCompleteDelegate the delegate to use for notifications

CreateOnlineGame Source code

native function bool CreateOnlineGame ( byte HostingPlayerNum,name SessionName,OnlineGameSettings NewGameSettings )
Creates an online game based upon the settings object specified. NOTE: online game registration is an async process and does not complete until the OnCreateOnlineGameComplete delegate is called.
@param HostingPlayerNum the index of the player hosting the match
@param SessionName the name to use for this session so that multiple sessions can exist at the same time
@param NewGameSettings the settings to use for the new game session
@return true if successful creating the session, false otherwise

DestroyOnlineGame Source code

native function bool DestroyOnlineGame ( name SessionName )
Destroys the current online game NOTE: online game de-registration is an async process and does not complete until the OnDestroyOnlineGameComplete delegate is called.
@param SessionName the name of the session to delete
@return true if successful destroying the session, false otherwsie

EndOnlineGame Source code

native function bool EndOnlineGame ( name SessionName )
Marks an online game as having been ended
@param SessionName the name of the session the to end
@return true if the call succeeds, false otherwise

FindOnlineGames Source code

native function bool FindOnlineGames ( byte SearchingPlayerNum,OnlineGameSearch SearchSettings )
Searches for games matching the settings specified
@param SearchingPlayerNum the index of the player searching for a match
@param SearchSettings the desired settings that the returned sessions will have
@return true if successful searching for sessions, false otherwise

FreeSearchResults Source code

native function bool FreeSearchResults ( OnlineGameSearch Search )
Cleans up any platform specific allocated data contained in the search results
@param Search the object to free search results for
@return true if successful, false otherwise

GetArbitratedPlayers Source code

function array<OnlineArbitrationRegistrant> GetArbitratedPlayers ( name SessionName )
Returns the list of arbitrated players for the arbitrated session
@param SessionName the name of the session to get the arbitration results for
@return the list of players that are registered for this session

GetGameSearch Source code

function OnlineGameSearch GetGameSearch ( ) )
Returns the currently set game search object

GetGameSettings Source code

function OnlineGameSettings GetGameSettings ( name SessionName) )
Returns the game settings object for the session with a matching name
@param SessionName the name of the session to return
@return the game settings for this session name

GetResolvedConnectString Source code

native function bool GetResolvedConnectString ( name SessionName,out string ConnectInfo )
Returns the platform specific connection information for joining the match. Call this function from the delegate of join completion
@param SessionName the name of the session to fetch the connection information for
@param ConnectInfo the out var containing the platform specific connection information
@return true if the call was successful, false otherwise

JoinMigratedOnlineGame Source code

function bool JoinMigratedOnlineGame ( byte PlayerNum,name SessionName,const out OnlineGameSearchResult DesiredGame )
Joins the migrated game specified
@param PlayerNum the index of the player about to join a match
@param SessionName the name of the migrated session to join
@param DesiredGame the desired migrated game to join
@return true if the call completed successfully, false otherwise

JoinOnlineGame Source code

native function bool JoinOnlineGame ( byte PlayerNum,name SessionName,const out OnlineGameSearchResult DesiredGame )
Joins the game specified
@param PlayerNum the index of the player searching for a match
@param SessionName the name of the session to join
@param DesiredGame the desired game to join
@return true if the call completed successfully, false otherwise

MigrateOnlineGame Source code

function bool MigrateOnlineGame ( byte HostingPlayerNum,name SessionName )
Migrates an existing online game on the host. NOTE: online game migration is an async process and does not complete until the OnMigrateOnlineGameComplete delegate is called.
@param HostingPlayerNum the index of the player now hosting the match
@param SessionName the name of the existing session to migrate
@return true if successful migrating the session, false otherwise

QueryNonAdvertisedData Source code

function bool QueryNonAdvertisedData ( int StartAt,int NumberToQuery )
Fetches the additional data a session exposes outside of the online service. NOTE: notifications will come from the OnFindOnlineGamesComplete delegate
@param StartAt the search result index to start gathering the extra information for
@param NumberToQuery the number of additional search results to get the data for
@return true if the query was started, false otherwise

ReadPlatformSpecificSessionInfo Source code

native function bool ReadPlatformSpecificSessionInfo ( const out OnlineGameSearchResult DesiredGame,out byte PlatformSpecificInfo[80] )
Serializes the platform specific data into the provided buffer for the specified search result
@param DesiredGame the game to copy the platform specific data for
@param PlatformSpecificInfo the buffer to fill with the platform specific information
@return true if successful serializing the data, false otherwise

ReadPlatformSpecificSessionInfoBySessionName Source code

function bool ReadPlatformSpecificSessionInfoBySessionName ( name SessionName,out byte PlatformSpecificInfo[80] )
Serializes the platform specific data into the provided buffer for the specified settings object. NOTE: This can only be done for a session that is bound to the online system
@param GameSettings the game to copy the platform specific data for
@param PlatformSpecificInfo the buffer to fill with the platform specific information
@return true if successful reading the data for the session, false otherwise

RecalculateSkillRating Source code

function bool RecalculateSkillRating ( name SessionName,const out array<UniqueNetId> Players )
Updates the current session's skill rating using the list of players' skills
@param SessionName the name of the session to update the skill rating for
@param Players the set of players to use in the skill calculation
@return true if the update succeeded, false otherwise

RegisterForArbitration Source code

function bool RegisterForArbitration ( name SessionName )
Tells the game to register with the underlying arbitration server if available
@param SessionName the name of the session to register for arbitration with

RegisterPlayer Source code

function bool RegisterPlayer ( name SessionName,UniqueNetId PlayerId,bool bWasInvited )
Registers a player with the online service as being part of the online game
@param SessionName the name of the session the player is joining
@param UniquePlayerId the player to register with the online service
@param bWasInvited whether the player was invited to the game or searched for it
@return true if the call succeeds, false otherwise

RegisterPlayers Source code

function bool RegisterPlayers ( name SessionName,const out array<UniqueNetId> Players )
Registers a group of players with the online service as being part of the online game
@param SessionName the name of the session the player is joining
@param Players the list of players to register with the online service
@return true if the call succeeds, false otherwise

StartOnlineGame Source code

native function bool StartOnlineGame ( name SessionName )
Marks an online game as in progress (as opposed to being in lobby or pending)
@param SessionName the name of the session that is being started
@return true if the call succeeds, false otherwise

UnregisterPlayer Source code

function bool UnregisterPlayer ( name SessionName,UniqueNetId PlayerId )
Unregisters a player with the online service as being part of the online game
@param SessionName the name of the session the player is leaving
@param PlayerId the player to unregister with the online service
@return true if the call succeeds, false otherwise

UnregisterPlayers Source code

function bool UnregisterPlayers ( name SessionName,const out array<UniqueNetId> Players )
Unregisters a group of players with the online service as being part of the online game
@param SessionName the name of the session the player is joining
@param Players the list of players to unregister with the online service
@return true if the call succeeds, false otherwise

UpdateOnlineGame Source code

function bool UpdateOnlineGame ( name SessionName,OnlineGameSettings UpdatedGameSettings,optional bool bShouldRefreshOnlineData = false )
Updates the localized settings/properties for the game in question. Updates the QoS packet if needed (starting & restarting QoS).
@param SessionName the name of the session to update
@param UpdatedGameSettings the object to update the game settings with
@param bShouldRefreshOnlineData whether to submit the data to the backend or not
@return true if successful creating the session, false otherwsie



Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:53.422 - Created with UnCodeX