This holds all events and is a wrapper around the currently running network backend. More...

Inheritance diagram for VerticesEngine.Net.vxNetworkClient:

Public Member Functions
double	GetCurrentNetTime ()

void	SetCurrentNetGame (vxINetGameplayScene gameplayScene)

void	Start (vxNetworkBackend networkBackend)

void	Disconnect ()
	The disconnect.

void	Dispose ()

void	SendLocalDiscoverySignal (int port)
	Sends out a discovery signal for all local servers/games running. This is usually used for LAN games.

void	SendDiscoverySignal (string ip, int port)

vxINetMessageOutgoing	CreateMessage ()

void	Connect (string Address, int Port)

void	Connect (string Address, int Port, vxINetMessageOutgoing hail)
	Connect with a hail message.

void	SendMessage (vxINetworkMessage gameMessage)

void	Draw ()

void	Reset ()

Public Attributes
vxNetPlayerInfo	PlayerState
	Player Info.

vxEnumNetSessionState	m_sessionStatus = vxEnumNetSessionState.InLobby

bool	IsInitialised = false

Properties
string	UniqueID `[get]`

Version	ClientVersion `[get]`

vxNetPlayerManager	PlayerManager `[get, set]`
	The player manager.

vxEnumNetSessionState	SessionStatus `[get, set]`
	The current session status.

bool	IsSessionLocal `[get, set]`
	Is this session a local LAN session or Dedicated Server session.

vxINetGameplayScene	CurrentNetGame `[get]`

bool	IsMatchRunning `[get, set]`
	Gets or sets a value indicating whether this T:VerticesEngine.Net.vxNetworkSessionManager 's match is running.

vxNetworkBackend	NetworkBackend `[get]`
	Gets the network backend.

bool	IsHost `[get]`
	Are we the host for this net session? This is set only by the server. We can be a host (i.e. authority) but not the server when using dedicated servers.

string	HostID `[get]`
	The ID of the current host. This is mainly just for debugging purposes.

vxEnumNetworkPlayerRole	PlayerNetworkRole `[get]`
	Gets the player network role.

Events
EventHandler< vxNetClientEventDiscoverySignalResponse >	DiscoverySignalResponseRecieved
	This event is fired on the client side whenever a new player connects to the server.

EventHandler< vxNetClientEventConnected >	Connected
	This event is fired whenever this player connects to the server.

EventHandler< vxNetClientEventDisconnected >	Disconnected
	This event is fired whenever this player disconnects from the server.

EventHandler< vxNetClientEventPlayerConnected >	OtherPlayerConnected
	This event is fired on the client side whenever a new player connects to the server.

Action	PlayerListUpdated = () => { }
	This event is fired when the client receieves the player list.

Action< string >	PlayerHostUpdated = (id) => {}
	This event is fired when the server tells all clients there's a new host.

EventHandler< vxNetClientEventPlayerDisconnected >	OtherPlayerDisconnected
	This event is fired on the client side whenever a player disconnects from the server.

EventHandler< vxNetClientEventPlayerStatusUpdate >	UpdatedPlayerInfoRecieved
	When ever new information of a player is recieved.

Action< vxNetmsgPlayerMetaData >	UpdatedPlayerMetaDataRecieved
	When ever new player metadate is recieved.

Action< vxNetmsgLevelMetaData >	UpdatedLevelMetaDataRecieved
	When ever new player metadate is recieved.

Action< vxNetmsgLevelEvent >	LevelEventRecieved

EventHandler< vxNetClientEventSessionStatusUpdated >	NetSessionStatusChanged
	When the server updates the session status.

Action< vxNetmsgUpdatePlayerEntityState, float >	UpdatePlayerEntityState
	This event fires when an updated Entity State is recieved from the Server.

Detailed Description

This holds all events and is a wrapper around the currently running network backend.

Member Function Documentation

◆ Connect()

void VerticesEngine.Net.vxNetworkClient.Connect	(	string	Address,
		int	Port,
		vxINetMessageOutgoing	hail )

Connect with a hail message.

Parameters

Address
Port

◆ SendLocalDiscoverySignal()

void VerticesEngine.Net.vxNetworkClient.SendLocalDiscoverySignal ( int port )

Sends out a discovery signal for all local servers/games running. This is usually used for LAN games.

Parameters

port

Property Documentation

◆ IsMatchRunning

bool VerticesEngine.Net.vxNetworkClient.IsMatchRunning

getset

Gets or sets a value indicating whether this T:VerticesEngine.Net.vxNetworkSessionManager 's match is running.

true if is match running; otherwise, false.

◆ NetworkBackend

vxNetworkBackend VerticesEngine.Net.vxNetworkClient.NetworkBackend

get

Gets the network backend.

The network backend.

◆ PlayerNetworkRole

vxEnumNetworkPlayerRole VerticesEngine.Net.vxNetworkClient.PlayerNetworkRole

get

Gets the player network role.

Returns: The player network role.

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

/github/workspace/src/VerticesEngine/src.shared/Net/vxNetworkClient.cs

Public Member Functions

Public Attributes

Properties

Events