Skip to content

Class endstone::PlayerJumpEvent

ClassList > endstone > PlayerJumpEvent

Called when a player jumps.

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

Inherits the following classes: endstone::PlayerMoveEvent

Public Attributes inherited from endstone::PlayerMoveEvent

See endstone::PlayerMoveEvent

Type Name
Location from_
Location to_

Public Functions

Type Name
ENDSTONE_EVENT (PlayerJumpEvent)
PlayerMoveEvent (Player & player, Location from, Location to)

Public Functions inherited from endstone::PlayerMoveEvent

See endstone::PlayerMoveEvent

Type Name
ENDSTONE_EVENT (PlayerMoveEvent)
PlayerMoveEvent (Player & player, Location from, Location to)
const Location & getFrom () const
Gets the location this player moved from.
const Location & getTo () const
Gets the location this player moved to.
Result< void > setFrom (const Location & from)
Sets the location to mark as where the player moved from.
Result< void > setTo (const Location & to)
Sets the location that this player will move to.

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 () 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)
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 Functions Documentation

function ENDSTONE_EVENT

endstone::PlayerJumpEvent::ENDSTONE_EVENT (
    PlayerJumpEvent
) 

function PlayerMoveEvent

inline explicit endstone::PlayerJumpEvent::PlayerMoveEvent (
    Player & player,
    Location from,
    Location to
) 


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