Class endstone::PlayerInteractActorEvent

ClassList > endstone > PlayerInteractActorEvent

Represents an event that is called when a player right-clicks an actor.

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

Inherits the following classes: endstone::Cancellable

Public Static Attributes

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

Public Functions

Type	Name
	PlayerInteractActorEvent (Player & player, Actor & actor)
Actor &	getActor () const Gets the actor that was right-clicked by the player.
virtual std::string	getEventName () override const
	~PlayerInteractActorEvent () 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::PlayerInteractActorEvent::NAME;

---

Public Functions Documentation

function PlayerInteractActorEvent

inline explicit endstone::PlayerInteractActorEvent::PlayerInteractActorEvent (
    Player & player,
    Actor & actor
) 

---

function getActor

Gets the actor that was right-clicked by the player.

inline Actor & endstone::PlayerInteractActorEvent::getActor () const

Returns:

actor right-clicked by player

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function ~PlayerInteractActorEvent

endstone::PlayerInteractActorEvent::~PlayerInteractActorEvent () override

---

---

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