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¶
| 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 () override 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) override 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¶
| Type | Name |
|---|---|
| virtual void | cancel () = 0 |
| virtual bool | isCancelled () const = 0 |
| virtual void | setCancelled (bool cancel) = 0 |
| virtual | ~ICancellable () = default |
Public Functions Documentation¶
function ENDSTONE_EVENT¶
function PlayerInteractActorEvent¶
inline explicit endstone::PlayerInteractActorEvent::PlayerInteractActorEvent (
Player & player,
Actor & actor
)
function getActor¶
Gets the actor that was right-clicked by the player.
Returns:
actor right-clicked by player
function ~PlayerInteractActorEvent¶
The documentation for this class was generated from the following file include/endstone/event/player/player_interact_actor_event.h