Class endstone::PlayerSneakEvent¶

ClassList > endstone > PlayerSneakEvent

Called when a player starts or stops sneaking.

Inherits the following classes: endstone::PlayerEvent

Public Functions¶

Type	Name
	PlayerSneakEvent (Player & player, bool sneaking)
bool	isSneaking () const Gets whether the player is attempting to sneak.

Type	Name
	PlayerEvent (Player & player)
Player &	getPlayer () const Returns the player involved in this event.
	~PlayerEvent () override

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete
	Event (Event &&) = default
virtual std::string	getEventName () const = 0 Gets a user-friendly identifier for this event.
bool	isAsynchronous () const Any custom event that should not by synchronized with other events must use the specific constructor.
Event &	operator= (const Event &) = delete
Event &	operator= (Event &&) = default
virtual	~Event () = default

Type	Name
std::reference_wrapper< Player >	player_

inline explicit endstone::PlayerSneakEvent::PlayerSneakEvent (
    Player & player,
    bool sneaking
)

Gets whether the player is attempting to sneak.

inline bool endstone::PlayerSneakEvent::isSneaking () const

Returns:

true when starting to sneak, false when stopping

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