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::Cancellable

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.
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::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 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 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