Skip to content

Class endstone::PlayerPortalEvent

ClassList > endstone > PlayerPortalEvent

Called when a player is about to teleport because it is in contact with a portal.

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

Inherits the following classes: endstone::PlayerTeleportEvent

Public Attributes inherited from endstone::PlayerMoveEvent

See endstone::PlayerMoveEvent

Type Name
Location from_
Location to_

Public Functions

Type Name
ENDSTONE_EVENT (PlayerPortalEvent)

Public Functions inherited from endstone::PlayerTeleportEvent

See endstone::PlayerTeleportEvent

Type Name
ENDSTONE_EVENT (PlayerTeleportEvent)
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.
void setFrom (const Location & from)
Sets the location to mark as where the player moved from.
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.
virtual bool isCancelled () override const
Gets the cancellation state of this event.
virtual void setCancelled (bool cancel) override
Sets the cancellation state of this event.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type Name
virtual void cancel () = 0
Cancels this event.
virtual bool isCancelled () const = 0
Gets the cancellation state of this event.
virtual void setCancelled (bool cancel) = 0
Sets the cancellation state of this event.
virtual ~ICancellable () = default

Public Functions Documentation

function ENDSTONE_EVENT

endstone::PlayerPortalEvent::ENDSTONE_EVENT (
    PlayerPortalEvent
) 


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