Namespace endstone¶

Represents a button with text and an optional icon.

Namespaces¶

Type	Name
namespace	core
namespace	detail
namespace	nbt

Classes¶

Type	Name
class	ActionForm Represents a form with buttons that let the player take action.
class	Actor Represents a base actor in the level.
class	ActorDamageEvent Called when an Actor is damaged.
class	ActorDeathEvent Called when an Actor dies.
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	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	Attribute All attribute types.
class	AttributeInstance Represents a mutable instance of an attribute and its associated modifiers and values.
class	AttributeModifier Represents an attribute modifier.
class	BanEntry A single entry from a ban list.
class	BanList <typename T> Represents a ban list, containing bans.
class	Block Represents a block.
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	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	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	Cancellable <typename EventType> A type characterizing events that may be cancelled by a plugin or the server.
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	Color Represents a color with red, green, blue, and alpha components.
struct	ColorFormat All supported color and format codes.
class	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	CompoundTag
class	ConsoleCommandSender Represents a console command sender.
class	Criteria Represents a scoreboard criteria.
class	DamageSource Represents a source of damage.
class	Dimension Represents a dimension within a Level .
class	DimensionEvent Represents events within a level.
class	Divider Represents a divider.
class	Dropdown Represents a dropdown with a set of predefined options.
class	EffectType All effect types.
class	Enchantment
class	Event Represents an event.
class	EventHandler Represents a registered EventHandler which associates with aPlugin .
class	Form <typename T> Represents a generic form.
class	HandlerList A list of event handlers. Should be instantiated on a per-event basis.
class	Header Represents a header with a label.
class	ICancellable
class	IRegistry
class	Identifier <typename T> Represents a identifier consisting of two components: a namespace and a key.
class	Image Represents an RGBA image.
class	Inventory Interface to the various inventories.
class	IpBanEntry
class	IpBanList Represents a ban list, containing banned IP addresses.
class	Item Represents a base actor in the level.
class	ItemFactory
class	ItemMeta Represents the metadata of a generic item.
class	ItemStack Represents a stack of items.
class	ItemType
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	Level Represents a level, which may contain actors, chunks and blocks.
class	LevelEvent Represents events within a level.
class	ListTag
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	Mob Represents a mobile entity (i.e. living entity), such as a monster or player.
class	ModalForm Represents a modal form with controls.
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	PlayerBanEntry
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	PlayerChatEvent Called when a player sends a chat message.
class	PlayerCommandEvent Called whenever a player runs a command.
class	PlayerDeathEvent Called when a Player dies.
class	PlayerDropItemEvent Called when a player drops an item from their inventory.
class	PlayerEmoteEvent Called when a player uses an emote.
class	PlayerEvent Represents a player related event.
class	PlayerGameModeChangeEvent Called when the GameMode of the player is changed.
class	PlayerInteractActorEvent Represents an event that is called when a player right-clicks an actor.
class	PlayerInteractEvent Represents an event that is called when a player right-clicks a block.
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	PlayerLoginEvent Called when a player attempts to login in.
class	PlayerMoveEvent Called when a player moves.
class	PlayerPickupItemEvent Called when a player picks an item up from the ground.
class	PlayerQuitEvent Called when a player leaves a server.
class	PlayerRespawnEvent Called when a player respawns.
class	PlayerSkinChangeEvent Called when a player changes their skin.
class	PlayerTeleportEvent Called when a player is teleported from one location to another.
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	PotionType All potion types.
class	Recipe Represents some type of crafting 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 the console runs a command, early in the 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	Skin Represents a player skin.
class	Slider Represents a slider with a label.
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	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.
struct	overloaded <Func> Helper type for visitors.

Public Types¶

Type	Name
typedef Identifier< class Attribute >	AttributeId
enum	BarColor
enum	BarFlag
enum	BarStyle
enum	BlockFace
typedef std::unordered_map< std::string, std::variant< bool, std::string, int > >	BlockStates
typedef nbt::ArrayTag< std::uint8_t >	ByteArrayTag
typedef nbt::ValueTag< std::uint8_t >	ByteTag
enum	DisplaySlot Locations for displaying objectives to the player.
typedef nbt::ValueTag< double >	DoubleTag
typedef Identifier< class EffectType >	EffectId
typedef Identifier< class Enchantment >	EnchantmentId
enum	EquipmentSlot
enum	EventPriority Represents an event's priority in execution.
enum	EventResult
typedef nbt::ValueTag< float >	FloatTag
enum	GameMode Represents the various type of game modes that Players may have.
typedef nbt::ArrayTag< std::int32_t >	IntArrayTag
typedef nbt::ValueTag< std::int32_t >	IntTag
typedef Identifier< ItemType >	ItemId Represents an item type.
typedef nbt::ValueTag< std::int64_t >	LongTag
typedef std::variant< std::string, Translatable >	Message
enum	ObjectiveSortOrder Represents the sort order of objectives on a DisplaySlot.
enum	PermissionDefault Represents the possible default values for permissions.
enum	PermissionLevel
typedef std::function< void(const PermissionAttachment &)>	PermissionRemovedExecutor
enum	PluginLoadOrder Represents the order in which a plugin should be initialized and enabled.
typedef Identifier< class 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
typedef std::variant< Player , Actor* *, std::string >	ScoreEntry
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== (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 AttributeId¶

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

enum BarColor¶

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

enum BarFlag¶

enum endstone::BarFlag {
    DarkenSky,
    Count
};

enum BarStyle¶

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

enum BlockFace¶

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

typedef BlockStates¶

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

typedef ByteArrayTag¶

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

typedef ByteTag¶

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

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<class EffectType>;

typedef EnchantmentId¶

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

enum EquipmentSlot¶

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¶

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 IntArrayTag¶

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

typedef IntTag¶

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

typedef ItemId¶

Represents an item type.

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

typedef LongTag¶

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

typedef Message¶

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¶

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

typedef PermissionRemovedExecutor¶

using endstone::PermissionRemovedExecutor = typedef std::function<void(const 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<class PotionType>;

enum RenderType¶

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

enum endstone::RenderType {
    Integer,
    Hearts
};

typedef Result¶

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

typedef ScoreEntry¶

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

An entry for a score.

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==¶

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/actor/actor.h