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

Public Functions

Type	Name
	ENDSTONE_EVENT (WeatherChangeEvent)
	WeatherChangeEvent (Level & level, const bool to)
bool	toWeatherState () const Gets the state of weather that the world is being set to.
	~WeatherChangeEvent () override

Public Functions inherited from endstone::Cancellable

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event.
virtual bool	isCancelled () override const Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0 Cancels this event.
virtual bool	isCancelled () const = 0 Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) = 0 Sets the cancellation state of this event.
virtual	~ICancellable () = default

Public Functions Documentation

function ENDSTONE_EVENT

endstone::WeatherChangeEvent::ENDSTONE_EVENT (
    WeatherChangeEvent
) 

---

function WeatherChangeEvent

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

---

function toWeatherState

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

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

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