ForgeDocs
Documentation for the forge framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Forge.Networking.Lobby.LobbyMember Class Reference

A member of a lobby. More...

Inheritance diagram for Forge.Networking.Lobby.LobbyMember:
Forge.Networking.Lobby.LobbyCommon

Public Member Functions

override void Dispose ()
 Dispose the lobby. More...
 
- Public Member Functions inherited from Forge.Networking.Lobby.LobbyCommon
void Update ()
 
IEnumerable< PlayerGetLobbyMembers ()
 Get all members of the lobby, including the host. More...
 
bool IsHost (Player player)
 Is the given player the host of the lobby? More...
 

Static Public Member Functions

static Task< Maybe< LobbyMember > > JoinLobby (string host, Player player, IMapManager mapManager, string password)
 Try to join the lobby at the given IP end point as the given player. More...
 

Additional Inherited Members

- Properties inherited from Forge.Networking.Lobby.LobbyCommon
NetworkContext Context [get]
 
bool HasLaunched [get]
 Returns true if the lobby has launched. Make sure to dispose of the lobby. More...
 

Detailed Description

A member of a lobby.

Member Function Documentation

override void Forge.Networking.Lobby.LobbyMember.Dispose ( )
virtual

Dispose the lobby.

Reimplemented from Forge.Networking.Lobby.LobbyCommon.

static Task<Maybe<LobbyMember> > Forge.Networking.Lobby.LobbyMember.JoinLobby ( string  host,
Player  player,
IMapManager  mapManager,
string  password 
)
static

Try to join the lobby at the given IP end point as the given player.

Parameters
hostThe IP address that the lobby server is running at.
mapManagerThe map manager that will be used to check to see if we have a map and to save a downloaded map.
playerThis player that will be used to uniquely identify ourselves.
passwordThe password that the lobby host has set.

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