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

Engine.UIAction_JoinOnlineGame

Extends
UIAction
Modifiers
native ( inherit ) dependson ( OnlineGameSearch )

This action joins an online game based upon the search object that is bound to the UI list

Core.Object
|   
+-- Engine.SequenceObject
   |   
   +-- Engine.SequenceOp
      |   
      +-- Engine.SequenceAction
         |   
         +-- Engine.UIAction
            |   
            +-- Engine.UIAction_JoinOnlineGame

Variables Summary
boolbIsDone
boolbResult
WorldInfoCachedWorldInfo
OnlineGameSearchResultPendingGameJoin
Inherited Variables from Engine.UIAction
bAutoTargetOwner, GamepadID
Inherited Variables from Engine.SequenceAction
bCallHandler, HandlerName, Targets

Functions Summary
functionstring BuildJoinURL (string ResolvedConnectionURL))
event JoinOnlineGame (byte ControllerId, nlineGameSearchResult GameToJoin, orldInfo InWorldInfo))
function OnJoinGameComplete (bool bWasSuccessful))
Inherited Functions from Engine.UIAction
GetOwner, GetOwnerScene, IsValidLevelSequenceObject, IsValidUISequenceObject


Variables Detail

bIsDone Source code

var bool bIsDone;
Whether the latent action is done

bResult Source code

var bool bResult;
Whether there was an error or not

CachedWorldInfo Source code

var WorldInfo CachedWorldInfo;
Temporary var for accessing actor functions

PendingGameJoin Source code

var OnlineGameSearchResult PendingGameJoin;
Holds the game we are currently trying to join


Functions Detail

BuildJoinURL Source code

function string BuildJoinURL ( string ResolvedConnectionURL) )
Builds the string needed to join a game from the resolved connection: "open 172.168.0.1" NOTE: Overload this method to modify the URL before exec-ing it
@param ResolvedConnectionURL the platform specific URL information
@return the final URL to use to open the map

JoinOnlineGame Source code

event JoinOnlineGame ( byte ControllerId,OnlineGameSearchResult GameToJoin,WorldInfo InWorldInfo) )
Performs the join process by kicking off the async join for the specified game
@param ControllerId the player joining
@param GameToJoin the search results for the server to join
@param WorldInfo the world info in case an actor is needed for iteration

OnJoinGameComplete Source code

function OnJoinGameComplete ( bool bWasSuccessful) )
Handles the notification that the join completed. If successful, the session is joined, otherwise an error is shown
@param bWasSuccessful whether the async task succeeded or not


Defaultproperties

defaultproperties
{
   bAutoTargetOwner=True
   bLatentExecution=True
   bAutoActivateOutputLinks=False
   OutputLinks(0)=(LinkDesc="Failure")
   OutputLinks(1)=(LinkDesc="Success")
   ObjName="Join Online Game"
   ObjCategory="Online"
   Name="Default__UIAction_JoinOnlineGame"
   ObjectArchetype=UIAction'Engine.Default__UIAction'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:45.985 - Created with UnCodeX