Skip to content

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 Functions

Type Name
ActorSpawnEvent (Actor & actor)
ENDSTONE_EVENT (ActorSpawnEvent)
~ActorSpawnEvent () override

Public Functions inherited from endstone::Cancellable

See 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

See 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 Functions Documentation

function ActorSpawnEvent

inline explicit endstone::ActorSpawnEvent::ActorSpawnEvent (
    Actor & actor
) 

function ENDSTONE_EVENT

endstone::ActorSpawnEvent::ENDSTONE_EVENT (
    ActorSpawnEvent
) 

function ~ActorSpawnEvent

endstone::ActorSpawnEvent::~ActorSpawnEvent () override


The documentation for this class was generated from the following file include/endstone/event/actor/actor_spawn_event.h