Class endstone::PlayerGameModeChangeEvent

ClassList > endstone > PlayerGameModeChangeEvent

Called when the GameMode of the player is changed.

• #include <endstone/event/player/player_game_mode_change_event.h>

Inherits the following classes: endstone::Cancellable

Public Static Attributes

Type	Name
const std::string	NAME = "PlayerGameModeChangeEvent"

Public Functions

Type	Name
	PlayerGameModeChangeEvent (Player & player, GameMode new_game_mode)
virtual std::string	getEventName () override const
GameMode	getNewGameMode () const Gets the GameMode the player is switched to.
	~PlayerGameModeChangeEvent () override

Public Functions inherited from endstone::Cancellable

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual bool	isCancelled () override const Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0
virtual bool	isCancelled () const = 0
virtual void	setCancelled (bool cancel) = 0
virtual	~ICancellable () = default

Public Static Attributes Documentation

variable NAME

const std::string endstone::PlayerGameModeChangeEvent::NAME;

---

Public Functions Documentation

function PlayerGameModeChangeEvent

inline explicit endstone::PlayerGameModeChangeEvent::PlayerGameModeChangeEvent (
    Player & player,
    GameMode new_game_mode
) 

---

function getEventName

inline virtual std::string endstone::PlayerGameModeChangeEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getNewGameMode

Gets the GameMode the player is switched to.

inline GameMode endstone::PlayerGameModeChangeEvent::getNewGameMode () const

Returns:

player's new GameMode

---

function ~PlayerGameModeChangeEvent

endstone::PlayerGameModeChangeEvent::~PlayerGameModeChangeEvent () override

---

---

The documentation for this class was generated from the following file include/endstone/event/player/player_game_mode_change_event.h