Namespace endstone¶

Represents a button with text and an optional icon.

Namespaces¶

Type	Name
namespace	core
namespace	detail
namespace	nbt
namespace	python

Classes¶

Type	Name
class	Ability All player abilities.
class	AbilityId <typename T> Represents the identifier of a player ability, carrying the type of the ability's value.
class	ActionForm Represents a form with buttons that let the player take action.
class	Actor Represents a base actor in the level.
class	ActorChangeBlockEvent Called when an Actor changes a block as part of its own behaviour, such as a creeper exploding, an enderman picking a block up, a ravager trampling crops or a zombie breaking a door.
class	ActorCollideWithActorEvent Called when two Actors collide with each other.
class	ActorDamageEvent Called when an Actor is damaged.
class	ActorDeathEvent Called when an Actor dies.
class	ActorDismountEvent Called when an Actor stops riding anotherActor .
class	ActorEffectEvent Called when an effect on a Mob changes.
class	ActorEvent <typename ActorType> Represents an Actor-related event.
class	ActorExplodeEvent Called when an actor explodes.
class	ActorKnockbackEvent Called when a living entity receives knockback.
class	ActorPickupItemEvent Called when an Actor picks an item up from the ground.
class	ActorRemoveEvent Called when an Actor is removed.
class	ActorSpawnEvent Called when an Actor is spawned into a world.
class	ActorTeleportEvent Called when a non-player entity is teleported from one location to another.
class	ActorToggleGlideEvent Called when an Actor 's gliding state is toggled with an elytra.
class	ActorToggleSwimEvent Called when an Actor 's swimming state is toggled.
class	ActorType
class	AdvancedBarChart A bStats bar chart with several bars per category.
class	AdvancedPie A bStats pie chart with named values.
class	Attribute All attribute types.
class	AttributeInstance Represents a mutable instance of an attribute and its associated modifiers and values.
class	AttributeModifier Concrete implementation of an attribute modifier.
class	BanEntry A single entry from a ban list.
class	BanList <typename T> Represents a ban list, containing bans.
class	Biome
class	BlastingRecipe Represents a blasting recipe.
class	Block Represents a block.
class	BlockActorState Represents a captured state of a block entity.
class	BlockBreakEvent Called when a block is broken by a player.
class	BlockCommandSender Represents a block command sender.
class	BlockCookEvent Called when an ItemStack is successfully cooked in a block.
class	BlockData Represents the data related to a live block.
class	BlockEvent Represents an Block-related event.
class	BlockExplodeEvent Called when a block explodes (e.g.
class	BlockFormEvent Called when a block is formed or spreads based on world conditions.
class	BlockFromToEvent Represents events with a source block and a destination block, currently only applies to liquid (lava and water) and teleporting dragon eggs.
class	BlockGrowEvent Called when a block grows naturally in the world.
class	BlockPistonEvent Called when a piston block is triggered.
class	BlockPistonExtendEvent Called when a piston extends.
class	BlockPistonRetractEvent Called when a piston retracts.
class	BlockPlaceEvent Called when a block is placed by a player.
class	BlockState Represents a captured state of a block, which will not update automatically.
class	BlockType
class	BookMeta Represents the meta for a written book that can have a title, an author, and pages.
class	BossBar Represents a boss bar that is displayed to players.
class	BroadcastMessageEvent Event triggered for server broadcast messages such as fromServer::broadcast() .
class	Button Represents a button with text and an optional icon.
class	Campfire Represents a captured state of a campfire.
class	CampfireRecipe Represents a campfire recipe.
class	Cancellable <typename EventType> A type characterizing events that may be cancelled by a plugin or the server.
class	CauldronLevelChangeEvent Called when a cauldron's level or contents change.
class	Chunk Represents a chunk of blocks.
class	ChunkEvent Represents a Chunk related event.
class	ChunkLoadEvent Called when a chunk is loaded.
class	ChunkUnloadEvent Called when a chunk is unloaded.
class	ClassInfo A type identity that stays comparable across shared library boundaries.
class	Color Represents a color with red, green, blue, and alpha components.
struct	ColorFormat All supported color and format codes.
class	Colors Provides a collection of predefined colors.
class	Command Represents a Command , which executes various tasks upon user input.
class	CommandExecutor Represents a class which contains a single method for executing commands.
class	CommandMap Represents a command map that manages all commands of the Server .
class	CommandSender Represents a command sender.
class	CommandSenderWrapper Represents a wrapper that forwards commands to the wrapped CommandSender and captures its output.
class	ComplexAliasIngredient Represents an ingredient that matches any item an id stands for.
class	ComplexRecipe Represents a complex recipe which has imperative server-defined behavior, eg armor dyeing.
class	CompoundTag An NBT tag holding a set of named child tags, keyed by string.
class	ConsoleCommandSender Represents a console command sender.
class	Container Represents a captured state of a container block, such as a chest.
class	CookingRecipe Represents a cooking recipe.
class	CreatureSpawner Represents a captured state of a creature spawner.
class	Criteria Represents a scoreboard criteria.
class	CrossbowMeta Represents the meta for a crossbow that can have a charged projectile.
class	CustomChart Represents a custom chart.
class	DamageSource Represents a source of damage.
class	Dimension Represents a dimension within a Level .
class	DimensionCreator Represents the options that may be used to create a custom Dimension .
class	DimensionEvent Represents events within a dimension.
class	DimensionLoadEvent Called when a dimension is loaded.
class	Divider Represents a divider.
class	DrilldownPie A bStats pie chart with grouped named values.
class	Dropdown Represents a dropdown with a set of predefined options.
class	Effect Represents an effect that can be added to a Mob .
class	EffectType Represents an effect type.
class	EnchantItemEvent Called when a player enchants an item at an enchanting table.
class	Enchantment Represents an enchantment that may be added to armor, weapons, tools or other items.
class	EnchantmentOffer Represents an offer made by an enchanting table.
class	Event Represents an event.
class	EventHandler Represents a registered EventHandler which associates with aPlugin .
class	ExactIngredient Represents an ingredient that matches one item with one exact data value.
class	Form <typename T> Represents a generic form.
class	Furnace Represents a captured state of a furnace.
class	FurnaceRecipe Represents a furnace recipe.
class	GameRule Represents a game rule.
class	GameRuleId <typename T> Represents the identifier of a game rule, carrying the type of the rule's value.
class	HandlerList A list of event handlers.
class	Header Represents a header with a label.
class	ICancellable Interface for events that may be cancelled by a plugin or the server.
class	IRegistry Type-erased base interface for registries.
class	Identifier <typename T> Represents a identifier consisting of two components: a namespace and a key.
class	Image Represents an RGBA image.
class	Input Represents a movement input applied to a player.
class	Inventory Interface to the various inventories.
class	InventoryCloseEvent Called when a player closes an inventory.
class	InventoryEvent Represents a player related inventory event.
class	InventoryInteractEvent An abstract base class for events that describe an interaction between a Player and the contents of anInventory .
class	InventoryOpenEvent Called when a player opens an inventory.
class	IpBanEntry Represents an entry for a banned IP address.
class	IpBanList Represents a ban list, containing banned IP addresses.
class	Item Represents a dropped item that can be picked up by players.
class	ItemFactory An interface to the methods used to create item metadata.
class	ItemFrame Represents a captured state of an item frame.
class	ItemMeta Represents the metadata of a generic item.
class	ItemStack Represents a stack of items.
class	ItemTagIngredient Represents an ingredient that matches any item carrying a tag.
class	ItemType Represents an item type.
class	ItemTypeIngredient Represents an ingredient that matches an item type, whatever its data value.
class	Label Represents a text label.
class	Language Represents the interface for translating text into different languages.
class	LeavesDecayEvent Called when leaves are decaying naturally.
class	Lectern Represents a captured state of a lectern.
class	Level Represents a level, which may contain actors, chunks and blocks.
class	LevelEvent Represents events within a level.
class	ListTag An NBT tag holding an ordered sequence of child tags that all share the same type.
class	Location Represents a 3-dimensional location in a dimension within a level.
class	Logger Logger class which can format and output varies levels of logs.
class	MapCanvas Represents a canvas for drawing to a map.
class	MapCursor Represents a cursor on a map.
class	MapInitializeEvent Called when a map is initialized.
class	MapMeta Represents the metadata for a map item.
class	MapRenderer Represents a renderer for a map.
class	MapView Represents a map item.
class	MessageForm Represents a form with two buttons.
class	Metrics Collects and submits anonymous usage statistics for a plugin to bStats.
class	MetricsBase Collects and submits the data behind a Metrics instance.
class	Mob Represents a mobile entity (i.e.
class	ModalForm Represents a modal form with controls.
class	MolangIngredient Represents an ingredient that matches the items a Molang expression selects.
class	MultiLineChart A bStats line chart with a line per named value.
class	NotNull <class T> A wrapper around a std::shared_ptr that documents that it is never null.
class	Nullable <class T> A wrapper around a std::shared_ptr that may be null.
class	Object Base class providing runtime type identification and safe casting.
class	Objective Represents an objective on a scoreboard that can show scores specific to entries.
class	OfflinePlayer Represents a reference to a player identity and the data belonging to a player that is stored on the disk and can, thus, be retrieved without the player needing to be online.
class	PacketReceiveEvent Called when the server receives a packet from a connected client.
class	PacketSendEvent Called when the server sends a packet to a connected client.
class	Permissible Represents an object that may become a server operator and can be assigned permissions.
class	Permission Represents a unique permission that may be attached to a Permissible .
class	PermissionAttachment Holds information about a permission attachment on a Permissible object.
class	PermissionAttachmentInfo Holds information on a permission and which PermissionAttachment provides it.
class	Player Represents a player.
class	PlayerArmSwingEvent Called when a player swings their arm.
class	PlayerArmorStandManipulateEvent Called when a player interacts with an armor stand and will either swap, retrieve or place an item.
class	PlayerBanEntry Represents an entry for a banned player.
class	PlayerBanList Represents a ban list, containing banned players.
class	PlayerBedEnterEvent Called when a player is almost about to enter the bed.
class	PlayerBedLeaveEvent Called when a player is leaving a bed.
class	PlayerBucketActorEvent Represents an event that is called when a player captures an actor in a bucket.
class	PlayerBucketEmptyEvent Called when a player empties a bucket.
class	PlayerBucketEvent Provides common data for events involving a player's bucket interaction.
class	PlayerBucketFillEvent Called when a player fills a bucket.
class	PlayerChatEvent Called when a player sends a chat message.
class	PlayerCommandEvent Called whenever a player runs a command.
class	PlayerCraftItemEvent Called when a player crafts an item, either inside a crafting grid or straight from the recipe book.
class	PlayerDeathEvent Called when a Player dies.
class	PlayerDimensionChangeEvent Called when a player switches to another dimension.
class	PlayerDropItemEvent Called when a player drops an item from their inventory.
class	PlayerEditBookEvent Called when a player edits or signs a book.
class	PlayerEmoteEvent Called when a player uses an emote.
class	PlayerEvent Represents a player related event.
class	PlayerExpChangeEvent Called when a player's experience changes.
class	PlayerGameModeChangeEvent Called when the GameMode of the player is changed.
class	PlayerHideActorEvent Called when a visible actor is hidden from a player.
class	PlayerInputEvent Called when a player sends updated input to the server.
class	PlayerInteractActorEvent Called when a player right-clicks an actor.
class	PlayerInteractEvent Called when a player interacts with an object or air.
class	PlayerInventory Interface to the inventory of a Player , including the four armor slots and any extra slots.
class	PlayerItemConsumeEvent Called when a player is finishing consuming an item (food, potion, milk bucket).
class	PlayerItemHeldEvent Called when a player changes their currently held item.
class	PlayerJoinEvent Called when a player joins a server.
class	PlayerJumpEvent Called when a player jumps.
class	PlayerKickEvent Called when a player gets kicked from the server.
class	PlayerLevelChangeEvent Called when a player's level changes.
class	PlayerLoginEvent Called when a player attempts to login in.
class	PlayerMoveEvent Called when a player moves.
class	PlayerOpenSignEvent Called when a player begins editing a sign's text.
class	PlayerPickupArrowEvent Called when a player picks up an arrow or a thrown trident from the ground.
class	PlayerPickupExperienceEvent Called when a player picks up an experience orb.
class	PlayerPickupItemEvent Called when a player picks an item up from the ground.
class	PlayerPortalEvent Called when a player is about to teleport because it is in contact with a portal.
class	PlayerQuitEvent Called when a player leaves a server.
class	PlayerRecipeBookSettingsChangeEvent Called when a player changes recipe book settings.
class	PlayerRespawnEvent Called when a player respawns.
class	PlayerRiptideEvent Called when a player activates the riptide enchantment, using their trident to propel them through the air.
class	PlayerSetSpawnEvent Called when a player's spawn is set, either by themselves or otherwise.
class	PlayerShearActorEvent Called when a player shears an Actor .
class	PlayerShowActorEvent Called when a hidden actor is shown to a player.
class	PlayerSkinChangeEvent Called when a player changes their skin.
class	PlayerTeleportEvent Called when a player is teleported from one location to another.
class	PlayerToggleCrawlEvent Called when a player toggles their crawling state.
class	PlayerToggleFlightEvent Called when a player toggles their flying state.
class	PlayerToggleSneakEvent Called when a player toggles their sneaking state.
class	PlayerToggleSprintEvent Called when a player toggles their sprinting state.
class	Plugin Represents a Plugin .
class	PluginCommand Represents a Command belonging to aPlugin .
class	PluginDescription Represents the basic information about a plugin that the plugin loader needs to know.
class	PluginDisableEvent Called when a plugin is disabled.
class	PluginEnableEvent Called when a plugin is enabled.
class	PluginLoader Represents a plugin loader, which handles direct access to specific types of plugins.
class	PluginManager Represents a plugin manager that handles all plugins from the Server .
class	PotionMeta Represents the metadata for a potion item.
class	PotionType Represents a potion type.
class	Preconditions Static helpers for validating method arguments and object state.
class	PrepareItemEnchantEvent Called when an enchanting table prepares offers for an item.
class	ProxiedCommandSender Represents a command sender that is running a command on behalf of another one, as `/execute` does.
class	Recipe Represents some type of crafting recipe.
class	RecipeIngredient Represents a potential item match within a recipe.
class	Registry <typename T> Abstract registry interface for objects with identifiers.
class	Scheduler Represents a scheduler that executes various tasks.
class	Score Represents a score for an objective on a scoreboard.
class	Scoreboard Represents a scoreboard.
class	ScriptMessageEvent Called when a message is sent by `/scriptevent` command.
class	Server Represents a server implementation.
class	ServerCommandEvent Called when a command is run by a non-player, early in the command handling process.
class	ServerEvent Represents a Server-related event.
class	ServerListPingEvent Called when a server ping is coming in.
class	ServerLoadEvent Called when either the server startup or reload has completed.
class	Service Services represent a list of methods.
class	ServiceManager Represent a service manager that manages services and service providers.
class	ShapedRecipe Represents a shaped (ie normal) crafting recipe.
class	ShapelessRecipe Represents a shapeless recipe, where the arrangement of the ingredients on the crafting grid does not matter.
class	Sign Represents a captured state of a sign.
class	SignSide Represents a side of a sign.
class	SimpleBarChart A bStats bar chart with a single bar per category.
class	SimplePie A bStats pie chart with a single value.
class	SingleLineChart A bStats line chart with a single line.
class	Skin Represents a player skin.
class	Slider Represents a slider with a label.
class	SmithingRecipe Represents a smithing recipe.
class	SmithingTransformRecipe Represents a smithing transform recipe.
class	SmithingTrimRecipe Represents a smithing trim recipe.
class	SmokingRecipe Represents a smoking recipe.
class	SocketAddress Represents an IP Socket Address (hostname + port number).
class	StepSlider Represents a step slider with a set of predefined options.
class	Task Represents a task being executed by the scheduler.
class	TextInput Represents a text input field.
class	ThunderChangeEvent Called when the thunder state in a world is changing.
class	Toggle Represents a toggle button with a label.
class	Translatable Represents an object with a text representation that can be translated by the Minecraft client.
class	UUID Implementation of Universally Unique Identifier (UUID ).
class	UnknownCommandEvent Called when a command sender executes a command that is not defined.
class	Vector Represents a 3-dimensional vector.
class	WeatherChangeEvent Called when the weather (rain) state in a world is changing.
class	WeatherEvent Represents a Weather-related event.
class	WritableBookMeta Represents the meta for a writable book that can have pages.
struct	overloaded <Func> Helper type for visitors.

Public Types¶

Type	Name
typedef std::variant< bool, float >	AbilityValue
typedef Identifier< ActorType >	ActorTypeId
typedef Identifier< class Attribute >	AttributeId
typedef Identifier< class AttributeModifier >	AttributeModifierId
enum	BarColor Represents the color of a boss bar.
enum	BarFlag Represents an optional flag that changes the appearance or behaviour of a boss bar.
enum	BarStyle Represents the segment style of a boss bar.
typedef Identifier< Biome >	BiomeId
enum	BlockFace Represents the face of a block.
typedef std::unordered_map< std::string, std::variant< bool, std::string, int > >	BlockStates
typedef Identifier< BlockType >	BlockTypeId
typedef nbt::ArrayTag< std::uint8_t >	ByteArrayTag
typedef nbt::ValueTag< std::uint8_t >	ByteTag
typedef Identifier< Dimension >	DimensionId
enum	DisplaySlot Locations for displaying objectives to the player.
typedef nbt::ValueTag< double >	DoubleTag
typedef Identifier< EffectType >	EffectId
typedef Identifier< class Enchantment >	EnchantmentId
enum	EquipmentSlot Represents the equipment slots on an entity.
enum	EventPriority Represents an event's priority in execution.
enum	EventResult Represents the result a plugin can apply to an event whose default behaviour can be allowed, denied, or left to the server.
typedef nbt::ValueTag< float >	FloatTag
enum	GameMode Represents the various type of game modes that Players may have.
typedef std::variant< bool, int, float >	GameRuleValue
typedef nbt::ArrayTag< std::int32_t >	IntArrayTag
typedef nbt::ValueTag< std::int32_t >	IntTag
typedef Identifier< ItemType >	ItemTypeId Represents an item type.
typedef nlohmann::json::array_t	JsonArray
typedef nlohmann::json::object_t	JsonObject
typedef nlohmann::json	JsonValue
typedef nbt::ValueTag< std::int64_t >	LongTag
typedef std::variant< std::string, Translatable >	Message A message that is either a plain string or a Translatable that is resolved client-side.
enum	ObjectiveSortOrder Represents the sort order of objectives on a DisplaySlot.
enum	PermissionDefault Represents the possible default values for permissions.
enum	PermissionLevel Represents the permission level of a Permissible .
typedef std::function< void(const NotNull< PermissionAttachment > &)>	PermissionRemovedExecutor
enum	PluginLoadOrder Represents the order in which a plugin should be initialized and enabled.
typedef Identifier< PotionType >	PotionId
enum std::uint8_t	RenderType Controls the way in which an Objective is rendered on the client side.
typedef nonstd::expected< T, std::string >	Result Holds either a value of type T on success or an error message on failure.
enum	Rotation Represents a rotation based orientation, like that on a clock.
typedef std::variant< std::string, NotNull< Player >, NotNull< Actor > >	ScoreEntry An entry for a score.
enum	ServicePriority Represents various priorities of a provider.
typedef nbt::ValueTag< std::int16_t >	ShortTag
typedef nbt::ValueTag< std::string >	StringTag
typedef std::uint32_t	TaskId

Public Functions¶

Type	Name
std::size_t	hash_value (UUID const & u) noexcept
bool	operator!= (const ListTag & a, const ListTag & b) noexcept
bool	operator!= (const CompoundTag & a, const CompoundTag & b) noexcept
bool	operator!= (UUID const & lhs, UUID const & rhs) noexcept
bool	operator< (UUID const & lhs, UUID const & rhs) noexcept
bool	operator<= (UUID const & lhs, UUID const & rhs) noexcept
bool	operator== (const ListTag & a, const ListTag & b) noexcept
bool	operator== (const CompoundTag & a, const CompoundTag & b) noexcept
bool	operator== (const NotNull< T > & lhs, const Nullable< U > & rhs) noexcept
bool	operator== (const Nullable< T > & lhs, const NotNull< U > & rhs) noexcept
bool	operator== (UUID const & lhs, UUID const & rhs) noexcept
bool	operator> (UUID const & lhs, UUID const & rhs) noexcept
bool	operator>= (UUID const & lhs, UUID const & rhs) noexcept
	overloaded (Func...) Deduction guide.
void	swap (UUID & lhs, UUID & rhs) noexcept

Public Types Documentation¶

typedef AbilityValue¶

using endstone::AbilityValue = typedef std::variant<bool, float>;

typedef ActorTypeId¶

using endstone::ActorTypeId = typedef Identifier<ActorType>;

typedef AttributeId¶

using endstone::AttributeId = typedef Identifier<class Attribute>;

typedef AttributeModifierId¶

using endstone::AttributeModifierId = typedef Identifier<class AttributeModifier>;

enum BarColor¶

Represents the color of a boss bar.

enum endstone::BarColor {
    Pink = 0,
    Blue = 1,
    Red = 2,
    Green = 3,
    Yellow = 4,
    Purple = 5,
    RebeccaPurple = 6,
    White = 7
};

enum BarFlag¶

Represents an optional flag that changes the appearance or behaviour of a boss bar.

enum endstone::BarFlag {
    DarkenSky,
    CreateFog
};

enum BarStyle¶

Represents the segment style of a boss bar.

enum endstone::BarStyle {
    Solid,
    Segmented6,
    Segmented10,
    Segmented12,
    Segmented20
};

typedef BiomeId¶

using endstone::BiomeId = typedef Identifier<Biome>;

enum BlockFace¶

Represents the face of a block.

enum endstone::BlockFace {
    Down,
    Up,
    North,
    South,
    West,
    East,
    Self
};

typedef BlockStates¶

using endstone::BlockStates = typedef std::unordered_map<std::string, std::variant<bool, std::string, int> >;

typedef BlockTypeId¶

typedef Identifier< BlockType > endstone::BlockTypeId;

typedef ByteArrayTag¶

using endstone::ByteArrayTag = typedef nbt::ArrayTag<std::uint8_t>;

typedef ByteTag¶

using endstone::ByteTag = typedef nbt::ValueTag<std::uint8_t>;

typedef DimensionId¶

typedef Identifier< class Dimension > endstone::DimensionId;

enum DisplaySlot¶

Locations for displaying objectives to the player.

enum endstone::DisplaySlot {
    BelowName,
    PlayerList,
    SideBar
};

typedef DoubleTag¶

using endstone::DoubleTag = typedef nbt::ValueTag<double>;

typedef EffectId¶

using endstone::EffectId = typedef Identifier<EffectType>;

typedef EnchantmentId¶

using endstone::EnchantmentId = typedef Identifier<class Enchantment>;

enum EquipmentSlot¶

Represents the equipment slots on an entity.

enum endstone::EquipmentSlot {
    Hand,
    OffHand,
    Feet,
    Legs,
    Chest,
    Head,
    Body
};

enum EventPriority¶

Represents an event's priority in execution.

enum endstone::EventPriority {
    Lowest = 0,
    Low = 1,
    Normal = 2,
    High = 3,
    Highest = 4,
    Monitor = 5
};

Listeners with lower priority are called first will listeners with higher priority are called last. Listeners are called in following order: LOWEST -> LOW -> NORMAL -> HIGH -> HIGHEST -> MONITOR

enum EventResult¶

Represents the result a plugin can apply to an event whose default behaviour can be allowed, denied, or left to the server.

enum endstone::EventResult {
    Deny,
    Default,
    Allow
};

typedef FloatTag¶

using endstone::FloatTag = typedef nbt::ValueTag<float>;

enum GameMode¶

Represents the various type of game modes that Players may have.

enum endstone::GameMode {
    Survival = 0,
    Creative = 1,
    Adventure = 2,
    Spectator = 3
};

typedef GameRuleValue¶

using endstone::GameRuleValue = typedef std::variant<bool, int, float>;

typedef IntArrayTag¶

using endstone::IntArrayTag = typedef nbt::ArrayTag<std::int32_t>;

typedef IntTag¶

using endstone::IntTag = typedef nbt::ValueTag<std::int32_t>;

typedef ItemTypeId¶

Represents an item type.

using endstone::ItemTypeId = typedef Identifier<ItemType>;

typedef JsonArray¶

using endstone::JsonArray = typedef nlohmann::json::array_t;

typedef JsonObject¶

using endstone::JsonObject = typedef nlohmann::json::object_t;

typedef JsonValue¶

using endstone::JsonValue = typedef nlohmann::json;

typedef LongTag¶

using endstone::LongTag = typedef nbt::ValueTag<std::int64_t>;

typedef Message¶

A message that is either a plain string or a Translatable that is resolved client-side.

using endstone::Message = typedef std::variant<std::string, Translatable>;

enum ObjectiveSortOrder¶

Represents the sort order of objectives on a DisplaySlot.

enum endstone::ObjectiveSortOrder {
    Ascending,
    Descending
};

enum PermissionDefault¶

Represents the possible default values for permissions.

enum endstone::PermissionDefault {
    True,
    False,
    Operator,
    NotOperator,
    Console
};

enum PermissionLevel¶

Represents the permission level of a Permissible .

enum endstone::PermissionLevel {
    Default = 0,
    Operator = 1,
    Console = 2
};

typedef PermissionRemovedExecutor¶

using endstone::PermissionRemovedExecutor = typedef std::function<void(const NotNull<PermissionAttachment> &)>;

enum PluginLoadOrder¶

Represents the order in which a plugin should be initialized and enabled.

enum endstone::PluginLoadOrder {
    Startup,
    PostWorld
};

typedef PotionId¶

using endstone::PotionId = typedef Identifier<PotionType>;

enum RenderType¶

Controls the way in which an Objective is rendered on the client side.

enum endstone::RenderType {
    Integer,
    Hearts
};

typedef Result¶

Holds either a value of type T on success or an error message on failure.

using endstone::Result = typedef nonstd::expected<T, std::string>;

enum Rotation¶

Represents a rotation based orientation, like that on a clock.

enum endstone::Rotation {
    None = 0,
    Clockwise45 = 1,
    Clockwise = 2,
    Clockwise135 = 3,
    Flipped = 4,
    Flipped45 = 5,
    CounterClockwise = 6,
    CounterClockwise45 = 7
};

It represents how something is viewed, as opposed to cardinal directions.

typedef ScoreEntry¶

An entry for a score.

using endstone::ScoreEntry = typedef std::variant<std::string, NotNull<Player>, NotNull<Actor> >;

enum ServicePriority¶

Represents various priorities of a provider.

enum endstone::ServicePriority {
    Lowest,
    Low,
    Normal,
    High,
    Highest
};

typedef ShortTag¶

using endstone::ShortTag = typedef nbt::ValueTag<std::int16_t>;

typedef StringTag¶

using endstone::StringTag = typedef nbt::ValueTag<std::string>;

typedef TaskId¶

using endstone::TaskId = typedef std::uint32_t;

Public Functions Documentation¶

function hash_value¶

inline std::size_t endstone::hash_value (
    UUID  const & u
) noexcept

function operator!=¶

inline bool endstone::operator!= (
    const  ListTag & a,
    const  ListTag & b
) noexcept

function operator!=¶

inline bool endstone::operator!= (
    const  CompoundTag & a,
    const  CompoundTag & b
) noexcept

function operator!=¶

inline bool endstone::operator!= (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function operator<¶

inline bool endstone::operator< (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function operator<=¶

inline bool endstone::operator<= (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function operator==¶

inline bool endstone::operator== (
    const  ListTag & a,
    const  ListTag & b
) noexcept

function operator==¶

inline bool endstone::operator== (
    const  CompoundTag & a,
    const  CompoundTag & b
) noexcept

function operator==¶

template<class T, class U>
bool endstone::operator== (
    const  NotNull < T > & lhs,
    const  Nullable < U > & rhs
) noexcept

function operator==¶

template<class T, class U>
bool endstone::operator== (
    const  Nullable < T > & lhs,
    const  NotNull < U > & rhs
) noexcept

function operator==¶

inline bool endstone::operator== (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function operator>¶

inline bool endstone::operator> (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function operator>=¶

inline bool endstone::operator>= (
    UUID  const & lhs,
    UUID  const & rhs
) noexcept

function overloaded¶

Deduction guide.

template<typename... Func>
endstone::overloaded (
    Func...
)

Template parameters:

Func Types of function objects.

function swap¶

inline void endstone::swap (
    UUID & lhs,
    UUID & rhs
) noexcept

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