R-Type
Distributed multiplayer game engine in C++
Loading...
Searching...
No Matches
server::PlayerLeftEvent Class Reference

Event triggered when a player leaves the game. More...

#include <PlayerLeftEvent.hpp>

Inheritance diagram for server::PlayerLeftEvent:
Inheritance graph
Collaboration diagram for server::PlayerLeftEvent:
Collaboration graph

Public Member Functions

 PlayerLeftEvent (uint32_t playerId)
 Construct a PlayerLeftEvent.
 
 ~PlayerLeftEvent () override=default
 
uint32_t getPlayerId () const
 Get the player ID.
 
- Public Member Functions inherited from server::GameEvent
 GameEvent (Type type)
 
virtual ~GameEvent () override=default
 
Type getType () const
 Get the type of the event.
 
- Public Member Functions inherited from server::IEvent
 IEvent ()=default
 
virtual ~IEvent ()=default
 

Private Attributes

uint32_t _playerId
 

Additional Inherited Members

- Public Types inherited from server::GameEvent
enum class  Type {
  UNKNOWN , PLAYER_JOINED , PLAYER_LEFT , SCORE_UPDATED ,
  GAME_STARTED , GAME_ENDED , PROJECTILE_CREATED
}
 

Detailed Description

Event triggered when a player leaves the game.

Definition at line 18 of file PlayerLeftEvent.hpp.

Constructor & Destructor Documentation

◆ PlayerLeftEvent()

server::PlayerLeftEvent::PlayerLeftEvent ( uint32_t  playerId)
inlineexplicit

Construct a PlayerLeftEvent.

Parameters
playerIdThe ID of the player who left

Definition at line 24 of file PlayerLeftEvent.hpp.

◆ ~PlayerLeftEvent()

server::PlayerLeftEvent::~PlayerLeftEvent ( )
overridedefault

Member Function Documentation

◆ getPlayerId()

uint32_t server::PlayerLeftEvent::getPlayerId ( ) const
inline

Get the player ID.

Definition at line 31 of file PlayerLeftEvent.hpp.

References _playerId.

Member Data Documentation

◆ _playerId

uint32_t server::PlayerLeftEvent::_playerId
private

Definition at line 34 of file PlayerLeftEvent.hpp.

Referenced by getPlayerId().


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