Class endstone::PlayerRecipeBookSettingsChangeEvent¶

ClassList > endstone > PlayerRecipeBookSettingsChangeEvent

Called when a player changes recipe book settings.

#include <endstone/event/player/player_recipe_book_settings_change_event.h>

Inherits the following classes: endstone::PlayerEvent

Public Types¶

Type	Name
enum	RecipeBookType Represents the type of recipe book whose settings changed.

Public Functions¶

Type	Name
	ENDSTONE_EVENT (PlayerRecipeBookSettingsChangeEvent)
	PlayerRecipeBookSettingsChangeEvent (const NotNull< Player > & player, RecipeBookType recipe_book_type, bool is_open, bool is_filtering)
RecipeBookType	getRecipeBookType () const Gets the type of recipe book whose settings changed.
bool	isFiltering () const Gets whether recipe filtering is enabled.
bool	isOpen () const Gets whether the recipe book is open.

Public Functions inherited from endstone::PlayerEvent¶

See endstone::PlayerEvent

Type	Name
	PlayerEvent (const NotNull< Player > & player)
const NotNull< Player > &	getPlayer () const Returns the player involved in this event.
	~PlayerEvent () override

Public Functions inherited from endstone::Event¶

See endstone::Event

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete
	Event (Event &&) = default
virtual std::string	getEventName () const = 0 Gets a user-friendly identifier for this event.
bool	isAsynchronous () const Any custom event that should not by synchronized with other events must use the specific constructor.
Event &	operator= (const Event &) = delete
Event &	operator= (Event &&) = default
virtual	~Event () = default

Protected Attributes inherited from endstone::PlayerEvent¶

See endstone::PlayerEvent

Type	Name
NotNull< Player >	player_

Public Types Documentation¶

enum RecipeBookType¶

Represents the type of recipe book whose settings changed.

enum endstone::PlayerRecipeBookSettingsChangeEvent::RecipeBookType {
    Crafting,
    Furnace,
    BlastFurnace,
    Smoker
};

Public Functions Documentation¶

function ENDSTONE_EVENT¶

endstone::PlayerRecipeBookSettingsChangeEvent::ENDSTONE_EVENT (
    PlayerRecipeBookSettingsChangeEvent
)

function PlayerRecipeBookSettingsChangeEvent¶

inline endstone::PlayerRecipeBookSettingsChangeEvent::PlayerRecipeBookSettingsChangeEvent (
    const  NotNull < Player > & player,
    RecipeBookType recipe_book_type,
    bool is_open,
    bool is_filtering
)

function getRecipeBookType¶

Gets the type of recipe book whose settings changed.

inline RecipeBookType endstone::PlayerRecipeBookSettingsChangeEvent::getRecipeBookType () const

Returns:

the recipe book type

function isFiltering¶

Gets whether recipe filtering is enabled.

inline bool endstone::PlayerRecipeBookSettingsChangeEvent::isFiltering () const

Returns:

true if recipe filtering is enabled

function isOpen¶

Gets whether the recipe book is open.

inline bool endstone::PlayerRecipeBookSettingsChangeEvent::isOpen () const

Returns:

true if the recipe book is open

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