Skip to content

Class endstone::PlayerToggleFlightEvent

ClassList > endstone > PlayerToggleFlightEvent

Called when a player toggles their flying state.

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

Inherits the following classes: endstone::PlayerEvent

Public Functions

Type Name
PlayerToggleFlightEvent (const NotNull< Player > & player, bool flying)
bool isFlying () const
Returns whether the player is now flying 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 PlayerToggleFlightEvent

inline explicit endstone::PlayerToggleFlightEvent::PlayerToggleFlightEvent (
    const  NotNull < Player > & player,
    bool flying
) 

function isFlying

Returns whether the player is now flying or not.

inline bool endstone::PlayerToggleFlightEvent::isFlying () const

Returns:

the new flying state



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