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

Public Static Attributes

Type	Name
const std::string	NAME = = "ActorSpawnEvent"

Public Functions

Type	Name
	ActorSpawnEvent (Actor & actor)
virtual std::string	getEventName () override const
virtual bool	isCancellable () override const
	~ActorSpawnEvent () override

Public Functions inherited from endstone::ActorEvent

See endstone::ActorEvent

Type	Name
	ActorEvent (Actor & actor)
Actor &	getActor () const Returns the Actor involved in this event.
	~ActorEvent () 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

Detailed Description

If an Actor Spawn event is cancelled, the actor will not spawn.

Public Static Attributes Documentation

variable NAME

const std::string endstone::ActorSpawnEvent::NAME;

---

Public Functions Documentation

function ActorSpawnEvent

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

---

function getEventName

inline virtual std::string endstone::ActorSpawnEvent::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::ActorSpawnEvent::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 ~ActorSpawnEvent

endstone::ActorSpawnEvent::~ActorSpawnEvent () override

---

---

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