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 Static Attributes

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

Public Functions

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

Public Functions inherited from endstone::Cancellable

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual bool	isCancelled () const Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual void	setCancelled (bool cancel) Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0
virtual bool	isCancelled () const = 0
virtual void	setCancelled (bool cancel) = 0
virtual	~ICancellable () = default

Public Static Attributes Documentation

variable NAME

const std::string endstone::WeatherChangeEvent::NAME;

---

Public Functions Documentation

function WeatherChangeEvent

inline endstone::WeatherChangeEvent::WeatherChangeEvent (
    Level & level,
    const  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 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