My Project
Loading...
Searching...
No Matches
Public Attributes | List of all members
PlayFab.MultiplayerModels.RequestMultiplayerServerRequest Class Reference

Requests a multiplayer server session from a particular build in any of the given preferred regions. More...

Inheritance diagram for PlayFab.MultiplayerModels.RequestMultiplayerServerRequest:
PlayFab.SharedModels.PlayFabRequestCommon PlayFab.SharedModels.PlayFabBaseModel

Public Attributes

BuildAliasParams BuildAliasParams
 The identifiers of the build alias to use for the request.
 
string BuildId
 The guid string build ID of the multiplayer server to request.
 
Dictionary< string, string > CustomTags
 The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
 
List< string > InitialPlayers
 Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server when requested (via GSDK) and can be used to validate players connecting to it.
 
List< string > PreferredRegions
 The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in the specified order and allocate a server from the first one that has servers available.
 
string SessionCookie
 Data encoded as a string that is passed to the game server when requested. This can be used to to communicate information such as game mode or map through the request flow.
 
string SessionId
 A guid string session ID created track the multiplayer server session over its life.
 
- Public Attributes inherited from PlayFab.SharedModels.PlayFabRequestCommon
PlayFabAuthenticationContext AuthenticationContext
 

Additional Inherited Members

- Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel
string ToJson ()
 

Detailed Description

Requests a multiplayer server session from a particular build in any of the given preferred regions.


The documentation for this class was generated from the following file: