All Classes and Interfaces
Class
Description
A
Batch which can be used when changes are required across chunk borders,
but the changes do not need any translation.Represents an inventory where items can be modified/retrieved.
Represents an object that has been safely acquired and can be freed again.
Called by an Instance when an entity is added to it.
Represents an advancement located in an
AdvancementTab.Used to manage all the registered
AdvancementTab.Represents an
Advancement which is the root of an AdvancementTab.AdvancementMapping maps the namespaced ID to the Advancement.
Represents a tab which can be shared between multiple players.
Called when a
Player opens the advancement screens or switch the tab
and when he closes the screen.Utility methods to convert adventure enums to their packet values.
Represents the aerodynamic properties of an entity
An argument is meant to be parsed when added into a
Command's syntax with Command.addSyntax(CommandExecutor, Argument[]).Represents a boolean value.
Callback executed when an error is found within the
Argument.Represents an argument which will give you a
Style containing the colour or no
colour if the argument was reset.Represents an argument giving an
Enchantment.Represents the target selector argument.
Represents an argument giving an
EntityType.Represents an argument which will give you an
FloatRange.Represents an argument which will give you an
IntRange.Argument which can be used to retrieve an
ItemStack from its material and with NBT data.Argument used to retrieve a
NBTCompound if you need key-value data.Argument used to retrieve a
NBT based object, can be any kind of tag like
NBTCompound, NBTList,
NBTInt, etc...Represents an argument giving a
Particle.Abstract class used by
ArgumentIntRange and ArgumentFloatRange.Represents a block position with 3 integers (x;y;z) which can take relative coordinates.
Represents a
Vec with 2 floating numbers (x;z) which can take relative coordinates.Represents a
Vec with 3 floating numbers (x;y;z) which can take relative coordinates.Argument which will take a quoted string.
Represents an argument which will take all the remaining of the command.
Exception triggered when an
Argument is wrongly parsed.Represents an argument giving a time (day/second/tick).
Convenient class listing all the basics
Argument.Represents a single word in the command.
Called when a player enters the configuration state (either on first connection, or if they are
sent back to configuration later).
Called before the player initialization, it can be used to kick the player before any connection
or to change his final username/uuid.
Represents a
living entity attribute.Represents an instance of an attribute and its modifiers.
Represent an attribute modifier.
A generic provider of
audiences or some subtype.Holder of custom audiences.
Utility class to access Adventure audiences.
Meta for all
Materials.WHITE_BANNER and Materials.SHIELD itemsAn event called when a basic query is received and ready to be responded to.
A basic query response containing a fixed set of responses.
A Batch is a tool used to cache a list of block changes, and apply the changes whenever you want.
Represents options for
Batchs.Represents a scoreboard which rendered a tag below the name.
Small monitoring tools that can be used to check the current memory usage and Minestom threads CPU usage.
Manages off-heap memory.
Class used to read from a byte array.
Class used to write to a byte array.
Allows servers to register custom dimensions.
Just a generic interface to hold data about biome particles
Represents a block that can be placed anywhere.
Represents a hint to retrieve blocks more efficiently.
Represents an element which can place blocks at position.
Interface used to provide block behavior.
Handler used for loaded blocks with unknown namespace
in order to do not lose the information while saving, and for runtime debugging purpose.
Represents an object forwarded to
BlockHandler.onPlace(Placement).This class performs ray tracing and iterates along blocks on a line
Represents an immutable block position.
Manages all boss bars known to this Minestom instance.
See https://wiki.vg/Entity_metadata#Mobs_2
BungeeCord forwarding support.
Represents a packet that is only computed when required (either due to memory demand or invalidated data)
Represents an
Event which can be cancelled.The messages that a player is willing to receive.
The different positions for chat messages.
Convenient class to check for common exceptions.
A chunk is a part of an
Instance, limited by a size of 16x256x16 blocks and subdivided in 16 sections of 16 blocks height.A Batch used when all of the block changed are contained inside a single chunk.
Deprecated.
Deprecated.
Used to customize which type of
Chunk an implementation should use.Represents a packet received from a client.
Contains registered packets and a way to instantiate them.
Called when a
PlayerConnection sends a ping packet,
usually after the status packet.The ClientSpectatePacket is sent when the client interacts with their hotbar to switch between entities.
Update action,
UPDATE_DATA indicates nothing special.Target the closest targetable entity (based on the target predicate)
A general purpose class for representing colors.
Allows entity to perform both melee and ranged attacks.
Represents a command which has suggestion/auto-completion.
Functional interface used by the
CommandManager
to execute a callback if an unknown command is run.Used to know if the
CommandSender is allowed to run the command or a specific syntax.Class used to retrieve argument data in a
CommandExecutor.Class responsible for parsing
Command.Callback executed once a syntax has been found for a
Command.Manager used to register
commands.Class used to parse complete command inputs.
Represents something which can send commands to the server.
Holds the data of an invalidated syntax.
Represents a syntax in
Command
which is initialized with Command.addSyntax(CommandExecutor, Argument[]).Represents an object that holds some amount of components.
Common command conditions
Manages the connected clients.
Represents the current connection state of a
PlayerConnection.Represents the console when sending a command to the server.
Represents a custom effect in
PotionMeta.Represents a type of damage, required when calling
LivingEntity.damage(Damage)
and retrieved in EntityDamageEvent.See https://wiki.vg/Protocol#Damage_Event for more info.
Utils class useful for debugging purpose.
Those are all the difficulties which can be displayed in the player menu.
https://minecraft.wiki/w/Custom_dimension
Allows servers to register custom dimensions.
Framebuffer with direct access to the colors arrayRepresents an extension from an `extension.json` that is capable of powering an Extension object.
Particle effect which used based on the color values.
AUTOGENERATED by DyeColorGenerator
Represents a
Chunk which store each individual block in memory.Effects available in Minecraft Vanilla
Could be a player, a monster, or an object.
Represents an entity which can contain
goal selectors and target selectors.Represents a group of entity's AI.
Called when a player does a left click on an entity or with
EntityCreature.attack(Entity).Represents damage inflicted by an
Entity.Called with
LivingEntity.damage(DamageType, float).Called right before an entity is removed
Represents any event called on an
Entity.Represents a query which can be call to find one or multiple entities.
Represents an
EntityEvent which happen in Entity.getInstance().Called when two
ItemEntity are merging their ItemStack together to form a sole entity.Class that allows to instantiate entities with projectile-like physics handling.
Represents damage inflicted by an entity, via a projectile.
Called with
EntityProjectile.shoot(Point, double, double)Called when a new instance is set for an entity.
Called when an entity ticks itself.
Represents the type of entity you want to retrieve.
Callback to know the newly visible entities and those to remove.
Called when a velocity is applied to an entity using
Entity.setVelocity(Vec).Event which can be listened to by an
EventNode using EventNode.addListener(EventListener).Represents a filter for a specific
Event type.Represents an element which can have
Event listeners assigned to it.Represents an event listener (handler) in an event graph.
Represents a single node in an event graph.
Used when you want to implement your own exception handling, instead of just printing the stack trace.
Manages the handling of exceptions.
Abstract explosion.
An enumeration that representing all available firework types.
Framebuffer to render to a map
Represents a packet which is already framed.
Describes the frame around the Advancement.
The enum contains all variants from a frog which are currently implemented in the game.
An event called when a full query is received and ready to be responded to.
A full query response containing a dynamic set of responses.
Represents the game mode of a player.
Represents an area that can be generated.
Object containing all the global event listeners.
Framebuffer that embeds a BufferedImage, allowing for rendering directly via Graphics2D or its pixel array.Interface implemented to change the way chunks are loaded/saved.
Instances are what are called "worlds" in Minecraft, you can add an entity in it using
Entity.setInstance(Instance).Called when a chunk in an instance is loaded.
Called when a chunk in an instance is unloaded.
InstanceContainer is an instance that contains chunks in contrary to SharedInstance.
Represents any event targeting an
Instance.Used to register
Instance.Called when an instance is registered
Called when an instance processes a tick.
Called when an instance is unregistered
The event is triggered by the server when an instance successfully changes its world spawn position.
Represents an inventory which can be viewed by a collection of
Player.Called after
InventoryPreClickEvent, this event cannot be cancelled and items related to the click
are already moved.Represents an inventory which can receive click input.
Called when an
Inventory is closed by a player.Can be added to any
AbstractInventory
using AbstractInventory.addInventoryCondition(InventoryCondition)
or AbstractInventory.addInventoryCondition(InventoryCondition)
in order to listen to any issued clicks.Used by
InventoryCondition to step in inventory click processing.Represents any event inside an
Inventory.Called when
AbstractInventory.safeItemInsert(int, ItemStack) is being invoked.Called when a player open an
Inventory.Called before
InventoryClickEvent, used to potentially cancel the click.List of inventory property and their ID
Represents a type of
InventoryRepresents an item on the ground.
Represents any event called about an
ItemStack.Represents a hide flag which can be applied to an
ItemStack using ItemMeta.Builder.hideFlag(int).Particle effect which used based on an item inside the biome.
Represents an immutable item to be placed inside
PlayerInventory,
Inventory or even on the ground ItemEntity.LargeFramebuffer with direct access to the colors array.Framebuffer that is meant to be split in sub-framebuffers.
LargeFramebuffer that embeds a BufferedImage,
allowing for rendering directly via Graphics2D or its pixel array.Targets the last damager of this entity.
Represents a packet that is lazily allocated.
A chunk which supports lighting computation.
Represents a key to a listenable event, retrievable from
EventNode.getHandle(Class).Represents something which can have a locale.
How does Minestom compute RGB to MapColor transitions?
Attacks the entity's target (
EntityCreature.getTarget()) OR the closest entity
which can be targeted with the entity TargetSelector.Utility class to handle client chat settings.
The main server class used to start the server and retrieve all the managers.
Adventure related constants, etc.
Utils class using mojang API.
Represents a namespaced ID
https://minecraft.wiki/w/Namespaced_ID
Represents an entity which can use the pathfinder.
Necessary object for all
NavigableEntity.Deprecated, for removal: This API element is subject to removal in a future version.
As of Minestom 22a8ccabfae38c53df0605000aa7eed49765c1ab, because the Maintainability is very hard and
can break everytime from Mojang side because bad api design use
Notification.builder() instead.Is used to send temporary advancements to the client, which are called notifications.
Deprecated, for removal: This API element is subject to removal in a future version.
As of Minestom 22a8ccabfae38c53df0605000aa7eed49765c1ab, because the Maintainability is very hard and
can break everytime from Mojang side because bad api design use
Notification.builder() instead.Represents an array which will be resized to the highest required index.
Utility class to manage opening the server to LAN.
Configuration for opening the server to LAN.
Convenient class to execute callbacks which can be null.
An audience implementation that sends grouped packets if possible.
Small convenient interface to use method references with
PacketListenerManager.setPlayListener(Class, PacketPlayListenerConsumer).Small convenient interface to use method references with
PacketListenerManager.setListener(ConnectionState, Class, PacketPrePlayListenerConsumer).Responsible for processing client packets.
Utils class for packets.
Represents a palette used to store blocks and biomes.
Represents a
Command ready to be executed (already parsed).Representation of a permission granted to a
CommandSender.Represents an object which can have permissions.
Interface used to check if the
nbt data of a Permission is correct.Those are the major actors of the server
Represents the main or off hand of the player.
Represents where is located the main hand of the player (can be changed in Minecraft option).
Called when a player interacts with a block (right-click).
Called when a player tries placing a block.
Called when a
Player stops digging a block before it is brokenCalled when a player change his held slot (by pressing 1-9 keys).
Called every time a
Player write and send something in the chat.Represents an outgoing chat message packet.
Called when a player receive a new chunk data.
Called after a chunk being unload to a certain player.
Called every time a player send a message starting by '/'.
A PlayerConnection is an object needed for all created
Player.Called when a player die in
Player.kill().Called when a player disconnect.
Called when a player is finished eating.
Represents any event called on a
Player.Called when a
Player successfully finishes digging a blockCalled when the gamemode of a player is being modified.
Called when the player swings his hand.
Represents an
PlayerEvent which happen in Entity.getInstance().Represents the inventory of a
Player, retrieved with Player.getInventory().Called when
AbstractInventory.safeItemInsert(int, ItemStack) is being invoked on a PlayerInventory.Used when a
Player finish the animation of an item.Called when a player is modifying his position.
Listen to outgoing packets asynchronously.
Called when a player send
ClientPluginMessagePacket.Called before the PlayerEatEvent and can be used to change the eating time
or to cancel its processing, cancelling the event means that the player will
continue the animation indefinitely.
Used when you want to provide your own player object instead of using the default one.
Player's public key used to sign chat messages
Called when a player warns the server of a resource pack status.
Called when
Player.respawn() is executed (for custom respawn or as a result of
ClientStatusPacketCalled after the player signals the server that his settings has been modified.
Contains all the data required to store a skin.
Called at the player connection to initialize his skin.
Represents a socket connection.
Called when a new instance is set for a player.
Called by the SpectateListener when a player starts spectating an entity.
Called when a player start flying.
Called when a player starts sneaking.
Called when a player starts sprinting.
Represents a single statistic in the "statistics" game menu.
Called when a player stop flying.
Called when a player stops sneaking.
Called when a player stops sprinting.
Called when a player is trying to swap his main and off hand item.
Called at each player tick.
Event when an item is used without clicking on a block.
Used when a player is clicking on a block with an item (but is not a block in item form).
Represents a 3D point.
Represents a position containing coordinates and a view.
Represents damage that is associated with a certain position.
Represents a potion effect that can be added to an
Entity.Utility class to manage responses to the GameSpy4 Query Protocol.
An event called when a query is received and ready to be responded to.
An enum of default query keys.
Represents the base for any data type that is numeric.
The function used to generate a projectile.
Represents an element which can read from a
BinaryReader.Handles registry data, used by
StaticProtocolObject implementations and is strictly internal.A
Batch which can be used when changes are required across chunk borders, and
are going to be reused in different places.Represents a location which can have fields relative to an
Entity position.Called by an Instance when an entity is removed from it.
Represents the data sent to the player when responding to a ping event.
Represents a scheduler that will execute tasks with a precision based on its ticking rate.
This interface represents all scoreboard of Minecraft.
This enumeration represents all available types for the scoreboard objective
Represents a packet that can be sent to a
PlayerConnection.Contains server settings/flags to be set with system properties.
Called when a
PlayerConnection sends a status packet,
usually to display information on the server list.An enum containing the different types of server list ping responses.
Represents a packet which can be sent to a player using
PlayerConnection.sendPacket(SendablePacket).Sender used in
CommandManager.executeServerCommand(String).Represents the complete state of the server at a given moment.
The
SharedInstance is an instance that shares the same chunks as its linked InstanceContainer,
entities are separated.Represents a sidebar which can contain up to 16
Sidebar.ScoreboardLine.This class is used to create a line for the sidebar.
General purpose functional interface to verify signatures.
Built in validators:
Built in validators:
SignatureValidator.PASS: will always report true
SignatureValidator.FAIL: will always report false
SignatureValidator.YGGDRASIL: Uses SHA1 with RSA and Yggdrasil Public Key for
verifying signatures
SignatureValidator.from(Player): Uses SHA256 with RSA and the
Player's PlayerPublicKey.publicKey()
SignatureValidator.from(PublicKey, KeyUtils.SignatureAlgorithm): General purpose factory method
Represents a snapshot of a game object.
Represents an object which is regularly saved into a snapshot.
Represents the context of a snapshot build.
Represents the stacking rule of an
ItemStack.Represents the
Player tab list as a Scoreboard.Metadata implementation for a Tadpole entity.
Represents a group of items, blocks, fluids, entity types or function.
Represents a key to retrieve or change a value.
Represents an element which can read and write
tags.Handles loading and caching of tags.
Represents an element which can read
tags.Interface used to create custom
tags.Represents an element which can write
tags.The target selector is called each time the entity receives an "attack" instruction
without having a target.
This object represents a team on a scoreboard that has a common display theme and other properties.
A builder which represents a fluent Object to built teams.
An object which manages all the
Team'sThe packet creates or updates teams
An enumeration which representing all rules for the collision
An enumeration which representing all visibility states for the name tags
Used to link chunks into multiple groups.
Defines how often chunks thread should be refreshed.
A TemporalUnit that represents one tick.
Represents an element which is ticked at a regular interval.
Tick related utilities.
Represents a type of transaction that you can apply to an
AbstractInventory.An utilities class for
UUID.Deprecated.
Used when you want to provide your own
UUID object for players instead of using the default one.Holds the data of a validated syntax.
Represents an immutable 3D vector.
Support for Velocity modern forwarding.
Represents something which can be displayed or hidden to players.
This metadata implementation can be used for a warden entity.
Represents the possible weather properties of an instance
Represents the world border of an
Instance,
can be retrieved with Instance.getWorldBorder().Represents an element which can write to a
BinaryWriter.
Generator