Class endstone::PlayerTeleportEvent

ClassList > endstone > PlayerTeleportEvent

Called when a player is teleported from one location to another.

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

Inherits the following classes: endstone::PlayerEvent

Public Static Attributes

Type	Name
const std::string	NAME = = "PlayerTeleportEvent"

Public Functions

Type	Name
	PlayerTeleportEvent (Player & player, Location from, Location to)
virtual std::string	getEventName () override const
const Location &	getFrom () const Gets the location that this player moved from.
const Location &	getTo () const Gets the location that this player moved to.
virtual bool	isCancellable () override const
void	setFrom (const Location & from) Sets the location that this player moved from.
void	setTo (const Location & to) Sets the location that this player moved to.
	~PlayerTeleportEvent () override

Public Functions inherited from endstone::PlayerEvent

See endstone::PlayerEvent

Type	Name
	PlayerEvent (Player & player)
Player &	getPlayer () const
	~PlayerEvent () override

Public Functions inherited from endstone::Event

See endstone::Event

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete
virtual std::string	getEventName () const = 0
bool	isAsynchronous () const
virtual bool	isCancellable () const = 0
bool	isCancelled () const
Event &	operator= (const Event &) = delete
void	setCancelled (bool cancel)
virtual	~Event () = default

Public Static Attributes Documentation

variable NAME

const std::string endstone::PlayerTeleportEvent::NAME;

---

Public Functions Documentation

function PlayerTeleportEvent

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

---

function getEventName

inline virtual std::string endstone::PlayerTeleportEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getFrom

Gets the location that this player moved from.

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

Returns:

Location this player moved from

---

function getTo

Gets the location that this player moved to.

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

Returns:

Location this player moved to

---

function isCancellable

inline virtual bool endstone::PlayerTeleportEvent::isCancellable () override const

Whether the event can be cancelled by a plugin or the server.

Returns:

true if this event can be cancelled

Implements endstone::Event::isCancellable

---

function setFrom

Sets the location that this player moved from.

inline void endstone::PlayerTeleportEvent::setFrom (
    const Location & from
) 

Parameters:

• from New location this player moved from

---

function setTo

Sets the location that this player moved to.

inline void endstone::PlayerTeleportEvent::setTo (
    const Location & to
) 

Parameters:

• to New Location this player moved to

---

function ~PlayerTeleportEvent

endstone::PlayerTeleportEvent::~PlayerTeleportEvent () override

---

---

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