Class endstone::WeatherChangeEvent

ClassList > endstone > WeatherChangeEvent

Called when the weather (rain) state in a world is changing.

• #include <endstone/event/weather/weather_change_event.h>

Inherits the following classes: endstone::WeatherEvent

Public Static Attributes

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

Public Functions

Type	Name
	WeatherChangeEvent (Level & level, bool to)
virtual std::string	getEventName () override const
virtual bool	isCancellable () override const
bool	toWeatherState () const
	~WeatherChangeEvent () override

Public Functions inherited from endstone::WeatherEvent

See endstone::WeatherEvent

Type	Name
	WeatherEvent (Level & level)
Level &	getLevel () const
	~WeatherEvent () 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::WeatherChangeEvent::NAME;

---

Public Functions Documentation

function WeatherChangeEvent

inline endstone::WeatherChangeEvent::WeatherChangeEvent (
    Level & level,
    bool to
) 

---

function getEventName

inline virtual std::string endstone::WeatherChangeEvent::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::WeatherChangeEvent::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 toWeatherState

inline bool endstone::WeatherChangeEvent::toWeatherState () const

Gets the state of weather that the world is being set to

Returns:

true if the weather is being set to raining, false otherwise

---

function ~WeatherChangeEvent

endstone::WeatherChangeEvent::~WeatherChangeEvent () override

---

---

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