Always snap to grid
UE3:UIAction_JoinOnlineGame (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> SequenceObject >> SequenceOp >> SequenceAction >> UIAction >> UIAction_JoinOnlineGame |
- Package:
- Engine
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
This action joins an online game based upon the search object that is bound to the UI list
Properties[edit]
bIsDone[edit]
Type: bool
Whether the latent action is done
bResult[edit]
Type: bool
Whether there was an error or not
CachedWorldInfo[edit]
Type: WorldInfo
Temporary var for accessing actor functions
PendingGameJoin[edit]
Type: OnlineGameSearch.OnlineGameSearchResult
Holds the game we are currently trying to join
Default values[edit]
| Property | Value | ||||
|---|---|---|---|---|---|
| bAutoActivateOutputLinks | False | ||||
| bAutoTargetOwner | True | ||||
| bLatentExecution | True | ||||
| ObjCategory | "Online" | ||||
| ObjName | "Join Online Game" | ||||
| OutputLinks[0] |
|
||||
| OutputLinks[1] |
|
Functions[edit]
Events[edit]
JoinOnlineGame[edit]
event JoinOnlineGame (byte ControllerId, OnlineGameSearch.OnlineGameSearchResult GameToJoin, WorldInfo InWorldInfo)
Performs the join process by kicking off the async join for the specified game
Parameters:
- ControllerId - the player joining
- GameToJoin - the search results for the server to join
- WorldInfo - the world info in case an actor is needed for iteration
Other instance functions[edit]
BuildJoinURL[edit]
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
Parameters:
- ResolvedConnectionURL - the platform specific URL information
Returns:
- the final URL to use to open the map
OnJoinGameComplete[edit]
function OnJoinGameComplete (bool bWasSuccessful)
Handles the notification that the join completed. If successful, the session is joined, otherwise an error is shown
Parameters:
- bWasSuccessful - whether the async task succeeded or not
