Class endstone::ServerLoadEvent

ClassList > endstone > ServerLoadEvent

Called when either the server startup or reload has completed.

• #include <endstone/event/server/server_load_event.h>

Inherits the following classes: endstone::ServerEvent

Public Types

Type	Name
enum	LoadType

Public Static Attributes

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

Public Functions

Type	Name
	ServerLoadEvent (LoadType type)
virtual std::string	getEventName () override const
LoadType	getType () const
virtual bool	isCancellable () override const

Public Functions inherited from endstone::ServerEvent

See endstone::ServerEvent

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete

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 Types Documentation

enum LoadType

enum endstone::ServerLoadEvent::LoadType {
    Startup,
    Reload
};

---

Public Static Attributes Documentation

variable NAME

const std::string endstone::ServerLoadEvent::NAME;

---

Public Functions Documentation

function ServerLoadEvent

inline explicit endstone::ServerLoadEvent::ServerLoadEvent (
    LoadType type
) 

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getType

inline LoadType endstone::ServerLoadEvent::getType () const

---

function isCancellable

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

---

---

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