Skip to content

Class endstone::PlayerToggleCrawlEvent

ClassList > endstone > PlayerToggleCrawlEvent

Called when a player toggles their crawling state.

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

Inherits the following classes: endstone::PlayerEvent

Public Functions

Type Name
PlayerToggleCrawlEvent (const NotNull< Player > & player, bool crawling)
bool isCrawling () const
Returns whether the player is now crawling or not.

Public Functions inherited from endstone::PlayerEvent

See endstone::PlayerEvent

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

Public Functions inherited from endstone::Event

See endstone::Event

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

Protected Attributes inherited from endstone::PlayerEvent

See endstone::PlayerEvent

Type Name
NotNull< Player > player_

Public Functions Documentation

function PlayerToggleCrawlEvent

inline explicit endstone::PlayerToggleCrawlEvent::PlayerToggleCrawlEvent (
    const  NotNull < Player > & player,
    bool crawling
) 

function isCrawling

Returns whether the player is now crawling or not.

inline bool endstone::PlayerToggleCrawlEvent::isCrawling () const

Returns:

the new crawling state



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