Class endstone::PlayerHideActorEvent¶
ClassList > endstone > PlayerHideActorEvent
Called when a visible actor is hidden from a player. More...
#include <endstone/event/player/player_hide_actor_event.h>
Inherits the following classes: endstone::PlayerEvent
Public Functions¶
| Type | Name |
|---|---|
| ENDSTONE_EVENT (PlayerHideActorEvent) |
|
| PlayerHideActorEvent (const NotNull< Player > & player, const NotNull< Actor > & actor) |
|
| const NotNull< Actor > & | getActor () const Gets the actor hidden from the player. |
Public Functions inherited from endstone::PlayerEvent¶
| Type | Name |
|---|---|
| PlayerEvent (const NotNull< Player > & player) |
|
| const NotNull< Player > & | getPlayer () const Returns the player involved in this event. |
| ~PlayerEvent () override |
Public Functions inherited from endstone::Event¶
See endstone::Event
| Type | Name |
|---|---|
| Event (bool async=false) |
|
| Event (const Event &) = delete |
|
| Event (Event &&) = default |
|
| virtual std::string | getEventName () const = 0 Gets a user-friendly identifier for this event. |
| bool | isAsynchronous () const Any custom event that should not by synchronized with other events must use the specific constructor. |
| Event & | operator= (const Event &) = delete |
| Event & | operator= (Event &&) = default |
| virtual | ~Event () = default |
Protected Attributes inherited from endstone::PlayerEvent¶
| Type | Name |
|---|---|
| NotNull< Player > | player_ |
Detailed Description¶
This event is only called when the actor's visibility status is actually changed. It is called regardless of whether the actor is within the player's tracking range.
See also: Player::hideActor()
Public Functions Documentation¶
function ENDSTONE_EVENT¶
function PlayerHideActorEvent¶
inline endstone::PlayerHideActorEvent::PlayerHideActorEvent (
const NotNull < Player > & player,
const NotNull < Actor > & actor
)
function getActor¶
Gets the actor hidden from the player.
Returns:
the hidden actor
The documentation for this class was generated from the following file include/endstone/event/player/player_hide_actor_event.h