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 Functions

Type	Name
	ENDSTONE_EVENT (PlayerInteractActorEvent)
	PlayerInteractActorEvent (Player & player, Actor & actor)
Actor &	getActor () const Gets the actor that was right-clicked by the player.
	~PlayerInteractActorEvent () override

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::PlayerInteractActorEvent::ENDSTONE_EVENT (
    PlayerInteractActorEvent
) 

---

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 ~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