Miscellaneous

endstone.ColorFormat

All supported color and format codes.

Attributes:

Name	Type	Description
AQUA	str
BLACK	str
BLUE	str
BOLD	str
DARK_AQUA	str
DARK_BLUE	str
DARK_GRAY	str
DARK_GREEN	str
DARK_PURPLE	str
DARK_RED	str
GOLD	str
GRAY	str
GREEN	str
ITALIC	str
LIGHT_PURPLE	str
MATERIAL_AMETHYST	str
MATERIAL_COPPER	str
MATERIAL_DIAMOND	str
MATERIAL_EMERALD	str
MATERIAL_GOLD	str
MATERIAL_IRON	str
MATERIAL_LAPIS	str
MATERIAL_NETHERITE	str
MATERIAL_QUARTZ	str
MATERIAL_REDSTONE	str
MATERIAL_RESIN	str
MINECOIN_GOLD	str
OBFUSCATED	str
RED	str
RESET	str
WHITE	str
YELLOW	str

AQUA class-attribute

AQUA: str = '§b'

BLACK class-attribute

BLACK: str = '§0'

BLUE class-attribute

BLUE: str = '§9'

BOLD class-attribute

BOLD: str = '§l'

DARK_AQUA class-attribute

DARK_AQUA: str = '§3'

DARK_BLUE class-attribute

DARK_BLUE: str = '§1'

DARK_GRAY class-attribute

DARK_GRAY: str = '§8'

DARK_GREEN class-attribute

DARK_GREEN: str = '§2'

DARK_PURPLE class-attribute

DARK_PURPLE: str = '§5'

DARK_RED class-attribute

DARK_RED: str = '§4'

GOLD class-attribute

GOLD: str = '§6'

GRAY class-attribute

GRAY: str = '§7'

GREEN class-attribute

GREEN: str = '§a'

ITALIC class-attribute

ITALIC: str = '§o'

LIGHT_PURPLE class-attribute

LIGHT_PURPLE: str = '§d'

MATERIAL_AMETHYST class-attribute

MATERIAL_AMETHYST: str = '§u'

MATERIAL_COPPER class-attribute

MATERIAL_COPPER: str = '§n'

MATERIAL_DIAMOND class-attribute

MATERIAL_DIAMOND: str = '§s'

MATERIAL_EMERALD class-attribute

MATERIAL_EMERALD: str = '§q'

MATERIAL_GOLD class-attribute

MATERIAL_GOLD: str = '§p'

MATERIAL_IRON class-attribute

MATERIAL_IRON: str = '§i'

MATERIAL_LAPIS class-attribute

MATERIAL_LAPIS: str = '§t'

MATERIAL_NETHERITE class-attribute

MATERIAL_NETHERITE: str = '§j'

MATERIAL_QUARTZ class-attribute

MATERIAL_QUARTZ: str = '§h'

MATERIAL_REDSTONE class-attribute

MATERIAL_REDSTONE: str = '§m'

MATERIAL_RESIN class-attribute

MATERIAL_RESIN: str = '§v'

MINECOIN_GOLD class-attribute

MINECOIN_GOLD: str = '§g'

OBFUSCATED class-attribute

OBFUSCATED: str = '§k'

RED class-attribute

RED: str = '§c'

RESET class-attribute

RESET: str = '§r'

WHITE class-attribute

WHITE: str = '§f'

YELLOW class-attribute

YELLOW: str = '§e'

endstone.EnchantmentRegistry

Methods:

Name	Description
get
get_or_throw

get

get(key: str) -> Enchantment

get_or_throw

get_or_throw(key: str) -> Enchantment

endstone.GameMode

Bases: Enum

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

Attributes:

Name	Type	Description
ADVENTURE	GameMode
CREATIVE	GameMode
SPECTATOR	GameMode
SURVIVAL	GameMode

ADVENTURE class-attribute

ADVENTURE: GameMode

CREATIVE class-attribute

CREATIVE: GameMode

SPECTATOR class-attribute

SPECTATOR: GameMode

SURVIVAL class-attribute

SURVIVAL: GameMode

endstone.ItemRegistry

Methods:

Name	Description
get
get_or_throw

get

get(key: str) -> ItemType

get_or_throw

get_or_throw(key: str) -> ItemType

endstone.Logger

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

Classes:

Name	Description
Level	Specifies the log level.

Methods:

Name	Description
critical	Log a message at the CRITICAL level.
debug	Log a message at the DEBUG level.
error	Log a message at the ERROR level.
info	Log a message at the INFO level.
is_enabled_for	Check if the Logger instance is enabled for the given log Level.
set_level	Set the logging level for this Logger instance.
trace	Log a message at the TRACE level.
warning	Log a message at the WARNING level.

Attributes:

Name	Type	Description
CRITICAL	Level
DEBUG	Level
ERROR	Level
INFO	Level
TRACE	Level
WARNING	Level
name	str	Get the name of this Logger instance.

CRITICAL class-attribute

CRITICAL: Level

DEBUG class-attribute

DEBUG: Level

ERROR class-attribute

ERROR: Level

INFO class-attribute

INFO: Level

TRACE class-attribute

TRACE: Level

WARNING class-attribute

WARNING: Level

name property

name: str

Get the name of this Logger instance.

Level

Bases: IntEnum

Specifies the log level.

Attributes:

Name	Type	Description
CRITICAL	Level
DEBUG	Level
ERROR	Level
INFO	Level
TRACE	Level
WARNING	Level

CRITICAL class-attribute

CRITICAL: Level

DEBUG class-attribute

DEBUG: Level

ERROR class-attribute

ERROR: Level

INFO class-attribute

INFO: Level

TRACE class-attribute

TRACE: Level

WARNING class-attribute

WARNING: Level

critical

critical(message: str) -> None

Log a message at the CRITICAL level.

debug

debug(message: str) -> None

Log a message at the DEBUG level.

error

error(message: str) -> None

Log a message at the ERROR level.

info

info(message: str) -> None

Log a message at the INFO level.

is_enabled_for

is_enabled_for(level: Level) -> bool

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

set_level

set_level(level: Level) -> None

Set the logging level for this Logger instance.

trace

trace(message: str) -> None

Log a message at the TRACE level.

warning

warning(message: str) -> None

Log a message at the WARNING level.

endstone.util

Multi and single purpose classes.

Classes:

Name	Description
SocketAddress	Represents an IP Socket Address (hostname + port number).
Vector	Represents a 3-dimensional vector.

SocketAddress

SocketAddress()

SocketAddress(hostname: str, port: int)

SocketAddress()

Represents an IP Socket Address (hostname + port number).

Attributes:

Name	Type	Description
hostname	str	Gets the hostname.
port	int	Gets the port number.

hostname property

hostname: str

Gets the hostname.

port property

port: int

Gets the port number.

Vector

Vector()

Vector(x: float, y: float, z: float)

Vector()

Represents a 3-dimensional vector.

Methods:

Name	Description
distance	The distance between this Vector and another
distance_squared	The squared distance between this Vector and another

Attributes:

Name	Type	Description
length	float	The magnitude of the Vector
length_squared	float	The squared magnitude of the Vector
x	float	The X component of the vector
y	float	The Y component of the vector
z	float	The Z component of the vector

length property

length: float

The magnitude of the Vector

length_squared property

length_squared: float

The squared magnitude of the Vector

x property writable

x: float

The X component of the vector

y property writable

y: float

The Y component of the vector

z property writable

z: float

The Z component of the vector

distance

distance(other: Vector) -> float

The distance between this Vector and another

distance_squared

distance_squared(other: Vector) -> float

The squared distance between this Vector and another