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

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
virtual bool	isCancellable () override const
	~PlayerInteractActorEvent () 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::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 isCancellable

inline virtual bool endstone::PlayerInteractActorEvent::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 ~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