Class endstone::ActorKnockbackEvent

ClassList > endstone > ActorKnockbackEvent

Called when a living entity receives knockback.

• #include <endstone/event/actor/actor_knockback_event.h>

Inherits the following classes: endstone::ActorEvent

Public Static Attributes

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

Public Functions

Type	Name
	ActorKnockbackEvent (Mob & mob, Actor * source, Vector< float > knockback)
Mob &	getActor () const Returns the Mob involved in this event.
virtual std::string	getEventName () override const
Vector< float >	getKnockback () const
Actor *	getSource () const Get the source actor that has caused knockback to the defender, if exists.
virtual bool	isCancellable () override const
void	setKnockback (Vector< float > knockback) Sets the knockback that will be applied to the entity.
	~ActorKnockbackEvent () 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

Public Static Attributes Documentation

variable NAME

const std::string endstone::ActorKnockbackEvent::NAME;

---

Public Functions Documentation

function ActorKnockbackEvent

inline explicit endstone::ActorKnockbackEvent::ActorKnockbackEvent (
    Mob & mob,
    Actor * source,
    Vector < float > knockback
) 

---

function getActor

Returns the Mob involved in this event.

inline Mob & endstone::ActorKnockbackEvent::getActor () const

Returns:

Mob which is involved in this event

---

function getEventName

inline virtual std::string endstone::ActorKnockbackEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getKnockback

inline Vector < float > endstone::ActorKnockbackEvent::getKnockback () const

Gets the knockback that will be applied to the entity.

Note: this method returns a copy, changes must be applied with setKnockback(Vector)

Returns:

the knockback

---

function getSource

Get the source actor that has caused knockback to the defender, if exists.

inline Actor * endstone::ActorKnockbackEvent::getSource () const

Returns:

actor that caused knockback, or nullptr if the knockback is not caused by an actor.

---

function isCancellable

inline virtual bool endstone::ActorKnockbackEvent::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 setKnockback

Sets the knockback that will be applied to the entity.

inline void endstone::ActorKnockbackEvent::setKnockback (
    Vector < float > knockback
) 

Parameters:

• knockback the knockback to apply

---

function ~ActorKnockbackEvent

endstone::ActorKnockbackEvent::~ActorKnockbackEvent () override

---

---

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