Class endstone::ActorSpawnEvent¶
ClassList > endstone > ActorSpawnEvent
Called when an Actor is spawned into a world.More...
#include <endstone/event/actor/actor_spawn_event.h>
Inherits the following classes: endstone::Cancellable
Public Static Attributes¶
| Type | Name |
|---|---|
| const std::string | NAME = "ActorSpawnEvent" |
Public Functions¶
| Type | Name |
|---|---|
| ActorSpawnEvent (Actor & actor) |
|
| virtual std::string | getEventName () override const |
| ~ActorSpawnEvent () 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 () 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¶
| Type | Name |
|---|---|
| virtual void | cancel () = 0 |
| virtual bool | isCancelled () const = 0 |
| virtual void | setCancelled (bool cancel) = 0 |
| virtual | ~ICancellable () = default |
Detailed Description¶
If an Actor Spawn event is cancelled, the actor will not spawn.
Public Static Attributes Documentation¶
variable NAME¶
Public Functions Documentation¶
function ActorSpawnEvent¶
function getEventName¶
Gets a user-friendly identifier for this event.
Returns:
name of this event
Implements endstone::Event::getEventName
function ~ActorSpawnEvent¶
The documentation for this class was generated from the following file include/endstone/event/actor/actor_spawn_event.h