Class endstone::PlayerSkinChangeEvent¶

ClassList > endstone > PlayerSkinChangeEvent

Called when a player changes their skin.

#include <endstone/event/player/player_skin_change_event.h>

Inherits the following classes: endstone::Cancellable

Public Functions¶

Type	Name
	ENDSTONE_EVENT (PlayerSkinChangeEvent)
	PlayerSkinChangeEvent (Player & player, Skin new_skin, std::optional< Message > message)
Skin	getNewSkin () const Gets the player's new skin.
std::optional< Message >	getSkinChangeMessage () const Gets the message to send to all online players for this skin change.
void	setSkinChangeMessage (std::optional< Message > message) Sets the message to send to all online players for this skin change.

Public Functions inherited from endstone::Cancellable¶

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event.
virtual bool	isCancelled () override const Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event.

Public Functions inherited from endstone::ICancellable¶

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0 Cancels this event.
virtual bool	isCancelled () const = 0 Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) = 0 Sets the cancellation state of this event.
virtual	~ICancellable () = default

Public Functions Documentation¶

function ENDSTONE_EVENT¶

endstone::PlayerSkinChangeEvent::ENDSTONE_EVENT (
    PlayerSkinChangeEvent
)

function PlayerSkinChangeEvent¶

inline explicit endstone::PlayerSkinChangeEvent::PlayerSkinChangeEvent (
    Player & player,
    Skin new_skin,
    std::optional< Message > message
)

function getNewSkin¶

Gets the player's new skin.

inline Skin endstone::PlayerSkinChangeEvent::getNewSkin () const

Returns:

The skin that will be applied.

function getSkinChangeMessage¶

Gets the message to send to all online players for this skin change.

inline std::optional< Message > endstone::PlayerSkinChangeEvent::getSkinChangeMessage () const

Returns:

Message to appear to other players on the server.

function setSkinChangeMessage¶

Sets the message to send to all online players for this skin change.

inline void endstone::PlayerSkinChangeEvent::setSkinChangeMessage (
    std::optional< Message > message
)

Parameters:

message Message to appear to other players on the server.

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