Class endstone::PlayerMoveEvent

ClassList > endstone > PlayerMoveEvent

Called when a player moves.

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

Inherits the following classes: endstone::Cancellable

Inherited by the following classes: endstone::PlayerJumpEvent, endstone::PlayerTeleportEvent

Public Attributes

Type	Name
Location	from_
Location	to_

Public Functions

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 Attributes Documentation

variable from_

Location endstone::PlayerMoveEvent::from_;

---

variable to_

Location endstone::PlayerMoveEvent::to_;

---

Public Functions Documentation

function ENDSTONE_EVENT

endstone::PlayerMoveEvent::ENDSTONE_EVENT (
    PlayerMoveEvent
) 

---

function PlayerMoveEvent

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

---

function getFrom

Gets the location this player moved from.

inline const Location & endstone::PlayerMoveEvent::getFrom () const

Returns:

Location the player moved from

---

function getTo

Gets the location this player moved to.

inline const Location & endstone::PlayerMoveEvent::getTo () const

Returns:

Location the player moved to

---

function setFrom

Sets the location to mark as where the player moved from.

inline Result< void > endstone::PlayerMoveEvent::setFrom (
    const Location & from
) 

Parameters:

• from New location to mark as the players previous location

---

function setTo

Sets the location that this player will move to.

inline Result< void > endstone::PlayerMoveEvent::setTo (
    const Location & to
) 

Parameters:

• to New Location this player will move to

---

---

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