Main game client class. More...

Inherits MonoBehaviour, and IActionInfoProvider.

Classes
struct	ExtendedSpawnInfo

Public Member Functions
delegate void	ConnectedToWorldServerHandler ()

delegate void	ConnectionToWorldServerFailedHandler ()

delegate void	DisconnectedFromWorldServerHandler ()

delegate void	ConnectedToServerHandler ()

delegate void	ConnectionToServerFailedHandler ()

delegate void	PreDisconnectFromServerHandler ()

delegate void	DisconnectedFromServerHandler ()

delegate void	ServersFoundHandler (GameServerType serverType, string mapId, IPEndPoint[] results)

delegate void	ServerSearchFailedHandler (GameServerType serverType, string mapId)

delegate void	ServerSummaryReceivedHandler (GameServerSummary serverSummary)

delegate void	ServerSpawnedHandler (GameServerType serverType, string mapId, IPEndPoint endPoint)

delegate void	ServerSpawnFailedHandler (GameServerType serverType, string mapId)

delegate void	PlayerFoundHandler (string playerId, GameServerType serverType, string mapId, IPEndPoint serverEndPoint)

delegate void	PlayerNotFoundHandler (string playerId)

delegate void	PlayerJoinedServerHandler (int peerIndex, PlayerProfile playerProfile)

delegate void	PlayerLeftServerHandler (int peerIndex, PlayerProfile playerProfile)

delegate void	PlayerJoinedWorldServerHandler (string playerId, string playerNickname)

delegate void	PlayerLeftWorldServerHandler (string playerId, string playerNickname)

delegate void	WorldDataReceivedHandler (UJeli worldDataPage)

void	Log (string line)
	Write one line to the client log. Log entries are automatically timestamped. More...

int	GetPlayerPeerIndex (string playerId)
	Get the peer index of the player with the given ID. More...

string	GetPlayerID (int peerIndex)
	Get the ID of the player with the given peer index. More...

PlayerProfile	GetPlayerProfile (string playerId)
	Get the profile of the player with the given ID. More...

PlayerProfile	GetPlayerProfile (int peerIndex)
	Get the profile of the player with the given peer index. More...

void	GoToLaunchScreen (bool upToDate)
	Go to the client launch screen. More...

void	ConnectToWorldServer ()
	Connect to the world server specified in the network configuration. More...

void	DisconnectFromWorldServer (string error="")
	Disconnect from the world server. More...

void	FindServers (GameServerType serverType, string mapId, bool isCrucial)
	Initiates a server search. More...

void	RequestServerSummary (IPEndPoint serverEndPoint)
	Requests a summary from the server at the given end point. More...

void	RequestServerSpawn (GameServerType serverType, string mapId)
	Sends a server spawn request to the world server. More...

void	ConnectToServer (IPEndPoint serverEndPoint, GameServerType serverType, string mapId, bool isCrucial)
	Connect to a server. More...

void	DisconnectFromServer ()
	Disconnect from the current server. More...

void	PullWorldData (string pageName, WorldDataReceivedHandler callback, bool useCache=false)
	Requests a specific page of world data from the world server. More...

string	GetActionCaption (ControlsAction actionType)
	Gets the caption to use for the given action. More...

bool	IsActionEnabled (ControlsAction actionType)
	Gets whether or not the given action is enabled. More...

UJeli	GetCachedWorldData (string pageName)
	Returns a cached copy of a previously fetched world data page. More...

bool	ToggleFullScreen ()
	Toggles the full screen state of the game window. More...

void	SaveScreenshot ()
	Saves a timestamped screenshot into the screenshots folder. More...

Public Attributes
float	StatsReportInterval = 1f
	The interval at which to report local player statistics to the world server. More...

Properties
static GameClient	Instance `[get]`
	Gets the sole instance of the game client. More...

string	ConfigBase `[get]`
	Gets the base path for configuration files. More...

string	LogsBase `[get]`
	Gets the base path for log files. More...

string	ScreenshotsBase `[get]`
	Gets the base path for screenshots. More...

string	StudyLogsBase `[get]`
	Gets the base path for study logs. More...

ClientConfig	Config `[get]`
	Gets the configuration for this client. More...

bool	IsConnectedToWorldServer `[get]`
	Gets whether or not this client is connected to the world server. More...

bool	IsConnectedToServer `[get]`
	Gets whether or not this client is connected to a server. More...

GameServerType	ServerType `[get]`
	Gets the type of server we are connected to, if any. More...

string	MapID `[get]`
	Gets the ID of the currently loaded map. More...

UJeli	MapSettings `[get]`
	Settings for this map, pulled from the world server. More...

int	NumPlayers `[get]`
	Gets the number of players connected to the current server. More...

string[]	PlayerIDs `[get]`
	Gets an array containing the IDs of all players connected to the current server. More...

int[]	PlayerPeerIndices `[get]`
	Gets an array containing the peer indices of all players connected to the current server. More...

PlayerProfile[]	PlayerProfiles `[get]`
	Gets an array containing the profiles of all players connected to the current server. More...

string[]	PlayerNicknames `[get]`
	Gets an array containing the nicknames of all connected players. More...

string	LocalPlayerID `[get]`
	Gets the player ID of the local client. More...

PlayerProfile	LocalPlayerProfile `[get]`
	Gets the player profile of the local client. More...

Events
ConnectedToWorldServerHandler	ConnectedToWorldServer = delegate { }
	Event fired when the game client successfully connects to the world server. More...

ConnectionToWorldServerFailedHandler	ConnectionToWorldServerFailed = delegate { }
	Event fired when the game client fails to connect to the world server. More...

DisconnectedFromWorldServerHandler	DisconnectedFromWorldServer = delegate { }
	Event fired when the game client is disconnected from the world server. More...

ConnectedToServerHandler	ConnectedToServer = delegate { }
	Event fired when the game client successfully connects to a server. More...

ConnectionToServerFailedHandler	ConnectionToServerFailed = delegate { }
	Event fired when the game client fails to connect to a server. More...

PreDisconnectFromServerHandler	PreDisconnectFromServer = delegate { }
	Event fired before the server disconnection code is run (before profiles are remove/unsync occurs). More...

DisconnectedFromServerHandler	DisconnectedFromServer = delegate { }
	Event fired when the game client is disconnected from a server. More...

ServersFoundHandler	ServersFound = delegate { }
	Event fired when a server search returns results. More...

ServerSearchFailedHandler	ServerSearchFailed = delegate { }
	Event fired when a server search fails. More...

ServerSummaryReceivedHandler	ServerSummaryReceived = delegate { }
	Event fired when a response is received for a server summary request. More...

ServerSpawnedHandler	ServerSpawned = delegate { }
	Event fired when a requested server spawn is successful. More...

ServerSpawnFailedHandler	ServerSpawnFailed = delegate { }
	Event fired when a requested server spawn fails. More...

PlayerFoundHandler	PlayerFound = delegate { }
	Event fired when a player search is successful. More...

PlayerNotFoundHandler	PlayerNotFound = delegate { }
	Event fired when a player search fails. More...

PlayerJoinedServerHandler	OtherPlayerJoinedServer = delegate { }
	Event fired when another player joins the current server. More...

PlayerLeftServerHandler	OtherPlayerLeftServer = delegate { }
	Event fired when another player leaves the current server. More...

PlayerJoinedWorldServerHandler	OtherPlayerJoinedWorldServer = delegate{ }
	Event fired when another player joins the world server. More...

PlayerLeftWorldServerHandler	OtherPlayerLeftWorldServer = delegate { }
	Event fired when another player leaves the world server. More...

Detailed Description

Main game client class.

Definition at line 16 of file GameClient.cs.

Member Function Documentation

void GameClient.ConnectToServer	(	IPEndPoint	serverEndPoint,
		GameServerType	serverType,
		string	mapId,
		bool	isCrucial
	)

inline

Connect to a server.

Parameters

serverEndPoint	The network end point of the target server.
serverType	The type of the target server.
mapId	The map ID of the target server.
isCrucial	Whether or not this connection attempt is crucial. When crucial connections fail, the game goes back to the launch screen. Otherwise, the game attempts to connect to the last zone server.

Definition at line 663 of file GameClient.cs.

void GameClient.ConnectToWorldServer ( )

inline

Connect to the world server specified in the network configuration.

Definition at line 512 of file GameClient.cs.

void GameClient.DisconnectFromServer ( )

inline

Disconnect from the current server.

Definition at line 690 of file GameClient.cs.

void GameClient.DisconnectFromWorldServer ( string error = "" )

inline

Disconnect from the world server.

Parameters

error Optional error to display locally and propagate to other peers.

Definition at line 575 of file GameClient.cs.

void GameClient.FindServers	(	GameServerType	serverType,
		string	mapId,
		bool	isCrucial
	)

inline

Initiates a server search.

Parameters

serverType	The type of server to find.
mapId	The desired map ID of the returned servers.
isCrucial	Whether or not this search is crucial. When crucial searches fail, the game goes back to the launch screen. Otherwise, the game attempts to connect to the last zone server.

Definition at line 607 of file GameClient.cs.

string GameClient.GetActionCaption ( ControlsAction action )

inline

Gets the caption to use for the given action.

Implements IActionInfoProvider.

Definition at line 758 of file GameClient.cs.

UJeli GameClient.GetCachedWorldData ( string pageName )

inline

Returns a cached copy of a previously fetched world data page.

Parameters

pageName The name of the data page.

Definition at line 795 of file GameClient.cs.

string GameClient.GetPlayerID ( int peerIndex )

inline

Get the ID of the player with the given peer index.

Definition at line 466 of file GameClient.cs.

int GameClient.GetPlayerPeerIndex ( string playerId )

inline

Get the peer index of the player with the given ID.

Definition at line 454 of file GameClient.cs.

PlayerProfile GameClient.GetPlayerProfile ( string playerId )

inline

Get the profile of the player with the given ID.

Definition at line 478 of file GameClient.cs.

PlayerProfile GameClient.GetPlayerProfile ( int peerIndex )

inline

Get the profile of the player with the given peer index.

Definition at line 490 of file GameClient.cs.

void GameClient.GoToLaunchScreen ( bool upToDate )

inline

Go to the client launch screen.

Parameters

upToDate Whether or not the game is up to date.

Definition at line 503 of file GameClient.cs.

bool GameClient.IsActionEnabled ( ControlsAction action )

inline

Gets whether or not the given action is enabled.

Implements IActionInfoProvider.

Definition at line 768 of file GameClient.cs.

void GameClient.Log ( string line )

inline

Write one line to the client log. Log entries are automatically timestamped.

Definition at line 431 of file GameClient.cs.

void GameClient.PullWorldData	(	string	pageName,
		WorldDataReceivedHandler	callback,
		bool	useCache = `false`
	)

inline

Requests a specific page of world data from the world server.

Parameters

pageName	The name of the data page.
callback	The callback to call once the world data is received.
useCache	Whether or not to use a cached copy if available.

Definition at line 726 of file GameClient.cs.

void GameClient.RequestServerSpawn	(	GameServerType	serverType,
		string	mapId
	)

inline

Sends a server spawn request to the world server.

Parameters

serverType	The type of server to spawn.
mapId	The ID of the map for the spawned server to load.

Definition at line 644 of file GameClient.cs.

void GameClient.RequestServerSummary ( IPEndPoint serverEndPoint )

inline

Requests a summary from the server at the given end point.

Definition at line 626 of file GameClient.cs.

void GameClient.SaveScreenshot ( )

inline

Saves a timestamped screenshot into the screenshots folder.

Definition at line 820 of file GameClient.cs.

bool GameClient.ToggleFullScreen ( )

inline

Toggles the full screen state of the game window.

Returns: The new full screen state.

Definition at line 806 of file GameClient.cs.

Member Data Documentation

float GameClient.StatsReportInterval = 1f

The interval at which to report local player statistics to the world server.

Definition at line 319 of file GameClient.cs.

Property Documentation

ClientConfig GameClient.Config

get

Gets the configuration for this client.

Definition at line 176 of file GameClient.cs.

string GameClient.ConfigBase

get

Gets the base path for configuration files.

Definition at line 144 of file GameClient.cs.

GameClient GameClient.Instance

staticget

Gets the sole instance of the game client.

Definition at line 136 of file GameClient.cs.

bool GameClient.IsConnectedToServer

get

Gets whether or not this client is connected to a server.

Definition at line 192 of file GameClient.cs.

bool GameClient.IsConnectedToWorldServer

get

Gets whether or not this client is connected to the world server.

Definition at line 184 of file GameClient.cs.

string GameClient.LocalPlayerID

get

Gets the player ID of the local client.

Definition at line 286 of file GameClient.cs.

PlayerProfile GameClient.LocalPlayerProfile

get

Gets the player profile of the local client.

Definition at line 294 of file GameClient.cs.

string GameClient.LogsBase

get

Gets the base path for log files.

Definition at line 152 of file GameClient.cs.

string GameClient.MapID

get

Gets the ID of the currently loaded map.

Definition at line 213 of file GameClient.cs.

UJeli GameClient.MapSettings

get

Settings for this map, pulled from the world server.

Definition at line 226 of file GameClient.cs.

int GameClient.NumPlayers

get

Gets the number of players connected to the current server.

Definition at line 234 of file GameClient.cs.

string [] GameClient.PlayerIDs

get

Gets an array containing the IDs of all players connected to the current server.

Definition at line 242 of file GameClient.cs.

string [] GameClient.PlayerNicknames

get

Gets an array containing the nicknames of all connected players.

Definition at line 272 of file GameClient.cs.

int [] GameClient.PlayerPeerIndices

get

Gets an array containing the peer indices of all players connected to the current server.

Definition at line 250 of file GameClient.cs.

PlayerProfile [] GameClient.PlayerProfiles

get

Gets an array containing the profiles of all players connected to the current server.

Definition at line 258 of file GameClient.cs.

string GameClient.ScreenshotsBase

get

Gets the base path for screenshots.

Definition at line 160 of file GameClient.cs.

GameServerType GameClient.ServerType

get

Gets the type of server we are connected to, if any.

Definition at line 200 of file GameClient.cs.

string GameClient.StudyLogsBase

get

Gets the base path for study logs.

Definition at line 168 of file GameClient.cs.

Event Documentation

ConnectedToServerHandler GameClient.ConnectedToServer = delegate { }

Event fired when the game client successfully connects to a server.

Definition at line 73 of file GameClient.cs.

ConnectedToWorldServerHandler GameClient.ConnectedToWorldServer = delegate { }

Event fired when the game client successfully connects to the world server.

Definition at line 61 of file GameClient.cs.

ConnectionToServerFailedHandler GameClient.ConnectionToServerFailed = delegate { }

Event fired when the game client fails to connect to a server.

Definition at line 77 of file GameClient.cs.

ConnectionToWorldServerFailedHandler GameClient.ConnectionToWorldServerFailed = delegate { }

Event fired when the game client fails to connect to the world server.

Definition at line 65 of file GameClient.cs.

DisconnectedFromServerHandler GameClient.DisconnectedFromServer = delegate { }

Event fired when the game client is disconnected from a server.

Definition at line 85 of file GameClient.cs.

DisconnectedFromWorldServerHandler GameClient.DisconnectedFromWorldServer = delegate { }

Event fired when the game client is disconnected from the world server.

Definition at line 69 of file GameClient.cs.

PlayerJoinedServerHandler GameClient.OtherPlayerJoinedServer = delegate { }

Event fired when another player joins the current server.

Definition at line 117 of file GameClient.cs.

PlayerJoinedWorldServerHandler GameClient.OtherPlayerJoinedWorldServer = delegate{ }

Event fired when another player joins the world server.

Definition at line 125 of file GameClient.cs.

PlayerLeftServerHandler GameClient.OtherPlayerLeftServer = delegate { }

Event fired when another player leaves the current server.

Definition at line 121 of file GameClient.cs.

PlayerLeftWorldServerHandler GameClient.OtherPlayerLeftWorldServer = delegate { }

Event fired when another player leaves the world server.

Definition at line 129 of file GameClient.cs.

PlayerFoundHandler GameClient.PlayerFound = delegate { }

Event fired when a player search is successful.

Definition at line 109 of file GameClient.cs.

PlayerNotFoundHandler GameClient.PlayerNotFound = delegate { }

Event fired when a player search fails.

Definition at line 113 of file GameClient.cs.

PreDisconnectFromServerHandler GameClient.PreDisconnectFromServer = delegate { }

Event fired before the server disconnection code is run (before profiles are remove/unsync occurs).

Definition at line 81 of file GameClient.cs.

ServerSearchFailedHandler GameClient.ServerSearchFailed = delegate { }

Event fired when a server search fails.

Definition at line 93 of file GameClient.cs.

ServersFoundHandler GameClient.ServersFound = delegate { }

Event fired when a server search returns results.

Definition at line 89 of file GameClient.cs.

ServerSpawnedHandler GameClient.ServerSpawned = delegate { }

Event fired when a requested server spawn is successful.

Definition at line 101 of file GameClient.cs.

ServerSpawnFailedHandler GameClient.ServerSpawnFailed = delegate { }

Event fired when a requested server spawn fails.

Definition at line 105 of file GameClient.cs.

ServerSummaryReceivedHandler GameClient.ServerSummaryReceived = delegate { }

Event fired when a response is received for a server summary request.

Definition at line 97 of file GameClient.cs.

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

C:/Users/Dan/Documents/Doomsday/Liberi/Assets/Scripts/Core/GameClient.cs

Classes

Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation