LobbyPlayer Struct Reference

Information about a player that has connected to the current lobby. More...

#include <sharedgamestate.hpp>

Public Member Functions
	LobbyPlayer ()
	LobbyPlayer (EntityID id, PlayerRole desired_role, bool ready)
	DEF_SERIALIZE (Archive &ar, unsigned int version)
std::string	to_string (unsigned int tab_offset)
	Generates a string representation of this Lobby Player struct. More...
std::string	to_string ()

Data Fields
EntityID	id
	Player's EntityID (this is the EntityID of their Player or DungeonMaster object in the game state) More...
PlayerRole	desired_role
	This is the player's desired role (though they may not actually play as this role - the server must settle ties if multiple (or no) players want to play as the Dungeon Master for instance) More...
bool	ready
	Whether the player is in the Ready state on the lobby screen. More...

Detailed Description

Information about a player that has connected to the current lobby.

Constructor & Destructor Documentation

LobbyPlayer() [1/2]

LobbyPlayer::LobbyPlayer ( )

inline

LobbyPlayer() [2/2]

LobbyPlayer::LobbyPlayer ( EntityID  id, PlayerRole  desired_role, bool  ready  )

inline

Member Function Documentation

DEF_SERIALIZE()

LobbyPlayer::DEF_SERIALIZE ( Archive &  ar, unsigned int  version  )

inline

to_string() [1/2]

std::string LobbyPlayer::to_string ( )

inline

to_string() [2/2]

std::string LobbyPlayer::to_string

(

unsigned int

tab_offset

)

Generates a string representation of this Lobby Player struct.

Returns

std::string representation of this Lobby Player struct.

Field Documentation

desired_role

PlayerRole LobbyPlayer::desired_role

This is the player's desired role (though they may not actually play as this role - the server must settle ties if multiple (or no) players want to play as the Dungeon Master for instance)

id

EntityID LobbyPlayer::id

Player's EntityID (this is the EntityID of their Player or DungeonMaster object in the game state)

ready

bool LobbyPlayer::ready

Whether the player is in the Ready state on the lobby screen.

---

The documentation for this struct was generated from the following files:

• include/shared/game/sharedgamestate.hpp
• src/shared/game/sharedgamestate.cpp