endstone

Classes

Name	Description
`ColorFormat`	All supported color and format codes.
`IRegistry`
`Identifier`	Represents a identifier consisting of two components: a namespace and a key.
`Logger`	Logger class which can format and output varies levels of logs.
`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.
`Player`	Represents a player.
`Preconditions`
`Registry`	Abstract registry interface for objects with identifiers.
`Server`	Represents a server implementation.
`Skin`	Represents a player skin.
`Type`	CRTP base for registry-backed types identified by an Identifier.
`overloaded`	Helper type for visitors.

Enums

Name	Description
`GameMode`	Represents the various type of game modes that Players may have.

Type Aliases

Name	Description
`Message`

Functions

Name	Description
`overloaded`	Deduction guide.

`struct`ColorFormat

Defined in <endstone/color_format.h>

All supported color and format codes.

Variables

Name	Description
`Escape`
`Black`
`DarkBlue`
`DarkGreen`
`DarkAqua`
`DarkRed`
`DarkPurple`
`Gold`
`Gray`
`DarkGray`
`Blue`
`Green`
`Aqua`
`Red`
`LightPurple`
`Yellow`
`White`
`MinecoinGold`
`MaterialQuartz`
`MaterialIron`
`MaterialNetherite`
`MaterialRedstone`
`MaterialCopper`
`MaterialGold`
`MaterialEmerald`
`MaterialDiamond`
`MaterialLapis`
`MaterialAmethyst`
`MaterialResin`
`Obfuscated`
`Bold`
`Italic`
`Reset`

`var`Escapestatic

const std::string Escape

`var`Blackstatic

const std::string Black

`var`DarkBluestatic

const std::string DarkBlue

`var`DarkGreenstatic

const std::string DarkGreen

`var`DarkAquastatic

const std::string DarkAqua

`var`DarkRedstatic

const std::string DarkRed

`var`DarkPurplestatic

const std::string DarkPurple

`var`Goldstatic

const std::string Gold

`var`Graystatic

const std::string Gray

`var`DarkGraystatic

const std::string DarkGray

`var`Bluestatic

const std::string Blue

`var`Greenstatic

const std::string Green

`var`Aquastatic

const std::string Aqua

`var`Redstatic

const std::string Red

`var`LightPurplestatic

const std::string LightPurple

`var`Yellowstatic

const std::string Yellow

`var`Whitestatic

const std::string White

`var`MinecoinGoldstatic

const std::string MinecoinGold

`var`MaterialQuartzstatic

const std::string MaterialQuartz

`var`MaterialIronstatic

const std::string MaterialIron

`var`MaterialNetheritestatic

const std::string MaterialNetherite

`var`MaterialRedstonestatic

const std::string MaterialRedstone

`var`MaterialCopperstatic

const std::string MaterialCopper

`var`MaterialGoldstatic

const std::string MaterialGold

`var`MaterialEmeraldstatic

const std::string MaterialEmerald

`var`MaterialDiamondstatic

const std::string MaterialDiamond

`var`MaterialLapisstatic

const std::string MaterialLapis

`var`MaterialAmethyststatic

const std::string MaterialAmethyst

`var`MaterialResinstatic

const std::string MaterialResin

`var`Obfuscatedstatic

const std::string Obfuscated

`var`Boldstatic

const std::string Bold

`var`Italicstatic

const std::string Italic

`var`Resetstatic

const std::string Reset

`class`IRegistry

Defined in <endstone/registry.h>

Methods

Name	Description
`~IRegistry`

`meth`~IRegistryvirtual

~IRegistry() =default

`class`Identifier

Defined in <endstone/identifier.h>

Represents a identifier consisting of two components: a namespace and a key.

Variables

Name	Description
`Minecraft`	The namespace representing all inbuilt keys.

Methods

Name	Description
`Identifier`
`Identifier`
`Identifier`
`Identifier`
`getNamespace`
`getKey`
`operator==`
`operator!=`
`operator std::string`
`minecraft`

`var`Minecraftstaticconstexpr

std::string_view Minecraft

The namespace representing all inbuilt keys.

`meth`Identifierconstexprnoexcept

constexpr Identifier(const char* s) noexcept

`meth`Identifierconstexprnoexcept

constexpr Identifier(const std::string& s) noexcept

`meth`Identifierconstexprnoexcept

constexpr Identifier(const std::string_view& identifier) noexcept

`meth`Identifierconstexprnoexcept

constexpr Identifier(const std::string_view& namespace_, const std::string_view& key) noexcept

`meth`getNamespaceconstconstexprnoexcept

std::string_view getNamespace() const noexcept

`meth`getKeyconstconstexprnoexcept

std::string_view getKey() const noexcept

`meth`operator==constconstexprnoexcept

bool operator==(const Identifier& other) const noexcept

`meth`operator!=constconstexprnoexcept

bool operator!=(const Identifier& other) const noexcept

`meth`operator std::stringconst

operator std::string() const

`meth`minecraftstaticconstexprnoexcept

Identifier minecraft(const std::string_view key) noexcept

`class`Logger

Defined in <endstone/logger.h>

Logger class which can format and output varies levels of logs.

Enums

Name	Description
`Level`	Specifies the log level.

Methods

Name	Description
`Logger`
`~Logger`
`setLevel`	Set the logging level for this Logger instance.
`isEnabledFor`	Check if the Logger instance is enabled for the given log Level.
`getName`	Get the name of this Logger instance.
`log`	Log a message at the given level.
`log`
`trace`
`trace`
`debug`
`debug`
`info`
`info`
`warning`
`warning`
`error`
`error`
`critical`
`critical`

`enum`Level

std::uint8_t Level

Specifies the log level.

Values

Name	Value	Description
`Trace`	`0`
`Debug`	`1`
`Info`	`2`
`Warning`	`3`
`Error`	`4`
`Critical`	`5`
`Off`	`6`

`meth`Logger

Logger() =default

`meth`~Loggervirtual

~Logger() =default

`meth`setLevelabstract

void setLevel(Level level) =0

Set the logging level for this Logger instance.

Parameters

Name	Type	Description
`level`	`Level`	The desired log level

`meth`isEnabledForabstractconst

bool isEnabledFor(Level level) const =0

Check if the Logger instance is enabled for the given log Level.

Parameters

Name	Type	Description
`level`	`Level`	The log level to check

Returns

Type	Description
`bool`	true if the logger is enabled for the Level, false otherwise.

`meth`getNameabstractconst

std::string_view getName() const =0

Get the name of this Logger instance.

Returns

Type	Description
`std::string_view`	The name of this Logger instance.

`meth`logabstractconst

void log(Level level, std::string_view message) const =0

Log a message at the given level.

Parameters

Name	Type	Description
`level`	`Level`	The level at which the message should be logged.
`message`	`std::string_view`	The message to log.

`meth`logconst

void log(Level level, const std::format_string<Args...> format, Args&&... args) const

`meth`traceconst

void trace(const std::string_view message) const

`meth`traceconst

void trace(const std::format_string<Args...> format, Args&&... args) const

`meth`debugconst

void debug(const std::string_view message) const

`meth`debugconst

void debug(const std::format_string<Args...> format, Args&&... args) const

`meth`infoconst

void info(const std::string_view message) const

`meth`infoconst

void info(const std::format_string<Args...> format, Args&&... args) const

`meth`warningconst

void warning(const std::string_view message) const

`meth`warningconst

void warning(const std::format_string<Args...> format, Args&&... args) const

`meth`errorconst

void error(const std::string_view message) const

`meth`errorconst

void error(const std::format_string<Args...> format, Args&&... args) const

`meth`criticalconst

void critical(const std::string_view message) const

`meth`criticalconst

void critical(const std::format_string<Args...> format, Args&&... args) const

`class`OfflinePlayer

Defined in <endstone/offline_player.h>

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.

Methods

Name	Description
`~OfflinePlayer`
`getName`	Returns the name of this player.
`getUniqueId`	Returns the UUID of this player.

`meth`~OfflinePlayervirtual

~OfflinePlayer() =default

`meth`getNameabstractconst

std::string getName() const =0

Returns the name of this player.

Returns

Type	Description
`std::string`	Player name or null if we have not seen a name for this player yet

`meth`getUniqueIdabstractconst

UUID getUniqueId() const =0

Returns the UUID of this player.

Returns

Type	Description
`UUID`	Player UUID

`class`Player

Defined in <endstone/player.h>

Bases: Mob, OfflinePlayer

Represents a player.

Type Aliases

Name	Description
`FormVariant`

Methods

Name	Description
`getName`	Returns the name of this player.
`isOp`	Checks if this player is a server operator.
`setOp`	Sets the operator status of this player.
`getXuid`	Returns the Xbox User ID (XUID) of this player.
`getAddress`	Gets the socket address of this player.
`transfer`	Transfers the player to another server.
`kick`	Kicks player with custom kick message.
`performCommand`	Makes the player perform the given command.
`isSneaking`	Returns if the player is in sneak mode.
`setSneaking`	Sets the sneak mode of the player.
`isSprinting`	Gets whether the player is sprinting or not.
`setSprinting`	Sets whether the player is sprinting or not.
`playSound`	Play a sound for a player at the location.
`stopSound`	Stop the specified sound from playing.
`stopAllSounds`	Stop all sounds from playing.
`giveExp`	Gives the player the amount of experience specified.
`giveExpLevels`	Gives the player the amount of experience levels specified.
`getExpProgress`	Gets the players current experience progress towards the next level.
`setExpProgress`	Sets the players current experience progress towards the next level.
`getExpLevel`	Gets the players current experience level.
`setExpLevel`	Sets the players current experience level.
`getTotalExp`	Gets the players total experience points.
`getAllowFlight`	Determines if the Player is allowed to fly via jump key double-tap.
`setAllowFlight`	Sets if the Player is allowed to fly via jump key double-tap.
`isFlying`	Checks to see if this player is currently flying or not.
`setFlying`	Makes this player start or stop flying.
`getFlySpeed`	Gets the current allowed speed that a client can fly.
`setFlySpeed`
`getWalkSpeed`	Gets the current allowed speed that a client can walk.
`setWalkSpeed`
`getScoreboard`	Gets the Scoreboard displayed to this player.
`setScoreboard`
`sendPopup`	Sends this player a popup message.
`sendTip`	Sends this player a tip message.
`sendToast`	Sends this player a toast notification.
`sendTitle`	Sends a title and a subtitle message to the player. If they are empty strings, the display will be updated as such. The titles will be displayed with the default timings.
`sendTitle`	Sends a title and a subtitle message to the player. If they are empty strings, the display will be updated as such.
`resetTitle`	Resets the title displayed to the player. This will clear the displayed title / subtitle and reset timings to their default values.
`spawnParticle`	Spawns the particle at the target location.
`spawnParticle`	Spawns the particle at the target location.
`spawnParticle`	Spawns the particle at the target location.
`spawnParticle`	Spawns the particle at the target location.
`getPing`	Gets the player's average ping.
`getLocale`	Gets the player's current locale.
`updateCommands`	Send the list of commands to the client.
`getInventory`	Get the player's inventory.
`getEnderChest`	Get the player's EnderChest inventory.
`getGameMode`	Gets this player's current GameMode.
`setGameMode`	Sets this player's current GameMode.
`getDeviceOS`	Gets the player's current device's operation system (OS).
`getDeviceId`	Gets the player's current device id.
`getGameVersion`	Gets the player's current game version.
`getSkin`	Gets the player's skin.
`sendForm`	Sends a form to the player.
`closeForm`	Closes the forms that are currently open for the player.
`sendPacket`	Sends a packet to the player.
`sendMap`	Render a map and send it to the player in its entirety.

`type`FormVariantprotected

std::variant<MessageForm, ActionForm, ModalForm> FormVariant

`meth`getNameabstractconstoverride

std::string getName() const override=0

Returns the name of this player.

Returns

Type	Description
`std::string`	Player name or null if we have not seen a name for this player yet

`meth`isOpabstractconst

bool isOp() const =0

Checks if this player is a server operator.

Returns

Type	Description
`bool`	true if this is an operator, otherwise false

`meth`setOpabstract

void setOp(bool value) =0

Sets the operator status of this player.

Parameters

Name	Type	Description
`value`	`bool`	New operator value

`meth`getXuidabstractconst

std::string getXuid() const =0

Returns the Xbox User ID (XUID) of this player.

Returns

Type	Description
`std::string`	Player XUID

`meth`getAddressabstractconst

SocketAddress getAddress() const =0

Gets the socket address of this player.

Returns

Type	Description
`SocketAddress`	the player's socket address

`meth`transferabstractconst

void transfer(std::string host, int port) const =0

Transfers the player to another server.

Parameters

Name	Type	Description
`host`	`std::string`	Server address to transfer the player to.
`port`	`int`	Server port to transfer the player to

`meth`kickabstractconst

void kick(std::string message) const =0

Kicks player with custom kick message.

Parameters

Name	Type	Description
`message`	`std::string`	kick message

`meth`performCommandabstractconst

bool performCommand(std::string command) const =0

Makes the player perform the given command.

Parameters

Name	Type	Description
`command`	`std::string`	Command to perform

Returns

Type	Description
`bool`	true if the command was successful, otherwise false

`meth`isSneakingabstractconst

bool isSneaking() const =0

Returns if the player is in sneak mode.

Returns

Type	Description
`bool`	true if player is in sneak mode

`meth`setSneakingabstract

void setSneaking(bool sneak) =0

Sets the sneak mode of the player.

Parameters

Name	Type	Description
`sneak`	`bool`	true if player should appear sneaking

`meth`isSprintingabstractconst

bool isSprinting() const =0

Gets whether the player is sprinting or not.

Returns

Type	Description
`bool`	true if player is sprinting.

`meth`setSprintingabstract

void setSprinting(bool sprinting) =0

Sets whether the player is sprinting or not.

Parameters

Name	Type	Description
`sprinting`	`bool`	true if the player should be sprinting

`meth`playSoundabstract

void playSound(Location location, std::string sound, float volume, float pitch) =0

Play a sound for a player at the location.

Parameters

Name	Type	Description
`location`	`Location`	The location to play the sound
`sound`	`std::string`	The internal sound name to play
`volume`	`float`	The volume of the sound
`pitch`	`float`	The pitch of the sound

`meth`stopSoundabstract

void stopSound(std::string sound) =0

Stop the specified sound from playing.

Parameters

Name	Type	Description
`sound`	`std::string`	the sound to stop

`meth`stopAllSoundsabstract

void stopAllSounds() =0

Stop all sounds from playing.

`meth`giveExpabstract

void giveExp(int amount) =0

Gives the player the amount of experience specified.

Parameters

Name	Type	Description
`amount`	`int`	Exp amount to give

`meth`giveExpLevelsabstract

void giveExpLevels(int amount) =0

Gives the player the amount of experience levels specified.

Parameters

Name	Type	Description
`amount`	`int`	amount of experience levels to give or take

`meth`getExpProgressabstractconst

float getExpProgress() const =0

Gets the players current experience progress towards the next level.

This is a percentage value. 0.0 is "no progress" and 1.0 is "next level".

Returns

Type	Description
`float`	Current experience points

`meth`setExpProgressabstract

void setExpProgress(float progress) =0

Sets the players current experience progress towards the next level.

This is a percentage value. 0.0 is "no progress" and 1.0 is "next level".

Parameters

Name	Type	Description
`progress`	`float`	New experience progress

`meth`getExpLevelabstractconst

int getExpLevel() const =0

Gets the players current experience level.

Returns

Type	Description
`int`	Current experience level

`meth`setExpLevelabstract

void setExpLevel(int level) =0

Sets the players current experience level.

Parameters

Name	Type	Description
`level`	`int`	New experience level

`meth`getTotalExpabstractconst

int getTotalExp() const =0

Gets the players total experience points.

This refers to the total amount of experience the player has collected over time and is not currently displayed to the client.

Returns

Type	Description
`int`	Current total experience points

`meth`getAllowFlightabstractconst

bool getAllowFlight() const =0

Determines if the Player is allowed to fly via jump key double-tap.

Returns

Type	Description
`bool`	True if the player is allowed to fly.

`meth`setAllowFlightabstract

void setAllowFlight(bool flight) =0

Sets if the Player is allowed to fly via jump key double-tap.

Parameters

Name	Type	Description
`flight`	`bool`	If flight should be allowed.

`meth`isFlyingabstractconst

bool isFlying() const =0

Checks to see if this player is currently flying or not.

Returns

Type	Description
`bool`	True if the player is flying, else false.

`meth`setFlyingabstract

void setFlying(bool value) =0

Makes this player start or stop flying.

Parameters

Name	Type	Description
`value`	`bool`	True to fly.

`meth`getFlySpeedabstractconst

float getFlySpeed() const =0

Gets the current allowed speed that a client can fly.

Returns

Type	Description
`float`	The current allowed speed, default is 0.05.

`meth`setFlySpeedabstractconst

void setFlySpeed(float value) const =0

Sets the speed at which a client will fly.

Parameters

Name	Type	Description
`value`	`float`	The new speed.

`meth`getWalkSpeedabstractconst

float getWalkSpeed() const =0

Gets the current allowed speed that a client can walk.

Returns

Type	Description
`float`	The current allowed speed, default is 0.10.

`meth`setWalkSpeedabstractconst

void setWalkSpeed(float value) const =0

Sets the speed at which a client will walk.

Parameters

Name	Type	Description
`value`	`float`	The new speed.

`meth`getScoreboardabstractconst

Scoreboard& getScoreboard() const =0

Gets the Scoreboard displayed to this player.

Returns

Type	Description
`Scoreboard&`	The current scoreboard seen by this player

`meth`setScoreboardabstract

void setScoreboard(Scoreboard& scoreboard) =0

@breif Sets the player's visible Scoreboard.

Parameters

Name	Type	Description
`scoreboard`	`Scoreboard&`	New Scoreboard for the player

`meth`sendPopupabstractconst

void sendPopup(std::string message) const =0

Sends this player a popup message.

Parameters

Name	Type	Description
`message`	`std::string`	Message to be displayed

`meth`sendTipabstractconst

void sendTip(std::string message) const =0

Sends this player a tip message.

Parameters

Name	Type	Description
`message`	`std::string`	Message to be displayed

`meth`sendToastabstractconst

void sendToast(std::string title, std::string content) const =0

Sends this player a toast notification.

Parameters

Name	Type	Description
`title`	`std::string`	The title of the toast notification.
`content`	`std::string`	The content of the toast notification.

`meth`sendTitleabstractconst

void sendTitle(std::string title, std::string subtitle) const =0

Sends a title and a subtitle message to the player. If they are empty strings, the display will be updated as such. The titles will be displayed with the default timings.

Parameters

Name	Type	Description
`title`	`std::string`	Title text
`subtitle`	`std::string`	Subtitle text

`meth`sendTitleabstractconst

void sendTitle(std::string title, std::string subtitle, int fade_in, int stay, int fade_out) const =0

Sends a title and a subtitle message to the player. If they are empty strings, the display will be updated as such.

Parameters

Name	Type	Description
`title`	`std::string`	Title text
`subtitle`	`std::string`	Subtitle text
`fade_in`	`int`	time in ticks for titles to fade in. Defaults to 10.
`stay`	`int`	time in ticks for titles to stay. Defaults to 70.
`fade_out`	`int`	time in ticks for titles to fade out. Defaults to 20.

`meth`resetTitleabstractconst

void resetTitle() const =0

Resets the title displayed to the player. This will clear the displayed title / subtitle and reset timings to their default values.

`meth`spawnParticleabstractconst

void spawnParticle(std::string name, Location location) const =0

Spawns the particle at the target location.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the particle effect to spawn
`location`	`Location`	the location to spawn at

`meth`spawnParticleabstractconst

void spawnParticle(std::string name, float x, float y, float z) const =0

Spawns the particle at the target location.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the particle effect to spawn
`x`	`float`	the position on the x axis to spawn at
`y`	`float`	the position on the y axis to spawn at
`z`	`float`	the position on the z axis to spawn at

`meth`spawnParticleabstractconst

void spawnParticle(std::string name, Location location, std::optional<std::string> molang_variables_json) const =0

Spawns the particle at the target location.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the particle effect to spawn
`location`	`Location`	the location to spawn at
`molang_variables_json`	`std::optional<std::string>`	the customizable molang variables that can be adjusted for this particle, in json

`meth`spawnParticleabstractconst

void spawnParticle(std::string name, float x, float y, float z, std::optional<std::string> molang_variables_json) const =0

Spawns the particle at the target location.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the particle effect to spawn
`x`	`float`	the position on the x axis to spawn at
`y`	`float`	the position on the y axis to spawn at
`z`	`float`	the position on the z axis to spawn at
`molang_variables_json`	`std::optional<std::string>`	the customizable molang variables that can be adjusted for this particle, in json

`meth`getPingabstractconst

std::chrono::milliseconds getPing() const =0

Gets the player's average ping.

Returns

Type	Description
`std::chrono::milliseconds`	player ping

`meth`getLocaleabstractconst

std::string getLocale() const =0

Gets the player's current locale.

Returns

Type	Description
`std::string`	the player's locale

`meth`updateCommandsabstractconst

void updateCommands() const =0

Send the list of commands to the client.

Generally useful to ensure the client has a complete list of commands after permission changes are done.

`meth`getInventoryabstractconst

PlayerInventory& getInventory() const =0

Get the player's inventory.

Returns

Type	Description
`PlayerInventory&`	The inventory of the player, this also contains the armor slots.

`meth`getEnderChestabstractconst

Inventory& getEnderChest() const =0

Get the player's EnderChest inventory.

Returns

Type	Description
`Inventory&`	The EnderChest of the player

`meth`getGameModeabstractconst

GameMode getGameMode() const =0

Gets this player's current GameMode.

Returns

Type	Description
`GameMode`	Current game mode

`meth`setGameModeabstract

void setGameMode(GameMode mode) =0

Sets this player's current GameMode.

Parameters

Name	Type	Description
`mode`	`GameMode`	New game mode

`meth`getDeviceOSabstractconst

std::string getDeviceOS() const =0

Gets the player's current device's operation system (OS).

Returns

Type	Description
`std::string`	the player's device OS

`meth`getDeviceIdabstractconst

std::string getDeviceId() const =0

Gets the player's current device id.

Returns

Type	Description
`std::string`	the player's device id

`meth`getGameVersionabstractconst

std::string getGameVersion() const =0

Gets the player's current game version.

Returns

Type	Description
`std::string`	the player's game version

`meth`getSkinabstractconst

Skin getSkin() const =0

Gets the player's skin.

Returns

Type	Description
`Skin`	the player's skin

`meth`sendFormabstract

void sendForm(FormVariant form) =0

Sends a form to the player.

Parameters

Name	Type	Description
`form`	`FormVariant`	The form to send

`meth`closeFormabstract

void closeForm() =0

Closes the forms that are currently open for the player.

`meth`sendPacketabstractconst

void sendPacket(int packet_id, std::string_view payload) const =0

Sends a packet to the player.

Parameters

Name	Type	Description
`packet_id`	`int`	The packet ID to be sent.
`payload`	`std::string_view`	The payload of the packet to be transmitted.

`meth`sendMapabstract

void sendMap(MapView& map) =0

Render a map and send it to the player in its entirety.

This may be used when streaming the map in the normal manner is not desirable.

Parameters

Name	Type	Description
`map`	`MapView&`	The map to send

`class`Preconditions

Defined in <endstone/check.h>

Methods

Name	Description
`checkArgument`
`checkState`

`meth`checkArgumentstatic

void checkArgument(bool condition, std::format_string<Args...> format, Args&&... args)

`meth`checkStatestatic

void checkState(bool condition, std::format_string<Args...> format, Args&&... args)

`class`Registry

Defined in <endstone/registry.h>

Bases: IRegistry

Abstract registry interface for objects with identifiers.

Provides lookup by identifier (nullable or exception-throwing) and iteration.

Methods

Name	Description
`get`	Get the object by its identifier.
`get`	Get the object by its identifier.
`getOrThrow`	Get the object by its identifier or throw if missing.
`getOrThrow`	Get the object by its identifier or throw if missing.
`forEach`	Apply a function to each stored element.

`meth`getabstractnoexcept

T* get(Identifier<T> id) noexcept=0

Get the object by its identifier.

Returns a raw pointer to the object, or nullptr if not found.

Parameters

Name	Type	Description
`id`	`Identifier<T>`	Identifier to look up.

Returns

Type	Description
`T*`	T* Pointer to the object, or nullptr if it does not exist.

`meth`getabstractconstnoexcept

const T* get(Identifier<T> id) const noexcept=0

Get the object by its identifier.

Returns a raw pointer to the object, or nullptr if not found.

Parameters

Name	Type	Description
`id`	`Identifier<T>`	Non-null identifier to look up.

Returns

Type	Description
`const T*`	const T* Pointer to the object, or nullptr if it does not exist.

`meth`getOrThrowvirtual

T& getOrThrow(Identifier<T> id)

Get the object by its identifier or throw if missing.

Parameters

Name	Type	Description
`id`	`Identifier<T>`	identifier of the object to retrieve.

Returns

Type	Description
`T&`	T& Reference to the object with the given identifier.

Raises

Type	Description
`std::invalid_argument`	if no object with the given identifier exists.

`meth`getOrThrowvirtualconst

const T& getOrThrow(Identifier<T> id) const

Get the object by its identifier or throw if missing.

Parameters

Name	Type	Description
`id`	`Identifier<T>`	identifier of the object to retrieve.

Returns

Type	Description
`const T&`	const T& Const reference to the object with the given identifier.

Raises

Type	Description
`std::invalid_argument`	if no object with the given identifier exists.

`meth`forEachabstractconst

void forEach(std::function<bool(const T&)> func) const =0

Apply a function to each stored element.

Iterates over all stored elements and applies the provided function to them. The iteration continues until the function returns false or all elements have been processed.

Parameters

Name	Type	Description
`func`	`std::function<bool(const T&)>`	A callable object taking a const reference to an element and returning a boolean. Returning false stops the iteration.

`class`Server

Defined in <endstone/server.h>

Represents a server implementation.

Variables

Name	Description
`BroadcastChannelAdmin`	Used for all administrative messages, such as an operator using a command.
`BroadcastChannelUser`	Used for all announcement messages, such as informing users that a player has joined.

Methods

Name	Description
`Server`
`Server`
`operator=`
`~Server`
`getName`	Gets the name of this server implementation.
`getVersion`	Gets the version string of this server implementation.
`getMinecraftVersion`	Gets the Minecraft version that this server is running.
`getProtocolVersion`	Gets the network protocol version that this server supports.
`getLogger`	Returns the primary logger associated with this server instance.
`getLanguage`	Gets the current language interface used by the server.
`getPluginManager`	Gets the plugin manager for interfacing with plugins.
`getPluginCommand`	Gets a PluginCommand with the given name or alias.
`getCommandSender`	Gets a CommandSender for this server.
`dispatchCommand`	Dispatches a command on this server, and executes it if found.
`getScheduler`	Gets the scheduler for managing scheduled events.
`getLevel`	Gets the server level.
`getOnlinePlayers`	Gets a list of all currently online players.
`getMaxPlayers`	Get the maximum amount of players which can login to this server.
`setMaxPlayers`	Set the maximum amount of players allowed to be logged in at once.
`getPlayer`	Gets the player with the given UUID.
`getPort`	Get the game port that the server runs on.
`getPortV6`	Get the game port (IPv6) that the server runs on.
`getOnlineMode`	Gets whether the Server is in online mode or not.
`getPlayer`	Gets the player with the exact given name, case-insensitive.
`shutdown`	Shutdowns the server, stopping everything.
`reload`	Reloads the server configuration, functions, scripts and plugins.
`reloadData`	Reload only the Minecraft data for the server.
`broadcast`	Broadcasts the specified message to every user with the given permission name.
`broadcastMessage`	Broadcasts the specified message to every user with permission endstone.broadcast.user.
`broadcastMessage`
`isPrimaryThread`	Checks the current thread against the expected primary server thread.
`getItemFactory`
`getScoreboard`	Gets the primary Scoreboard controlled by the server.
`createScoreboard`	Creates a new Scoreboard to be tracked by the server.
`getCurrentMillisecondsPerTick`	Gets the current milliseconds per tick (MSPT).
`getAverageMillisecondsPerTick`	Gets the average milliseconds per tick (MSPT).
`getCurrentTicksPerSecond`	Gets the current ticks per second (TPS).
`getAverageTicksPerSecond`	Gets the average ticks per second (TPS).
`getCurrentTickUsage`	Gets the current tick usage of the server.
`getAverageTickUsage`	Gets the average tick usage of the server.
`getStartTime`	Gets the start time of the server.
`createBossBar`	Creates a boss bar instance to display to players. The progress defaults to 1.0.
`createBossBar`	Creates a boss bar instance to display to players. The progress defaults to 1.0.
`createBlockData`	Creates a new BlockData instance for the specified block type, with all properties initialized to defaults.
`createBlockData`	Creates a new BlockData instance for the specified block type, with all properties initialized to defaults, except for those provided in data.
`getBanList`
`getIpBanList`
`getServiceManager`
`_getRegistry`	Returns the registry for the given type.
`getRegistry`
`getMap`	Gets the map from the given item ID.
`createMap`	Create a new map with an automatically assigned ID.

`var`BroadcastChannelAdminstatic

const std::string BroadcastChannelAdmin

Used for all administrative messages, such as an operator using a command.

`var`BroadcastChannelUserstatic

const std::string BroadcastChannelUser

Used for all announcement messages, such as informing users that a player has joined.

`meth`Server

Server() =default

`meth`Server

Server(const Server&) =delete

`meth`operator=

Server& operator=(const Server&) =delete

`meth`~Servervirtual

~Server() =default

`meth`getNameabstractconst

std::string getName() const =0

Gets the name of this server implementation.

Returns

Type	Description
`std::string`	name of this server implementation

`meth`getVersionabstractconst

std::string getVersion() const =0

Gets the version string of this server implementation.

Returns

Type	Description
`std::string`	version of this server implementation

`meth`getMinecraftVersionabstractconst

std::string getMinecraftVersion() const =0

Gets the Minecraft version that this server is running.

Returns

Type	Description
`std::string`	version of Minecraft

`meth`getProtocolVersionabstractconst

int getProtocolVersion() const =0

Gets the network protocol version that this server supports.

Returns

Type	Description
`int`	version of network protocol

`meth`getLoggerabstractconst

Logger& getLogger() const =0

Returns the primary logger associated with this server instance.

Returns

Type	Description
`Logger&`	Logger associated with this server

`meth`getLanguageabstractconst

Language& getLanguage() const =0

Gets the current language interface used by the server.

Returns

Type	Description
`Language&`	Language interface used by the server for translations.

`meth`getPluginManagerabstractconst

PluginManager& getPluginManager() const =0

Gets the plugin manager for interfacing with plugins.

Returns

Type	Description
`PluginManager&`	a plugin manager for this Server instance

`meth`getPluginCommandabstractconst

PluginCommand* getPluginCommand(std::string name) const =0

Gets a PluginCommand with the given name or alias.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the command to retrieve

Returns

Type	Description
`PluginCommand*`	a plugin command if found, null otherwise

`meth`getCommandSenderabstractconst

ConsoleCommandSender& getCommandSender() const =0

Gets a CommandSender for this server.

Returns

Type	Description
`ConsoleCommandSender&`	a console command sender

`meth`dispatchCommandabstractconst

bool dispatchCommand(CommandSender& sender, std::string command_line) const =0

Dispatches a command on this server, and executes it if found.

Parameters

Name	Type	Description
`sender`	`CommandSender&`	the apparent sender of the command
`command_line`	`std::string`	the command + arguments.

Returns

Type	Description
`bool`	true if execution is successful, false otherwise

`meth`getSchedulerabstractconst

Scheduler& getScheduler() const =0

Gets the scheduler for managing scheduled events.

Returns

Type	Description
`Scheduler&`	a scheduling service for this server

`meth`getLevelabstractconst

Level* getLevel() const =0

Gets the server level.

Returns

Type	Description
`Level*`	the server level

`meth`getOnlinePlayersabstractconst

std::vector<Player*> getOnlinePlayers() const =0

Gets a list of all currently online players.

Returns

Type	Description
`std::vector<Player*>`	a list of currently online players.

`meth`getMaxPlayersabstractconst

int getMaxPlayers() const =0

Get the maximum amount of players which can login to this server.

Returns

Type	Description
`int`	the amount of players this server allows

`meth`setMaxPlayersabstract

void setMaxPlayers(int max_players) =0

Set the maximum amount of players allowed to be logged in at once.

Parameters

Name	Type	Description
`max_players`	`int`	The maximum amount of concurrent players

`meth`getPlayerabstractconst

Player* getPlayer(endstone::UUID id) const =0

Gets the player with the given UUID.

Parameters

Name	Type	Description
`id`	`endstone::UUID`	UUID of the player to retrieve

Returns

Type	Description
`Player*`	a player object if one was found, null otherwise

`meth`getPortabstractconst

int getPort() const =0

Get the game port that the server runs on.

Returns

Type	Description
`int`	the port number of this server

`meth`getPortV6abstractconst

int getPortV6() const =0

Get the game port (IPv6) that the server runs on.

Returns

Type	Description
`int`	the port number of this server

`meth`getOnlineModeabstractconst

bool getOnlineMode() const =0

Gets whether the Server is in online mode or not.

Returns

Type	Description
`bool`	true if the server authenticates clients, false otherwise

`meth`getPlayerabstractconst

Player* getPlayer(std::string name) const =0

Gets the player with the exact given name, case-insensitive.

Parameters

Name	Type	Description
`name`	`std::string`	Exact name of the player to retrieve

Returns

Type	Description
`Player*`	a player object if one was found, null otherwise

`meth`shutdownabstract

void shutdown() =0

Shutdowns the server, stopping everything.

`meth`reloadabstract

void reload() =0

Reloads the server configuration, functions, scripts and plugins.

`meth`reloadDataabstract

void reloadData() =0

Reload only the Minecraft data for the server.

This includes functions and script files from all behaviour packs.

`meth`broadcastabstractconst

void broadcast(const Message& message, const std::string& permission) const =0

Broadcasts the specified message to every user with the given permission name.

Parameters

Name	Type	Description
`message`	`const Message&`	message to broadcast
`permission`	`const std::string&`	the required permission Permissibles must have to receive the broadcast

`meth`broadcastMessageabstractconst

void broadcastMessage(const Message& message) const =0

Broadcasts the specified message to every user with permission endstone.broadcast.user.

Parameters

Name	Type	Description
`message`	`const Message&`	the message

`meth`broadcastMessageconst

void broadcastMessage(const std::format_string<Args...> format, Args&&... args) const

`meth`isPrimaryThreadabstractconst

bool isPrimaryThread() const =0

Checks the current thread against the expected primary server thread.

Returns

Type	Description
`bool`	true if the current thread matches the expected primary thread, false otherwise

`meth`getItemFactoryabstractconst

ItemFactory& getItemFactory() const =0

Gets the instance of the item factory (for ItemMeta).

`meth`getScoreboardabstractconst

Scoreboard* getScoreboard() const =0

Gets the primary Scoreboard controlled by the server.

This Scoreboard is saved by the server, is affected by the /scoreboard command, and is the scoreboard shown by default to players. This will only exist after the level has been loaded.

Returns

Type	Description
`Scoreboard*`	the default server scoreboard

`meth`createScoreboardabstract

std::shared_ptr<Scoreboard> createScoreboard() =0

Creates a new Scoreboard to be tracked by the server.

This will not be saved by the server and is not affected by the /scoreboard command.

Returns

Type	Description
`std::shared_ptr<Scoreboard>`	the newly created Scoreboard

`meth`getCurrentMillisecondsPerTickabstract

float getCurrentMillisecondsPerTick() =0

Gets the current milliseconds per tick (MSPT).

Returns

Type	Description
`float`	The average current of milliseconds per tick.

`meth`getAverageMillisecondsPerTickabstract

float getAverageMillisecondsPerTick() =0

Gets the average milliseconds per tick (MSPT).

Returns

Type	Description
`float`	The average number of milliseconds per tick.

`meth`getCurrentTicksPerSecondabstract

float getCurrentTicksPerSecond() =0

Gets the current ticks per second (TPS).

Returns

Type	Description
`float`	The current ticks per second

`meth`getAverageTicksPerSecondabstract

float getAverageTicksPerSecond() =0

Gets the average ticks per second (TPS).

Returns

Type	Description
`float`	The average ticks per second

`meth`getCurrentTickUsageabstract

float getCurrentTickUsage() =0

Gets the current tick usage of the server.

Returns

Type	Description
`float`	The current tick usage in percentage.

`meth`getAverageTickUsageabstract

float getAverageTickUsage() =0

Gets the average tick usage of the server.

Returns

Type	Description
`float`	The average tick usage in percentage.

`meth`getStartTimeabstract

std::chrono::system_clock::time_point getStartTime() =0

Gets the start time of the server.

Returns

Type	Description
`std::chrono::system_clock::time_point`	The start time of the server.

`meth`createBossBarabstractconst

std::unique_ptr<BossBar> createBossBar(std::string title, BarColor color, BarStyle style) const =0

Creates a boss bar instance to display to players. The progress defaults to 1.0.

Parameters

Name	Type	Description
`title`	`std::string`	the title of the boss bar
`color`	`BarColor`	the color of the boss bar
`style`	`BarStyle`	the style of the boss bar

Returns

Type	Description
`std::unique_ptr<BossBar>`	the created boss bar

`meth`createBossBarabstractconst

std::unique_ptr<BossBar> createBossBar(std::string title, BarColor color, BarStyle style, std::vector<BarFlag> flags) const =0

Creates a boss bar instance to display to players. The progress defaults to 1.0.

Parameters

Name	Type	Description
`title`	`std::string`	the title of the boss bar
`color`	`BarColor`	the color of the boss bar
`style`	`BarStyle`	the style of the boss bar
`flags`	`std::vector<BarFlag>`	a list of flags to set on the boss bar

Returns

Type	Description
`std::unique_ptr<BossBar>`	the created boss bar

`meth`createBlockDataabstractconst

std::unique_ptr<BlockData> createBlockData(std::string type) const =0

Creates a new BlockData instance for the specified block type, with all properties initialized to defaults.

Parameters

Name	Type	Description
`type`	`std::string`	the block type

Returns

Type	Description
`std::unique_ptr<BlockData>`	new data instance

`meth`createBlockDataabstractconst

std::unique_ptr<BlockData> createBlockData(std::string type, BlockStates block_states) const =0

Creates a new BlockData instance for the specified block type, with all properties initialized to defaults, except for those provided in data.

Parameters

Name	Type	Description
`type`	`std::string`	the block type
`block_states`	`BlockStates`	block states, for example `{"old_leaf_type":"birch", "persistent_bit":true}`

Returns

Type	Description
`std::unique_ptr<BlockData>`	new data instance

`meth`getBanListabstractconst

PlayerBanList& getBanList() const =0

Gets the player ban list.

Returns

Type	Description
`PlayerBanList&`	The player ban list

`meth`getIpBanListabstractconst

IpBanList& getIpBanList() const =0

Gets the IP ban list.

Returns

Type	Description
`IpBanList&`	The IP ban list

`meth`getServiceManagerabstractconst

ServiceManager& getServiceManager() const =0

Gets the service manager.

Returns

Type	Description
`ServiceManager&`	The service manager

`meth`_getRegistryabstractconst

IRegistry* _getRegistry(const std::string& type) const =0

Returns the registry for the given type.

If no registry is present for the given type null will be returned.

Parameters

Name	Type	Description
`type`	`const std::string&`	of the registry to get

Returns

Type	Description
`IRegistry*`	the corresponding registry or null if not present

`meth`getRegistryconst

const Registry<T>& getRegistry() const

`meth`getMapabstractconst

MapView* getMap(std::int64_t id) const =0

Gets the map from the given item ID.

Parameters

Name	Type	Description
`id`	`std::int64_t`	the id of the map to get

Returns

Type	Description
`MapView*`	a map view if it exists, or null otherwise

`meth`createMapabstractconst

MapView& createMap(const Dimension& dimension) const =0

Create a new map with an automatically assigned ID.

Parameters

Name	Type	Description
`dimension`	`const Dimension&`	the Dimension the map will belong to

Returns

Type	Description
`MapView&`	a newly created map view

`class`Skin

Defined in <endstone/skin.h>

Represents a player skin.

Methods

Name	Description
`Skin`
`getId`	Gets the skin id.
`getImage`	Gets the skin image.
`getCapeId`	Gets the cape id.
`getCapeImage`	Gets the cape image.

`meth`Skin

Skin(std::string id, Image image, std::optional<std::string> cape_id = std::nullopt, std::optional<Image> cape_image = std::nullopt)

`meth`getIdconst

const std::string& getId() const

Gets the skin id.

Returns

Type	Description
`const std::string&`	the skin id.

`meth`getImageconst

const Image& getImage() const

Gets the skin image.

Returns

Type	Description
`const Image&`	the skin image.

`meth`getCapeIdconst

const std::optional<std::string>& getCapeId() const

Gets the cape id.

Returns

Type	Description
`const std::optional<std::string>&`	the cape id.

`meth`getCapeImageconst

const Image* getCapeImage() const

Gets the cape image.

Returns

Type	Description
`const Image*`	the cape image.

`class`Type

Defined in <endstone/registry.h>

CRTP base for registry-backed types identified by an Identifier.

Provides getId(), getTranslationKey() pure virtual declarations, comparison operators, implicit conversion to Id, and a static get() method.

Type Aliases

Name	Description
`Id`

Methods

Name	Description
`~Type`
`getId`	Return the identifier of this object.
`getTranslationKey`	Get the translation key, suitable for use in a translation component.
`operator==`
`operator!=`
`operator==`
`operator!=`
`operator Id`
`get`	Look up a registry entry by identifier.

`type`Id

Identifier<T> Id

`meth`~Typevirtual

~Type() =default

`meth`getIdabstractconst

Id getId() const =0

Return the identifier of this object.

Returns

Type	Description
`Id`	this object's identifier

`meth`getTranslationKeyabstractconst

std::string getTranslationKey() const =0

Get the translation key, suitable for use in a translation component.

Returns

Type	Description
`std::string`	the translation key

`meth`operator==const

bool operator==(const Id& other) const

`meth`operator!=const

bool operator!=(const Id& other) const

`meth`operator==const

bool operator==(const T& other) const

`meth`operator!=const

bool operator!=(const T& other) const

`meth`operator Idconst

operator Id() const

`meth`getstatic

const T* get(Id id)

Look up a registry entry by identifier.

Parameters

Name	Type	Description
`id`	`Id`	Identifier to look up.

Returns

Type	Description
`const T*`	Pointer to the entry, or nullptr if not found.

`struct`overloaded

Defined in <endstone/variant.h>

Bases: Func...

Helper type for visitors.

`enum`GameMode

GameMode

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

Values

Name	Value	Description
`Survival`	`0`	Survival mode is the "normal" gameplay type, with no special features.
`Creative`	`1`	Creative mode may fly, build instantly, become invulnerable and create free items.
`Adventure`	`2`	Adventure mode cannot break blocks without the correct tools.
`Spectator`	`3`	Spectator mode cannot interact with the world in anyway and is invisible to normal players. This grants the player the ability to no-clip through the world.

`type`Message

std::variant<std::string, Translatable> Message

`func`overloaded

overloaded(Func...) -> overloaded< Func... >

Deduction guide.

Parameters

Name	Type	Description
`Func`		Types of function objects.

structColorFormat

varEscapestatic

varBlackstatic

varDarkBluestatic

varDarkGreenstatic

varDarkAquastatic

varDarkRedstatic

varDarkPurplestatic

varGoldstatic

varGraystatic

varDarkGraystatic

varBluestatic

varGreenstatic

varAquastatic

varRedstatic

varLightPurplestatic

varYellowstatic

varWhitestatic

varMinecoinGoldstatic

varMaterialQuartzstatic

varMaterialIronstatic

varMaterialNetheritestatic

varMaterialRedstonestatic

varMaterialCopperstatic

varMaterialGoldstatic

varMaterialEmeraldstatic

varMaterialDiamondstatic

varMaterialLapisstatic

varMaterialAmethyststatic

varMaterialResinstatic

varObfuscatedstatic

varBoldstatic

varItalicstatic

varResetstatic

classIRegistry

meth~IRegistryvirtual

classIdentifier

varMinecraftstaticconstexpr

methIdentifierconstexprnoexcept

methIdentifierconstexprnoexcept

methIdentifierconstexprnoexcept

methIdentifierconstexprnoexcept

methgetNamespaceconstconstexprnoexcept

methgetKeyconstconstexprnoexcept

methoperator==constconstexprnoexcept

methoperator!=constconstexprnoexcept

methoperator std::stringconst

methminecraftstaticconstexprnoexcept

classLogger

enumLevel

methLogger

meth~Loggervirtual

methsetLevelabstract

methisEnabledForabstractconst

methgetNameabstractconst

methlogabstractconst

methlogconst

methtraceconst

methtraceconst

methdebugconst

methdebugconst

methinfoconst

methinfoconst

methwarningconst

methwarningconst

metherrorconst

metherrorconst

methcriticalconst

methcriticalconst

classOfflinePlayer

meth~OfflinePlayervirtual

methgetNameabstractconst

methgetUniqueIdabstractconst

classPlayer

typeFormVariantprotected

methgetNameabstractconstoverride

methisOpabstractconst

methsetOpabstract

methgetXuidabstractconst

`struct`ColorFormat

`var`Escapestatic

`var`Blackstatic

`var`DarkBluestatic

`var`DarkGreenstatic

`var`DarkAquastatic

`var`DarkRedstatic

`var`DarkPurplestatic

`var`Goldstatic

`var`Graystatic

`var`DarkGraystatic

`var`Bluestatic

`var`Greenstatic

`var`Aquastatic

`var`Redstatic

`var`LightPurplestatic

`var`Yellowstatic

`var`Whitestatic

`var`MinecoinGoldstatic

`var`MaterialQuartzstatic

`var`MaterialIronstatic

`var`MaterialNetheritestatic

`var`MaterialRedstonestatic

`var`MaterialCopperstatic

`var`MaterialGoldstatic

`var`MaterialEmeraldstatic

`var`MaterialDiamondstatic

`var`MaterialLapisstatic

`var`MaterialAmethyststatic

`var`MaterialResinstatic

`var`Obfuscatedstatic

`var`Boldstatic

`var`Italicstatic

`var`Resetstatic

`class`IRegistry

`meth`~IRegistryvirtual

`class`Identifier

`var`Minecraftstaticconstexpr

`meth`Identifierconstexprnoexcept

`meth`Identifierconstexprnoexcept

`meth`Identifierconstexprnoexcept

`meth`Identifierconstexprnoexcept

`meth`getNamespaceconstconstexprnoexcept

`meth`getKeyconstconstexprnoexcept

`meth`operator==constconstexprnoexcept

`meth`operator!=constconstexprnoexcept

`meth`operator std::stringconst

`meth`minecraftstaticconstexprnoexcept

`class`Logger

`enum`Level

`meth`Logger

`meth`~Loggervirtual

`meth`setLevelabstract

`meth`isEnabledForabstractconst

`meth`getNameabstractconst

`meth`logabstractconst

`meth`logconst

`meth`traceconst

`meth`traceconst

`meth`debugconst

`meth`debugconst

`meth`infoconst

`meth`infoconst

`meth`warningconst

`meth`warningconst

`meth`errorconst

`meth`errorconst

`meth`criticalconst

`meth`criticalconst

`class`OfflinePlayer

`meth`~OfflinePlayervirtual

`meth`getNameabstractconst

`meth`getUniqueIdabstractconst

`class`Player

`type`FormVariantprotected

`meth`getNameabstractconstoverride

`meth`isOpabstractconst

`meth`setOpabstract

`meth`getXuidabstractconst

`meth`getAddressabstractconst