HoverRace  2.0
Public Member Functions | Private Types | Private Member Functions | List of all members
HoverRace::Player::LocalPlayer Class Reference

A player connected to a local input device. More...

#include <LocalPlayer.h>

+ Inheritance diagram for HoverRace::Player::LocalPlayer:

Public Member Functions

 LocalPlayer ()=delete
 
 LocalPlayer (std::shared_ptr< Profile > profile, bool human, bool competing)
 
virtual ~LocalPlayer ()
 
- Public Member Functions inherited from HoverRace::Player::Player
 Player ()=delete
 
 Player (std::shared_ptr< Profile > profile, bool local, bool human, bool competing)
 Constructor. More...
 
virtual ~Player ()
 
void AttachMainCharacter (MainCharacter::MainCharacter *mainCharacter)
 Attach the main character (when joining a game session). More...
 
void DetachMainCharacter ()
 Detach the main character (when leaving a game session). More...
 
ConnectionState GetConnectionState () const
 
connectionStateChanged_tGetConnectionStateChangedSignal ()
 
MainCharacter::MainCharacterGetMainCharacter () const
 Retrieve the main character, if attached. More...
 
const std::string & GetName () const
 Retrieve the display name of the player. More...
 
nameChangedSignal_tGetNameChangedSignal ()
 
ProfileGetProfile () const
 
bool IsCompeting () const
 
bool IsHuman () const
 
bool IsLocal () const
 
void SetNameSuffix (const std::string &suffix)
 Sets the suffix on the display name. More...
 
std::shared_ptr< ProfileShareProfile () const
 
virtual std::ostream & StreamOut (std::ostream &os) const
 

Private Types

using SUPER = Player
 

Private Member Functions

void Disconnect () override
 

Additional Inherited Members

- Public Types inherited from HoverRace::Player::Player
enum  ConnectionState { ConnectionState::DISCONNECTED, ConnectionState::CONNECTING, ConnectionState::CONNECTED, ConnectionState::DISCONNECTING }
 
using connectionStateChanged_t = boost::signals2::signal< void()>
 
using nameChangedSignal_t = boost::signals2::signal< void()>
 
- Protected Member Functions inherited from HoverRace::Player::Player
void SetConnectionState (ConnectionState state)
 

Detailed Description

A player connected to a local input device.

Author
Michael Imamura

Member Typedef Documentation

Constructor & Destructor Documentation

HoverRace::Player::LocalPlayer::LocalPlayer ( )
delete
HoverRace::Player::LocalPlayer::LocalPlayer ( std::shared_ptr< Profile profile,
bool  human,
bool  competing 
)
virtual HoverRace::Player::LocalPlayer::~LocalPlayer ( )
inlinevirtual

Member Function Documentation

void HoverRace::Player::LocalPlayer::Disconnect ( )
overrideprivatevirtual

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