endstone/event

Classes

Name	Description
`ActorDamageEvent`	Called when an Actor is damaged.
`ActorDeathEvent`	Called when an Actor dies.
`ActorEvent`	Represents an Actor-related event.
`ActorExplodeEvent`	Called when an actor explodes.
`ActorKnockbackEvent`	Called when a living entity receives knockback.
`ActorRemoveEvent`	Called when an Actor is removed.
`ActorSpawnEvent`	Called when an Actor is spawned into a world.
`ActorTeleportEvent`	Called when a non-player entity is teleported from one location to another.
`BlockBreakEvent`	Called when a block is broken by a player.
`BlockCookEvent`	Called when an ItemStack is successfully cooked in a block.
`BlockEvent`	Represents an Block-related event.
`BlockExplodeEvent`	Called when a block explodes (e.g. bed in the Nether, respawn anchor in the Overworld).
`BlockFormEvent`	Called when a block is formed or spreads based on world conditions.
`BlockFromToEvent`	Represents events with a source block and a destination block, currently only applies to liquid (lava and water) and teleporting dragon eggs.
`BlockGrowEvent`	Called when a block grows naturally in the world.
`BlockPistonEvent`	Called when a piston block is triggered.
`BlockPistonExtendEvent`	Called when a piston extends.
`BlockPistonRetractEvent`	Called when a piston retracts.
`BlockPlaceEvent`	Called when a block is placed by a player.
`BroadcastMessageEvent`	Event triggered for server broadcast messages such as from Server::broadcast.
`Cancellable`	A type characterizing events that may be cancelled by a plugin or the server.
`ChunkEvent`	Represents a Chunk related event.
`ChunkLoadEvent`	Called when a chunk is loaded.
`ChunkUnloadEvent`	Called when a chunk is unloaded.
`DimensionEvent`	Represents events within a level.
`Event`	Represents an event.
`EventHandler`	Represents a registered EventHandler which associates with a Plugin.
`HandlerList`	A list of event handlers. Should be instantiated on a per-event basis.
`ICancellable`
`LeavesDecayEvent`	Called when leaves are decaying naturally.
`LevelEvent`	Represents events within a level.
`MapInitializeEvent`	Called when a map is initialized.
`PacketReceiveEvent`	Called when the server receives a packet from a connected client.
`PacketSendEvent`	Called when the server sends a packet to a connected client.
`PlayerBedEnterEvent`	Called when a player is almost about to enter the bed.
`PlayerBedLeaveEvent`	Called when a player is leaving a bed.
`PlayerChatEvent`	Called when a player sends a chat message.
`PlayerCommandEvent`	Called whenever a player runs a command.
`PlayerDeathEvent`	Called when a Player dies.
`PlayerDimensionChangeEvent`	Called when a player switches to another dimension.
`PlayerDropItemEvent`	Called when a player drops an item from their inventory.
`PlayerEmoteEvent`	Called when a player uses an emote.
`PlayerEvent`	Represents a player related event.
`PlayerGameModeChangeEvent`	Called when the GameMode of the player is changed.
`PlayerInteractActorEvent`	Represents an event that is called when a player right-clicks an actor.
`PlayerInteractEvent`	Represents an event that is called when a player interacts with an object or air.
`PlayerItemConsumeEvent`	Called when a player is finishing consuming an item (food, potion, milk bucket).
`PlayerItemHeldEvent`	Called when a player changes their currently held item.
`PlayerJoinEvent`	Called when a player joins a server.
`PlayerJumpEvent`	Called when a player jumps.
`PlayerKickEvent`	Called when a player gets kicked from the server.
`PlayerLoginEvent`	Called when a player attempts to login in.
`PlayerMoveEvent`	Called when a player moves.
`PlayerPickupItemEvent`	Called when a player picks an item up from the ground.
`PlayerPortalEvent`	Called when a player is about to teleport because it is in contact with a portal.
`PlayerQuitEvent`	Called when a player leaves a server.
`PlayerRespawnEvent`	Called when a player respawns.
`PlayerSkinChangeEvent`	Called when a player changes their skin.
`PlayerTeleportEvent`	Called when a player is teleported from one location to another.
`PluginDisableEvent`	Called when a plugin is disabled.
`PluginEnableEvent`	Called when a plugin is enabled.
`ScriptMessageEvent`	Called when a message is sent by /scriptevent command.
`ServerCommandEvent`	Called when the console runs a command, early in the process.
`ServerEvent`	Represents a Server-related event.
`ServerListPingEvent`	Called when a server ping is coming in.
`ServerLoadEvent`	Called when either the server startup or reload has completed.
`ThunderChangeEvent`	Called when the thunder state in a world is changing.
`WeatherChangeEvent`	Called when the weather (rain) state in a world is changing.
`WeatherEvent`	Represents a Weather-related event.

Enums

Name	Description
`EventPriority`	Represents an event's priority in execution.
`EventResult`

`class`ActorDamageEvent

Defined in <endstone/event/actor/actor_damage_event.h>

Bases: Cancellable<ActorEvent<Mob>>

Called when an Actor is damaged.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorDamageEvent`
`getDamage`	Gets the raw amount of damage caused by the event.
`setDamage`	Sets the raw amount of damage caused by the event.
`getDamageSource`	Get the source of damage.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorDamageEvent)

`meth`ActorDamageEvent

ActorDamageEvent(Mob& actor, std::unique_ptr<DamageSource> damage_source, const float damage)

`meth`getDamageconst

float getDamage() const

Gets the raw amount of damage caused by the event.

Returns

Type	Description
`float`	The raw amount of damage caused by the event

`meth`setDamage

void setDamage(const float damage)

Sets the raw amount of damage caused by the event.

Parameters

Name	Type	Description
`damage`	`const float`	The raw amount of damage caused by the event

`meth`getDamageSourceconst

DamageSource& getDamageSource() const

Get the source of damage.

Returns

Type	Description
`DamageSource&`	a DamageSource detailing the source of the damage.

`class`ActorDeathEvent

Defined in <endstone/event/actor/actor_death_event.h>

Bases: ActorEvent<Mob>

Called when an Actor dies.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorDeathEvent`
`getDamageSource`	Gets the source of damage which caused the death.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorDeathEvent)

`meth`ActorDeathEvent

ActorDeathEvent(Mob& actor, std::unique_ptr<DamageSource> damage_source)

`meth`getDamageSourceconst

DamageSource& getDamageSource() const

Gets the source of damage which caused the death.

Returns

Type	Description
`DamageSource&`	a DamageSource detailing the source of the damage for the death.

`class`ActorEvent

Defined in <endstone/event/actor/actor_event.h>

Bases: Event

Represents an Actor-related event.

Methods

Name	Description
`ActorEvent`
`~ActorEvent`
`getActor`	Returns the Actor involved in this event.

`meth`ActorEventexplicit

ActorEvent(ActorType& actor)

`meth`~ActorEvent

~ActorEvent() override=default

`meth`getActorconst

ActorType& getActor() const

Returns the Actor involved in this event.

Returns

Type	Description
`ActorType&`	Actor which is involved in this event

`class`ActorExplodeEvent

Defined in <endstone/event/actor/actor_explode_event.h>

Bases: Cancellable<ActorEvent<Actor>>

Called when an actor explodes.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorExplodeEvent`
`~ActorExplodeEvent`
`getLocation`	Returns the location where the explosion happened.
`getBlockList`	Returns the list of blocks that would have been removed or were removed from the explosion event.
`getBlockList`	Returns the list of blocks that would have been removed or were removed from the explosion event.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorExplodeEvent)

`meth`ActorExplodeEventexplicit

ActorExplodeEvent(Actor& actor, Location location, BlockList blocks)

`meth`~ActorExplodeEvent

~ActorExplodeEvent() override=default

`meth`getLocationconst

const Location& getLocation() const

Returns the location where the explosion happened.

It is not possible to get this value from the Entity as the Entity no longer exists in the world.

Returns

Type	Description
`const Location&`	The location of the explosion

`meth`getBlockListconst

const BlockList& getBlockList() const

Returns the list of blocks that would have been removed or were removed from the explosion event.

Returns

Type	Description
`const BlockList&`	All blown-up blocks

`meth`getBlockList

BlockList& getBlockList()

Returns the list of blocks that would have been removed or were removed from the explosion event.

Returns

Type	Description
`BlockList&`	All blown-up blocks

`class`ActorKnockbackEvent

Defined in <endstone/event/actor/actor_knockback_event.h>

Bases: Cancellable<ActorEvent<Mob>>

Called when a living entity receives knockback.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorKnockbackEvent`
`getSource`	Get the source actor that has caused knockback to the defender, if exists.
`getKnockback`
`setKnockback`	Sets the knockback that will be applied to the entity.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorKnockbackEvent)

`meth`ActorKnockbackEventexplicit

ActorKnockbackEvent(Mob& mob, Actor* source, Vector knockback)

`meth`getSourceconst

Actor* getSource() const

Get the source actor that has caused knockback to the defender, if exists.

Returns

Type	Description
`Actor*`	actor that caused knockback, or nullptr if the knockback is not caused by an actor.

`meth`getKnockbackconst

Vector getKnockback() const

Gets the knockback that will be applied to the entity.

Note: this method returns a copy, changes must be applied with setKnockback(Vector)

Returns

Type	Description
`Vector`	the knockback

`meth`setKnockback

void setKnockback(Vector knockback)

Sets the knockback that will be applied to the entity.

Parameters

Name	Type	Description
`knockback`	`Vector`	the knockback to apply

`class`ActorRemoveEvent

Defined in <endstone/event/actor/actor_remove_event.h>

Bases: ActorEvent<Actor>

Called when an Actor is removed.

This event should only be used for monitoring. Modifying the actor during or after this event leads to undefined behaviours. This event will not be called for Players.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorRemoveEvent)

`meth`ActorEventexplicit

ActorEvent(ActorType& actor)

`class`ActorSpawnEvent

Defined in <endstone/event/actor/actor_spawn_event.h>

Bases: Cancellable<ActorEvent<Actor>>

Called when an Actor is spawned into a world.

If an Actor Spawn event is cancelled, the actor will not spawn.

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorSpawnEvent`
`~ActorSpawnEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorSpawnEvent)

`meth`ActorSpawnEventexplicit

ActorSpawnEvent(Actor& actor)

`meth`~ActorSpawnEvent

~ActorSpawnEvent() override=default

`class`ActorTeleportEvent

Defined in <endstone/event/actor/actor_teleport_event.h>

Bases: Cancellable<ActorEvent<Actor>>

Called when a non-player entity is teleported from one location to another.

This may be as a result of natural causes (Enderman, Shulker), pathfinding (Wolf), or commands (/teleport).

Methods

Name	Description
`ENDSTONE_EVENT`
`ActorTeleportEvent`
`~ActorTeleportEvent`
`getFrom`	Gets the location that this actor moved from.
`setFrom`	Sets the location that this actor moved from.
`getTo`	Gets the location that this actor moved to.
`setTo`	Sets the location that this actor moved to.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ActorTeleportEvent)

`meth`ActorTeleportEventexplicit

ActorTeleportEvent(Actor& actor, Location from, Location to)

`meth`~ActorTeleportEvent

~ActorTeleportEvent() override=default

`meth`getFromconst

const Location& getFrom() const

Gets the location that this actor moved from.

Returns

Type	Description
`const Location&`	Location this actor moved from

`meth`setFrom

void setFrom(const Location& from)

Sets the location that this actor moved from.

Parameters

Name	Type	Description
`from`	`const Location&`	New location this actor moved from

`meth`getToconst

const Location& getTo() const

Gets the location that this actor moved to.

Returns

Type	Description
`const Location&`	Location this actor moved to

`meth`setTo

void setTo(const Location& to)

Sets the location that this actor moved to.

Parameters

Name	Type	Description
`to`	`const Location&`	New Location this actor moved to

`class`BlockBreakEvent

Defined in <endstone/event/block/block_break_event.h>

Bases: Cancellable<BlockEvent>

Called when a block is broken by a player.

If a BlockBreakEvent is cancelled, the block will not break and experience will not drop.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockBreakEvent`
`~BlockBreakEvent`
`getPlayer`	Gets the Player that is breaking the block involved in this event.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockBreakEvent)

`meth`BlockBreakEventexplicit

BlockBreakEvent(std::unique_ptr<Block> block, Player& player)

`meth`~BlockBreakEvent

~BlockBreakEvent() override=default

`meth`getPlayerconst

Player& getPlayer() const

Gets the Player that is breaking the block involved in this event.

Returns

Type	Description
`Player&`	The Player that is breaking the block involved in this event

`class`BlockCookEvent

Defined in <endstone/event/block/block_cook_event.h>

Bases: Cancellable<BlockEvent>

Called when an ItemStack is successfully cooked in a block.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockCookEvent`
`getSource`	Gets the smelted ItemStack for this event.
`getResult`	Gets the resultant ItemStack for this event.
`setResult`	Sets the resultant ItemStack for this event.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockCookEvent)

`meth`BlockCookEvent

BlockCookEvent(std::unique_ptr<Block> block, ItemStack source, ItemStack result)

`meth`getSourceconst

const ItemStack& getSource() const

Gets the smelted ItemStack for this event.

Returns

Type	Description
`const ItemStack&`	smelting source ItemStack

`meth`getResultconst

const ItemStack& getResult() const

Gets the resultant ItemStack for this event.

Returns

Type	Description
`const ItemStack&`	smelting result ItemStack

`meth`setResult

void setResult(ItemStack result)

Sets the resultant ItemStack for this event.

Parameters

Name	Type	Description
`result`	`ItemStack`	new result ItemStack

`class`BlockEvent

Defined in <endstone/event/block/block_event.h>

Bases: Event

Represents an Block-related event.

Variables

Name	Description
`block_`

Methods

Name	Description
`BlockEvent`
`getBlock`	Gets the block involved in this event.

`var`block_protected

std::unique_ptr<Block> block_

`meth`BlockEventexplicit

BlockEvent(std::unique_ptr<Block> block)

`meth`getBlockconst

Block& getBlock() const

Gets the block involved in this event.

Returns

Type	Description
`Block&`	The Block which block is involved in this event

`class`BlockExplodeEvent

Defined in <endstone/event/block/block_explode_event.h>

Bases: Cancellable<BlockEvent>

Called when a block explodes (e.g. bed in the Nether, respawn anchor in the Overworld).

If a BlockExplodeEvent is cancelled, the explosion will not occur.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockExplodeEvent`
`~BlockExplodeEvent`
`getBlockList`	Returns the list of blocks that would have been removed or were removed from the explosion event.
`getBlockList`	Returns the list of blocks that would have been removed or were removed from the explosion event.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockExplodeEvent)

`meth`BlockExplodeEventexplicit

BlockExplodeEvent(std::unique_ptr<Block> block, BlockList blocks)

`meth`~BlockExplodeEvent

~BlockExplodeEvent() override=default

`meth`getBlockListconst

const BlockList& getBlockList() const

Returns the list of blocks that would have been removed or were removed from the explosion event.

Returns

Type	Description
`const BlockList&`	All blown-up blocks

`meth`getBlockList

BlockList& getBlockList()

Returns the list of blocks that would have been removed or were removed from the explosion event.

Returns

Type	Description
`BlockList&`	All blown-up blocks

`class`BlockFormEvent

Defined in <endstone/event/block/block_form_event.h>

Bases: BlockGrowEvent

Called when a block is formed or spreads based on world conditions.

Use BlockSpreadEvent to catch blocks that actually spread and don't just "randomly" form.

Examples:

Snow forming due to a snow storm.
Ice forming in a snowy Biome like Taiga or Tundra.
Obsidian / Cobblestone forming due to contact with water.
Concrete forming due to mixing of concrete powder and water.

If a Block Form event is cancelled, the block will not be formed.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockGrowEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockFormEvent)

`meth`BlockGrowEventexplicit

BlockGrowEvent(std::unique_ptr<Block> block, std::unique_ptr<BlockState> new_state)

`class`BlockFromToEvent

Defined in <endstone/event/block/block_from_to_event.h>

Bases: Cancellable<BlockEvent>

Represents events with a source block and a destination block, currently only applies to liquid (lava and water) and teleporting dragon eggs.

If a Block From To event is cancelled, the block will not move (the liquid will not flow).

Variables

Name	Description
`to_`

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockFromToEvent`
`getToBlock`	Convenience method for getting the faced Block.

`var`to_protected

std::unique_ptr<Block> to_

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockFromToEvent)

`meth`BlockFromToEventexplicit

BlockFromToEvent(std::unique_ptr<Block> block, std::unique_ptr<Block> to_block)

`meth`getToBlockconst

Block& getToBlock() const

Convenience method for getting the faced Block.

Returns

Type	Description
`Block&`	The faced Block

`class`BlockGrowEvent

Defined in <endstone/event/block/block_grow_event.h>

Bases: Cancellable<BlockEvent>

Called when a block grows naturally in the world.

If a Block Grow event is cancelled, the block will not grow.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockGrowEvent`
`getNewState`	Gets the state of the block where it will form or spread to.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockGrowEvent)

`meth`BlockGrowEventexplicit

BlockGrowEvent(std::unique_ptr<Block> block, std::unique_ptr<BlockState> new_state)

`meth`getNewStateconst

BlockState& getNewState() const

Gets the state of the block where it will form or spread to.

Returns

Type	Description
`BlockState&`	The block state for this events block

`class`BlockPistonEvent

Defined in <endstone/event/block/block_piston_event.h>

Bases: Cancellable<BlockEvent>

Called when a piston block is triggered.

Methods

Name	Description
`BlockPistonEvent`
`getDirection`	Return the direction in which the piston will operate.

`meth`BlockPistonEventexplicit

BlockPistonEvent(std::unique_ptr<Block> block, BlockFace direction)

`meth`getDirectionconst

BlockFace getDirection() const

Return the direction in which the piston will operate.

Returns

Type	Description
`BlockFace`	direction of the piston

`class`BlockPistonExtendEvent

Defined in <endstone/event/block/block_piston_extend_event.h>

Bases: BlockPistonEvent

Called when a piston extends.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockPistonEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockPistonExtendEvent)

`meth`BlockPistonEventexplicit

BlockPistonEvent(std::unique_ptr<Block> block, BlockFace direction)

`class`BlockPistonRetractEvent

Defined in <endstone/event/block/block_piston_retract_event.h>

Bases: BlockPistonEvent

Called when a piston retracts.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockPistonEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockPistonRetractEvent)

`meth`BlockPistonEventexplicit

BlockPistonEvent(std::unique_ptr<Block> block, BlockFace direction)

`class`BlockPlaceEvent

Defined in <endstone/event/block/block_place_event.h>

Bases: Cancellable<BlockEvent>

Called when a block is placed by a player.

If a BlockPlaceEvent is cancelled, the block will not be placed.

Methods

Name	Description
`ENDSTONE_EVENT`
`BlockPlaceEvent`
`~BlockPlaceEvent`
`getPlayer`	Gets the player who placed the block involved in this event.
`getBlockPlacedState`	Gets the BlockState for the block which was placed.
`getBlockReplaced`	Gets the block which was replaced.
`getBlockAgainst`	Gets the block that this block was placed against.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BlockPlaceEvent)

`meth`BlockPlaceEventexplicit

BlockPlaceEvent(std::unique_ptr<BlockState> placed_block, std::unique_ptr<Block> replaced_block, std::unique_ptr<Block> placed_against, Player& player)

`meth`~BlockPlaceEvent

~BlockPlaceEvent() override=default

`meth`getPlayerconst

Player& getPlayer() const

Gets the player who placed the block involved in this event.

Returns

Type	Description
`Player&`	The Player who placed the block involved in this event

`meth`getBlockPlacedStateconst

BlockState& getBlockPlacedState() const

Gets the BlockState for the block which was placed.

Returns

Type	Description
`BlockState&`	The BlockState for the block which was placed.

`meth`getBlockReplacedconst

Block& getBlockReplaced() const

Gets the block which was replaced.

Returns

Type	Description
`Block&`	The Block which was replaced.

`meth`getBlockAgainstconst

Block& getBlockAgainst() const

Gets the block that this block was placed against.

Returns

Type	Description
`Block&`	Block the block that the new block was placed against

`class`BroadcastMessageEvent

Defined in <endstone/event/server/broadcast_message_event.h>

Bases: Cancellable<ServerEvent>

Event triggered for server broadcast messages such as from Server::broadcast.

This event should be async if fired from an async thread.

Methods

Name	Description
`ENDSTONE_EVENT`
`BroadcastMessageEvent`
`getMessage`
`setMessage`
`getRecipients`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(BroadcastMessageEvent)

`meth`BroadcastMessageEvent

BroadcastMessageEvent(bool async, Message message, std::unordered_set<const CommandSender*> recipients)

`meth`getMessageconst

const Message& getMessage() const

Get the message to broadcast.

Returns

Type	Description
`const Message&`	Message to broadcast

`meth`setMessage

void setMessage(Message message)

Set the message to broadcast.

Parameters

Name	Type	Description
`message`	`Message`	New message to broadcast

`meth`getRecipientsconst

const std::unordered_set<const CommandSender*>& getRecipients() const

Gets a set of recipients that this broadcast message will be displayed to.

Returns

Type	Description
`const std::unordered_set<const CommandSender*>&`	All CommandSenders who will see this broadcast message

`class`Cancellable

Defined in <endstone/event/cancellable.h>

Bases: EventType, ICancellable

A type characterizing events that may be cancelled by a plugin or the server.

Methods

Name	Description
`isCancelled`	Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
`setCancelled`	Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
`cancel`	Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

`meth`isCancelledvirtualconstoverride

bool isCancelled() const override

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Returns

Type	Description
`bool`	true if this event is cancelled

`meth`setCancelledvirtualoverride

void setCancelled(bool cancel) override

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters

Name	Type	Description
`cancel`	`bool`	true if you wish to cancel this event

`meth`cancelvirtualoverride

void cancel() final

Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

`class`ChunkEvent

Defined in <endstone/event/chunk/chunk_event.h>

Bases: DimensionEvent

Represents a Chunk related event.

Methods

Name	Description
`ChunkEvent`
`getChunk`

`meth`ChunkEventexplicit

ChunkEvent(Chunk& chunk)

`meth`getChunkconst

Chunk& getChunk() const

Gets the chunk being loaded/unloaded

Returns

Type	Description
`Chunk&`	Chunk that triggered this event

`class`ChunkLoadEvent

Defined in <endstone/event/chunk/chunk_load_event.h>

Bases: ChunkEvent

Called when a chunk is loaded.

Methods

Name	Description
`ENDSTONE_EVENT`
`ChunkLoadEvent`
`~ChunkLoadEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ChunkLoadEvent)

`meth`ChunkLoadEventexplicit

ChunkLoadEvent(Chunk& chunk)

`meth`~ChunkLoadEvent

~ChunkLoadEvent() override=default

`class`ChunkUnloadEvent

Defined in <endstone/event/chunk/chunk_unload_event.h>

Bases: ChunkEvent

Called when a chunk is unloaded.

Methods

Name	Description
`ENDSTONE_EVENT`
`ChunkUnloadEvent`
`~ChunkUnloadEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ChunkUnloadEvent)

`meth`ChunkUnloadEventexplicit

ChunkUnloadEvent(Chunk& chunk)

`meth`~ChunkUnloadEvent

~ChunkUnloadEvent() override=default

`class`DimensionEvent

Defined in <endstone/event/level/dimension_event.h>

Bases: LevelEvent

Represents events within a level.

Methods

Name	Description
`DimensionEvent`
`getDimension`

`meth`DimensionEventexplicit

DimensionEvent(Dimension& dimension)

`meth`getDimensionconst

Dimension& getDimension() const

Gets the dimension primarily involved with this event

Returns

Type	Description
`Dimension&`	Dimension which caused this event

`class`Event

Defined in <endstone/event/event.h>

Represents an event.

Methods

Name	Description
`Event`
`Event`
`operator=`
`Event`
`operator=`
`~Event`
`getEventName`
`isAsynchronous`

`meth`Eventexplicit

Event(bool async = false)

`meth`Event

Event(const Event&) =delete

`meth`operator=

Event& operator=(const Event&) =delete

`meth`Event

Event(Event&&) =default

`meth`operator=

Event& operator=(Event&&) =default

`meth`~Eventvirtual

~Event() =default

`meth`getEventNameabstractconst

std::string getEventName() const =0

Gets a user-friendly identifier for this event.

Returns

Type	Description
`std::string`	name of this event

`meth`isAsynchronousconst

bool isAsynchronous() const

Any custom event that should not by synchronized with other events must use the specific constructor.

Returns

Type	Description
`bool`	false by default, true if the event fires asynchronously

`class`EventHandler

Defined in <endstone/event/event_handler.h>

Represents a registered EventHandler which associates with a Plugin.

Methods

Name	Description
`EventHandler`
`getPlugin`
`getPriority`
`isIgnoreCancelled`
`callEvent`
`getEventType`

`meth`EventHandler

EventHandler(std::string event, std::function<void(Event&)> executor, EventPriority priority, Plugin& plugin, bool ignore_cancelled)

`meth`getPluginconst

Plugin& getPlugin() const

Gets the plugin for this registration

Returns

Type	Description
`Plugin&`	Registered Plugin

`meth`getPriorityconst

EventPriority getPriority() const

Gets the priority for this registration

Returns

Type	Description
`EventPriority`	Registered Priority

`meth`isIgnoreCancelledconst

bool isIgnoreCancelled() const

Whether this listener accepts cancelled events

Returns

Type	Description
`bool`	True when ignoring cancelled events

`meth`callEventconst

void callEvent(Event& event) const

Calls the event executor

Parameters

Name	Type	Description
`event`	`Event&`	The event

`meth`getEventTypeconst

std::string getEventType() const

Gets the event type for this registration

Returns

Type	Description
`std::string`	Registered event type

`class`HandlerList

Defined in <endstone/event/handler_list.h>

A list of event handlers. Should be instantiated on a per-event basis.

Methods

Name	Description
`HandlerList`
`registerHandler`
`unregister`
`unregister`
`getHandlers`
`bake`

`meth`HandlerListexplicit

HandlerList(std::string event)

`meth`registerHandler

EventHandler* registerHandler(std::unique_ptr<EventHandler> handler)

Parameters

Name	Type	Description
`handler`	`std::unique_ptr<EventHandler>`	Event handler to register

Returns

Type	Description
`EventHandler*`	the pointer to the registered handler

`meth`unregister

void unregister(const EventHandler& handler)

Remove a handler from a specific order slot

Parameters

Name	Type	Description
`handler`	`const EventHandler&`	Event handler to remove

`meth`unregister

void unregister(const Plugin& plugin)

Remove a specific plugin's handlers from this handler

Parameters

Name	Type	Description
`plugin`	`const Plugin&`	Plugin to remove

`meth`getHandlersconst

std::vector<EventHandler*> getHandlers() const

Get the baked registered handlers associated with this handler list

Returns

Type	Description
`std::vector<EventHandler*>`	the array of registered handlers

`meth`bakeconstprotected

void bake() const

`class`ICancellable

Defined in <endstone/event/cancellable.h>

Methods

Name	Description
`~ICancellable`
`isCancelled`
`setCancelled`
`cancel`

`meth`~ICancellablevirtual

~ICancellable() =default

`meth`isCancelledabstractconst

bool isCancelled() const =0

`meth`setCancelledabstract

void setCancelled(bool cancel) =0

`meth`cancelabstract

void cancel() =0

`class`LeavesDecayEvent

Defined in <endstone/event/block/leaves_decay_event.h>

Bases: Cancellable<BlockEvent>

Called when leaves are decaying naturally.

Note

If a Leaves Decay event is cancelled, the leaves will not decay.

Methods

Name	Description
`ENDSTONE_EVENT`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(LeavesDecayEvent)

`class`LevelEvent

Defined in <endstone/event/level/level_event.h>

Bases: Event

Represents events within a level.

Methods

Name	Description
`LevelEvent`
`getLevel`

`meth`LevelEventexplicit

LevelEvent(Level& level)

`meth`getLevelconst

Level& getLevel() const

Gets the level primarily involved with this event

Returns

Type	Description
`Level&`	Level which caused this event

`class`MapInitializeEvent

Defined in <endstone/event/server/map_initialize_event.h>

Bases: ServerEvent

Called when a map is initialized.

Methods

Name	Description
`MapInitializeEvent`
`getMap`	Gets the map initialized in this event.

`meth`MapInitializeEventexplicit

MapInitializeEvent(MapView& map)

`meth`getMapconst

MapView& getMap() const

Gets the map initialized in this event.

Returns

Type	Description
`MapView&`	Map for this event

`class`PacketReceiveEvent

Defined in <endstone/event/server/packet_receive_event.h>

Bases: Cancellable<ServerEvent>

Called when the server receives a packet from a connected client.

Methods

Name	Description
`ENDSTONE_EVENT`
`PacketReceiveEvent`
`getPacketId`	Gets the ID of the packet.
`getPayload`	Gets the raw packet data excluding the header.
`setPayload`	Sets the raw packet data excluding the header.
`getPlayer`	Returns the player involved in this event.
`getAddress`	Gets the network address to which this packet is being sent.
`getSubClientId`	Gets the SubClient ID.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PacketReceiveEvent)

`meth`PacketReceiveEvent

PacketReceiveEvent(Player* player, const int packet_id, std::string_view payload, SocketAddress address, const int sub_client_id)

`meth`getPacketIdconst

int getPacketId() const

Gets the ID of the packet.

Returns

Type	Description
`int`	The packet ID.

`meth`getPayloadconst

std::string_view getPayload() const

Gets the raw packet data excluding the header.

Returns

Type	Description
`std::string_view`	The packet payload data.

`meth`setPayload

void setPayload(std::string_view payload)

Sets the raw packet data excluding the header.

Returns

Type	Description
`void`	The packet payload data.

`meth`getPlayerconst

Player* getPlayer() const

Returns the player involved in this event.

Note

This may return nullptr if the packet is sent before the player completes the login process.

Returns

Type	Description
`Player*`	Player who is involved in this event

`meth`getAddressconst

SocketAddress getAddress() const

Gets the network address to which this packet is being sent.

Returns

Type	Description
`SocketAddress`	The SocketAddress of the destination client.

`meth`getSubClientIdconst

int getSubClientId() const

Gets the SubClient ID.

Note

Range is 0 to 3 (0 = primary client; 1-3 = split-screen clients).

Returns

Type	Description
`int`	The SubClient ID.

`class`PacketSendEvent

Defined in <endstone/event/server/packet_send_event.h>

Bases: Cancellable<ServerEvent>

Called when the server sends a packet to a connected client.

Methods

Name	Description
`ENDSTONE_EVENT`
`PacketSendEvent`
`getPacketId`	Gets the ID of the packet.
`getPayload`	Gets the raw packet data excluding the header.
`setPayload`	Sets the raw packet data excluding the header.
`getPlayer`	Returns the player involved in this event.
`getAddress`	Gets the network address to which this packet is being sent.
`getSubClientId`	Gets the SubClient ID.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PacketSendEvent)

`meth`PacketSendEvent

PacketSendEvent(Player* player, const int packet_id, std::string_view payload, SocketAddress address, const int sub_client_id)

`meth`getPacketIdconst

int getPacketId() const

Gets the ID of the packet.

Returns

Type	Description
`int`	The packet ID.

`meth`getPayloadconst

std::string_view getPayload() const

Gets the raw packet data excluding the header.

Returns

Type	Description
`std::string_view`	The packet payload data.

`meth`setPayload

void setPayload(std::string_view payload)

Sets the raw packet data excluding the header.

Returns

Type	Description
`void`	The packet payload data.

`meth`getPlayerconst

Player* getPlayer() const

Returns the player involved in this event.

Note

This may return nullptr if the packet is sent before the player completes the login process.

Returns

Type	Description
`Player*`	Player who is involved in this event

`meth`getAddressconst

SocketAddress getAddress() const

Gets the network address to which this packet is being sent.

Returns

Type	Description
`SocketAddress`	The SocketAddress of the destination client.

`meth`getSubClientIdconst

int getSubClientId() const

Gets the SubClient ID.

Note

Range is 0 to 3 (0 = primary client; 1-3 = split-screen clients).

Returns

Type	Description
`int`	The SubClient ID.

`class`PlayerBedEnterEvent

Defined in <endstone/event/player/player_bed_enter_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player is almost about to enter the bed.

Methods

Name	Description
`PlayerBedEnterEvent`
`getBed`	Represents the default possible outcomes of this event.

`meth`PlayerBedEnterEventexplicit

PlayerBedEnterEvent(Player& player, Block& bed)

`meth`getBedconst

Block& getBed() const

Represents the default possible outcomes of this event.

The player will enter the bed. The dimension doesn't allow sleeping or saving the spawn point (eg,Nether, The End). Entering the bed is prevented due to it not being night nor thundering currently. Entering the bed is prevented due to the player being too far away. Entering the bed is prevented due to there being monsters nearby. Entering the bed is prevented due to there being some other problem.

This describes the default outcome of this event.

This controls the action to take with the bed that was clicked on.

Sets the action to take with the interacted bed.

Result::Allow will result in the player sleeping, regardless of the default outcome described by getBedEnterResult().
Result::Deny will prevent the player from sleeping. This has the same effect as canceling the event
Result::Default will result in the outcome described by getBedEnterResult().

Gets the cancellation state of this event. Set to true if you want to prevent the player from sleeping.

Note

Canceling the event has the same effect as setting useBed() to Result::Deny.

Note

Canceling this event will prevent use of the bed.

Returns the bed block involved in this event.

Parameters

Name	Type	Description
`use_bed`		the action to take with the interacted bed
`cancel`		true if you wish to cancel this event

Returns

Type	Description
`Block&`	The bed enter result representing the default outcome of this eventthe action to take with the interacted bedboolean cancellation state `@brief Sets the cancellation state of this event. A canceled event will not be executed in the server, but` will still pass to other plugins.The bed block involved in this event.

`class`PlayerBedLeaveEvent

Defined in <endstone/event/player/player_bed_leave_event.h>

Bases: PlayerEvent

Called when a player is leaving a bed.

Methods

Name	Description
`PlayerBedLeaveEvent`
`~PlayerBedLeaveEvent`
`getBed`	Returns the bed block involved in this event.

`meth`PlayerBedLeaveEventexplicit

PlayerBedLeaveEvent(Player& player, Block& bed)

`meth`~PlayerBedLeaveEvent

~PlayerBedLeaveEvent() override=default

`meth`getBedconst

Block& getBed() const

Returns the bed block involved in this event.

Returns

Type	Description
`Block&`	The bed block involved in this event.

`class`PlayerChatEvent

Defined in <endstone/event/player/player_chat_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player sends a chat message.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerChatEvent`
`getMessage`	Gets the message that the player is attempting to send.
`setMessage`	Sets the message that the player will send.
`setPlayer`	Sets the player that this message will display as.
`getFormat`	Gets the format to use to display this chat message.
`setFormat`	Sets the format to use to display this chat message.
`getRecipients`	Gets a set of recipients that this chat message will be displayed to.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerChatEvent)

`meth`PlayerChatEventexplicit

PlayerChatEvent(Player& player, std::string message, std::optional<std::vector<Player*>> recipients, std::string format = "<{0}> {1}")

`meth`getMessageconst

std::string getMessage() const

Gets the message that the player is attempting to send.

Returns

Type	Description
`std::string`	Message the player is attempting to send

`meth`setMessage

void setMessage(std::string message)

Sets the message that the player will send.

Parameters

Name	Type	Description
`message`	`std::string`	New message that the player will send

`meth`setPlayer

void setPlayer(Player& player)

Sets the player that this message will display as.

Parameters

Name	Type	Description
`player`	`Player&`	New player which this event will execute as

`meth`getFormatconst

std::string getFormat() const

Gets the format to use to display this chat message.

See the format string syntax

Returns

Type	Description
`std::string`	format string

`meth`setFormat

void setFormat(std::string format)

Sets the format to use to display this chat message.

Parameters

Name	Type	Description
`format`	`std::string`	format string

`meth`getRecipientsconst

std::vector<Player*> getRecipients() const

Gets a set of recipients that this chat message will be displayed to.

Returns

Type	Description
`std::vector<Player*>`	All Players who will see this chat message

`class`PlayerCommandEvent

Defined in <endstone/event/player/player_command_event.h>

Bases: Cancellable<PlayerEvent>

Called whenever a player runs a command.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerCommandEvent`
`~PlayerCommandEvent`
`getCommand`
`setCommand`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerCommandEvent)

`meth`PlayerCommandEventexplicit

PlayerCommandEvent(Player& player, std::string command)

`meth`~PlayerCommandEvent

~PlayerCommandEvent() override=default

`meth`getCommandconst

std::string getCommand() const

Gets the command that the player is attempting to send.

Returns

Type	Description
`std::string`	Command the player is attempting to send

`meth`setCommand

void setCommand(std::string command)

Sets the command that the player will send.

Parameters

Name	Type	Description
`command`	`std::string`	New command that the player will send

`class`PlayerDeathEvent

Defined in <endstone/event/actor/player_death_event.h>

Bases: ActorDeathEvent

Called when a Player dies.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerDeathEvent`
`getPlayer`	Returns the Player involved in this event.
`getDeathMessage`	Get the death message that will appear to everyone on the server.
`setDeathMessage`	Set the death message that will appear to everyone on the server.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerDeathEvent)

`meth`PlayerDeathEventexplicit

PlayerDeathEvent(Player& player, std::unique_ptr<DamageSource> damage_source, std::optional<Message> death_message)

`meth`getPlayerconst

Player& getPlayer() const

Returns the Player involved in this event.

Returns

Type	Description
`Player&`	Player which is involved in this event

`meth`getDeathMessageconst

std::optional<Message> getDeathMessage() const

Get the death message that will appear to everyone on the server.

Returns

Type	Description
`std::optional<Message>`	Message to appear to other players on the server.

`meth`setDeathMessage

void setDeathMessage(std::optional<Message> death_message)

Set the death message that will appear to everyone on the server.

Parameters

Name	Type	Description
`death_message`	`std::optional<Message>`	Message to appear to other players on the server.

`class`PlayerDimensionChangeEvent

Defined in <endstone/event/player/player_dimension_change_event.h>

Bases: PlayerEvent

Called when a player switches to another dimension.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerDimensionChangeEvent`
`getFrom`	Gets the dimension the player is switching from.
`getTo`	Gets the dimension the player is switching to.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerDimensionChangeEvent)

`meth`PlayerDimensionChangeEventexplicit

PlayerDimensionChangeEvent(Player& player, Dimension& from, Dimension& to)

`meth`getFromconst

Dimension& getFrom() const

Gets the dimension the player is switching from.

Returns

Type	Description
`Dimension&`	player's previous dimension

`meth`getToconst

Dimension& getTo() const

Gets the dimension the player is switching to.

Returns

Type	Description
`Dimension&`	player's new dimension

`class`PlayerDropItemEvent

Defined in <endstone/event/player/player_drop_item_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player drops an item from their inventory.

Methods

Name	Description
`PlayerDropItemEvent`
`getItem`	Gets the ItemStack dropped by the player.

`meth`PlayerDropItemEventexplicit

PlayerDropItemEvent(Player& player, ItemStack drop)

`meth`getItemconst

const ItemStack& getItem() const

Gets the ItemStack dropped by the player.

Returns

Type	Description
`const ItemStack&`	ItemDrop dropped by the player

`class`PlayerEmoteEvent

Defined in <endstone/event/player/player_emote_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player uses an emote.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerEmoteEvent`
`~PlayerEmoteEvent`
`getEmoteId`	Gets the emote piece ID.
`isMuted`	Gets the muted state for the emote.
`setMuted`	Sets the muted state for the emote.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerEmoteEvent)

`meth`PlayerEmoteEventexplicit

PlayerEmoteEvent(Player& player, std::string emote_id, bool muted)

`meth`~PlayerEmoteEvent

~PlayerEmoteEvent() override=default

`meth`getEmoteIdconst

std::string getEmoteId() const

Gets the emote piece ID.

Returns

Type	Description
`std::string`	The emote piece ID

`meth`isMutedconst

bool isMuted() const

Gets the muted state for the emote.

This method determines whether the emote is being executed without sending a chat message about the emote.

Returns

Type	Description
`bool`	true if the emote is muted, false otherwise.

`meth`setMuted

void setMuted(bool muted)

Sets the muted state for the emote.

Note

If set to true, the emote will be executed silently, and no chat messages will be sent.

Parameters

Name	Type	Description
`muted`	`bool`	true to mute the emote and disable chat messages, false to unmute it.

`class`PlayerEvent

Defined in <endstone/event/player/player_event.h>

Bases: Event

Represents a player related event.

Variables

Name	Description
`player_`

Methods

Name	Description
`PlayerEvent`
`~PlayerEvent`
`getPlayer`

`var`player_protected

std::reference_wrapper<Player> player_

`meth`PlayerEventexplicit

PlayerEvent(Player& player)

`meth`~PlayerEvent

~PlayerEvent() override=default

`meth`getPlayerconst

Player& getPlayer() const

Returns the player involved in this event

Returns

Type	Description
`Player&`	Player who is involved in this event

`class`PlayerGameModeChangeEvent

Defined in <endstone/event/player/player_game_mode_change_event.h>

Bases: Cancellable<PlayerEvent>

Called when the GameMode of the player is changed.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerGameModeChangeEvent`
`~PlayerGameModeChangeEvent`
`getNewGameMode`	Gets the GameMode the player is switched to.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerGameModeChangeEvent)

`meth`PlayerGameModeChangeEventexplicit

PlayerGameModeChangeEvent(Player& player, GameMode new_game_mode)

`meth`~PlayerGameModeChangeEvent

~PlayerGameModeChangeEvent() override=default

`meth`getNewGameModeconst

GameMode getNewGameMode() const

Gets the GameMode the player is switched to.

Returns

Type	Description
`GameMode`	player's new GameMode

`class`PlayerInteractActorEvent

Defined in <endstone/event/player/player_interact_actor_event.h>

Bases: Cancellable<PlayerEvent>

Represents an event that is called when a player right-clicks an actor.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerInteractActorEvent`
`~PlayerInteractActorEvent`
`getActor`	Gets the actor that was right-clicked by the player.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerInteractActorEvent)

`meth`PlayerInteractActorEventexplicit

PlayerInteractActorEvent(Player& player, Actor& actor)

`meth`~PlayerInteractActorEvent

~PlayerInteractActorEvent() override=default

`meth`getActorconst

Actor& getActor() const

Gets the actor that was right-clicked by the player.

Returns

Type	Description
`Actor&`	actor right-clicked by player

`class`PlayerInteractEvent

Defined in <endstone/event/player/player_interact_event.h>

Bases: Cancellable<PlayerEvent>

Represents an event that is called when a player interacts with an object or air.

Enums

Name	Description
`Action`

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerInteractEvent`
`getAction`	Returns the action type.
`hasItem`	Check if this event involved an item.
`getItem`	Returns the item in hand represented by this event.
`hasBlock`	Check if this event involved a block.
`getBlock`	Returns the clicked block.
`getBlockFace`	Returns the face of the block that was clicked.
`getClickedPosition`	Gets the exact position on the block the player interacted with.

`enum`Action

Action

Values

Name	Value	Description
`LeftClickBlock`		Left-clicking a block
`RightClickBlock`		Right-clicking a block
`LeftClickAir`		Left-clicking the air
`RightClickAir`		Right-clicking the air

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerInteractEvent)

`meth`PlayerInteractEvent

PlayerInteractEvent(Player& player, Action action, std::optional<ItemStack> item, Block* block_clicked, BlockFace block_face, std::optional<Vector> clicked_position)

`meth`getActionconst

Action getAction() const

Returns the action type.

Returns

Type	Description
`Action`	Action returns the type of interaction

`meth`hasItemconst

bool hasItem() const

Check if this event involved an item.

Returns

Type	Description
`bool`	boolean true if it did

`meth`getItemconst

const std::optional<ItemStack>& getItem() const

Returns the item in hand represented by this event.

Returns

Type	Description
`const std::optional<ItemStack>&`	ItemStack the item used, or std::nullopt if no item

`meth`hasBlockconst

bool hasBlock() const

Check if this event involved a block.

Returns

Type	Description
`bool`	boolean true if it did

`meth`getBlockconst

Block* getBlock() const

Returns the clicked block.

Returns

Type	Description
`Block*`	Block returns the block clicked with this item.

`meth`getBlockFaceconst

BlockFace getBlockFace() const

Returns the face of the block that was clicked.

Returns

Type	Description
`BlockFace`	BlockFace returns the face of the block that was clicked

`meth`getClickedPositionconst

std::optional<Vector> getClickedPosition() const

Gets the exact position on the block the player interacted with.

Note

This will be std::nullopt outside of Action.RightClickBlock

Note

All vector components are between 0.0 and 1.0 inclusive.

Returns

Type	Description
`std::optional<Vector>`	the clicked position.

`class`PlayerItemConsumeEvent

Defined in <endstone/event/player/player_item_consume_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player is finishing consuming an item (food, potion, milk bucket).

Note

If the ItemStack is modified the server will use the effects of the new item and not remove the original one from the player's inventory.

Note

If the event is cancelled the effect will not be applied and the item will not be removed from the player's inventory.

Methods

Name	Description
`PlayerItemConsumeEvent`
`getItem`	Gets the item that is being consumed.
`getHand`	Get the hand used to consume the item.

`meth`PlayerItemConsumeEventexplicit

PlayerItemConsumeEvent(Player& player, ItemStack item, EquipmentSlot hand)

`meth`getItemconst

const ItemStack& getItem() const

Gets the item that is being consumed.

Returns

Type	Description
`const ItemStack&`	an ItemStack for the item being consumed

`meth`getHandconst

EquipmentSlot getHand() const

Get the hand used to consume the item.

Returns

Type	Description
`EquipmentSlot`	the hand

`class`PlayerItemHeldEvent

Defined in <endstone/event/player/player_item_held_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player changes their currently held item.

Methods

Name	Description
`PlayerItemHeldEvent`
`getPreviousSlot`	Gets the previous held slot index.
`getNewSlot`	Gets the new held slot index.

`meth`PlayerItemHeldEventexplicit

PlayerItemHeldEvent(Player& player, const int previous, const int current)

`meth`getPreviousSlotconst

int getPreviousSlot() const

Gets the previous held slot index.

Returns

Type	Description
`int`	Previous slot index

`meth`getNewSlotconst

int getNewSlot() const

Gets the new held slot index.

Returns

Type	Description
`int`	New slot index

`class`PlayerJoinEvent

Defined in <endstone/event/player/player_join_event.h>

Bases: PlayerEvent

Called when a player joins a server.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerJoinEvent`
`getJoinMessage`	Gets the join message to send to all online players.
`setJoinMessage`	Sets the join message to send to all online players.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerJoinEvent)

`meth`PlayerJoinEventexplicit

PlayerJoinEvent(Player& player, std::optional<Message> join_message)

`meth`getJoinMessageconst

std::optional<Message> getJoinMessage() const

Gets the join message to send to all online players.

Returns

Type	Description
`std::optional<Message>`	Message to appear to other players on the server.

`meth`setJoinMessage

void setJoinMessage(std::optional<Message> message)

Sets the join message to send to all online players.

Parameters

Name	Type	Description
`message`	`std::optional<Message>`	Message to appear to other players on the server.

`class`PlayerJumpEvent

Defined in <endstone/event/player/player_jump_event.h>

Bases: PlayerMoveEvent

Called when a player jumps.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerMoveEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerJumpEvent)

`meth`PlayerMoveEventexplicit

PlayerMoveEvent(Player& player, Location from, Location to)

`class`PlayerKickEvent

Defined in <endstone/event/player/player_kick_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player gets kicked from the server.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerKickEvent`
`getReason`	Gets the reason why the player is getting kicked.
`setReason`	Sets the reason why the player is getting kicked.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerKickEvent)

`meth`PlayerKickEventexplicit

PlayerKickEvent(Player& player, std::string reason)

`meth`getReasonconst

std::string getReason() const

Gets the reason why the player is getting kicked.

Returns

Type	Description
`std::string`	string kick reason

`meth`setReason

void setReason(std::string reason)

Sets the reason why the player is getting kicked.

Parameters

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

`class`PlayerLoginEvent

Defined in <endstone/event/player/player_login_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player attempts to login in.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerLoginEvent`
`~PlayerLoginEvent`
`getKickMessage`
`setKickMessage`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerLoginEvent)

`meth`PlayerLoginEventexplicit

PlayerLoginEvent(Player& player, std::string message = "")

`meth`~PlayerLoginEvent

~PlayerLoginEvent() override=default

`meth`getKickMessageconst

const std::string& getKickMessage() const

Gets the current kick message that will be used if event is cancelled

Returns

Type	Description
`const std::string&`	Current kick message

`meth`setKickMessage

void setKickMessage(const std::string& message)

Sets the kick message to display if event is cancelled

Parameters

Name	Type	Description
`message`	`const std::string&`	New kick message

`class`PlayerMoveEvent

Defined in <endstone/event/player/player_move_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player moves.

Variables

Name	Description
`from_`
`to_`

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerMoveEvent`
`getFrom`	Gets the location this player moved from.
`setFrom`	Sets the location to mark as where the player moved from.
`getTo`	Gets the location this player moved to.
`setTo`	Sets the location that this player will move to.

`var`from_

Location from_

`var`to_

Location to_

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerMoveEvent)

`meth`PlayerMoveEventexplicit

PlayerMoveEvent(Player& player, Location from, Location to)

`meth`getFromconst

const Location& getFrom() const

Gets the location this player moved from.

Returns

Type	Description
`const Location&`	Location the player moved from

`meth`setFrom

void setFrom(const Location& from)

Sets the location to mark as where the player moved from.

Parameters

Name	Type	Description
`from`	`const Location&`	New location to mark as the players previous location

`meth`getToconst

const Location& getTo() const

Gets the location this player moved to.

Returns

Type	Description
`const Location&`	Location the player moved to

`meth`setTo

void setTo(const Location& to)

Sets the location that this player will move to.

Parameters

Name	Type	Description
`to`	`const Location&`	New Location this player will move to

`class`PlayerPickupItemEvent

Defined in <endstone/event/player/player_pickup_item_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player picks an item up from the ground.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerPickupItemEvent`
`getItem`	Gets the Item picked up by the entity.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerPickupItemEvent)

`meth`PlayerPickupItemEventexplicit

PlayerPickupItemEvent(Player& player, Item& item)

`meth`getItemconst

Item& getItem() const

Gets the Item picked up by the entity.

Returns

Type	Description
`Item&`	Item

`class`PlayerPortalEvent

Defined in <endstone/event/player/player_portal_event.h>

Bases: PlayerTeleportEvent

Called when a player is about to teleport because it is in contact with a portal.

Methods

Name	Description
`ENDSTONE_EVENT`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerPortalEvent)

`class`PlayerQuitEvent

Defined in <endstone/event/player/player_quit_event.h>

Bases: PlayerEvent

Called when a player leaves a server.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerQuitEvent`
`getQuitMessage`	Gets the quit message to send to all online players.
`setQuitMessage`	Sets the quit message to send to all online players.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerQuitEvent)

`meth`PlayerQuitEventexplicit

PlayerQuitEvent(Player& player, std::optional<Message> quit_message)

`meth`getQuitMessageconst

std::optional<Message> getQuitMessage() const

Gets the quit message to send to all online players.

Returns

Type	Description
`std::optional<Message>`	Message to appear to other players on the server.

`meth`setQuitMessage

void setQuitMessage(std::optional<Message> message)

Sets the quit message to send to all online players.

Parameters

Name	Type	Description
`message`	`std::optional<Message>`	Message to appear to other players on the server.

`class`PlayerRespawnEvent

Defined in <endstone/event/player/player_respawn_event.h>

Bases: PlayerEvent

Called when a player respawns.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerRespawnEvent`
`~PlayerRespawnEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerRespawnEvent)

`meth`PlayerRespawnEventexplicit

PlayerRespawnEvent(Player& player)

`meth`~PlayerRespawnEvent

~PlayerRespawnEvent() override=default

`class`PlayerSkinChangeEvent

Defined in <endstone/event/player/player_skin_change_event.h>

Bases: Cancellable<PlayerEvent>

Called when a player changes their skin.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerSkinChangeEvent`
`getNewSkin`	Gets the player's new skin.
`getSkinChangeMessage`	Gets the message to send to all online players for this skin change.
`setSkinChangeMessage`	Sets the message to send to all online players for this skin change.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerSkinChangeEvent)

`meth`PlayerSkinChangeEventexplicit

PlayerSkinChangeEvent(Player& player, Skin new_skin, std::optional<Message> message)

`meth`getNewSkinconst

Skin getNewSkin() const

Gets the player's new skin.

Returns

Type	Description
`Skin`	The skin that will be applied.

`meth`getSkinChangeMessageconst

std::optional<Message> getSkinChangeMessage() const

Gets the message to send to all online players for this skin change.

Returns

Type	Description
`std::optional<Message>`	Message to appear to other players on the server.

`meth`setSkinChangeMessage

void setSkinChangeMessage(std::optional<Message> message)

Sets the message to send to all online players for this skin change.

Parameters

Name	Type	Description
`message`	`std::optional<Message>`	Message to appear to other players on the server.

`class`PlayerTeleportEvent

Defined in <endstone/event/player/player_teleport_event.h>

Bases: PlayerMoveEvent

Called when a player is teleported from one location to another.

Methods

Name	Description
`ENDSTONE_EVENT`
`PlayerMoveEvent`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PlayerTeleportEvent)

`meth`PlayerMoveEventexplicit

PlayerMoveEvent(Player& player, Location from, Location to)

`class`PluginDisableEvent

Defined in <endstone/event/server/plugin_disable_event.h>

Bases: ServerEvent

Called when a plugin is disabled.

Methods

Name	Description
`ENDSTONE_EVENT`
`PluginDisableEvent`
`getPlugin`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PluginDisableEvent)

`meth`PluginDisableEventexplicit

PluginDisableEvent(Plugin& plugin)

`meth`getPluginconst

Plugin& getPlugin() const

Gets the plugin involved in this event

Returns

Type	Description
`Plugin&`	Plugin for this event

`class`PluginEnableEvent

Defined in <endstone/event/server/plugin_enable_event.h>

Bases: ServerEvent

Called when a plugin is enabled.

Methods

Name	Description
`ENDSTONE_EVENT`
`PluginEnableEvent`
`getPlugin`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(PluginEnableEvent)

`meth`PluginEnableEventexplicit

PluginEnableEvent(Plugin& plugin)

`meth`getPluginconst

Plugin& getPlugin() const

Gets the plugin involved in this event

Returns

Type	Description
`Plugin&`	Plugin for this event

`class`ScriptMessageEvent

Defined in <endstone/event/server/script_message_event.h>

Bases: Cancellable<ServerEvent>

Called when a message is sent by /scriptevent command.

Methods

Name	Description
`ENDSTONE_EVENT`
`ScriptMessageEvent`
`getMessageId`
`getMessage`
`getSender`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ScriptMessageEvent)

`meth`ScriptMessageEvent

ScriptMessageEvent(std::string message_id, std::string message, const CommandSender& sender)

`meth`getMessageIdconst

const std::string& getMessageId() const

Get the message id to send.

Returns

Type	Description
`const std::string&`	Message id to send

`meth`getMessageconst

const std::string& getMessage() const

Get the message to send.

Returns

Type	Description
`const std::string&`	Message to send

`meth`getSenderconst

const CommandSender& getSender() const

Gets the command sender who initiated the command

Returns

Type	Description
`const CommandSender&`	Command sender who initiated the command

`class`ServerCommandEvent

Defined in <endstone/event/server/server_command_event.h>

Bases: Cancellable<ServerEvent>

Called when the console runs a command, early in the process.

You should not use this except for a few cases like logging commands, blocking commands on certain places, or applying modifiers.

The command message contains a slash '/' at the start

Methods

Name	Description
`ENDSTONE_EVENT`
`ServerCommandEvent`
`getCommand`
`setCommand`
`getSender`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ServerCommandEvent)

`meth`ServerCommandEvent

ServerCommandEvent(CommandSender& sender, std::string command)

`meth`getCommandconst

std::string getCommand() const

Gets the command that the server is attempting to execute from the console

Returns

Type	Description
`std::string`	Command the server is attempting to execute

`meth`setCommand

void setCommand(std::string message)

Sets the command that the server will execute

Parameters

Name	Type	Description
`message`	`std::string`	New message that the server will execute

`meth`getSenderconst

CommandSender& getSender() const

Get the command sender.

Returns

Type	Description
`CommandSender&`	The sender

`class`ServerEvent

Defined in <endstone/event/server/server_event.h>

Bases: Event

Represents a Server-related event.

Methods

Name	Description
`Event`
`Event`
`Event`

`meth`Eventexplicit

Event(bool async = false)

`meth`Event

Event(const Event&) =delete

`meth`Event

Event(Event&&) =default

`class`ServerListPingEvent

Defined in <endstone/event/server/server_list_ping_event.h>

Bases: Cancellable<ServerEvent>

Called when a server ping is coming in.

Methods

Name	Description
`ENDSTONE_EVENT`
`ServerListPingEvent`
`getAddress`	Get the address the ping is coming from.
`getServerGuid`	Get the unique identifier of the server.
`setServerGuid`	Set the unique identifier of the server.
`getLocalPort`	Get the local port of the server.
`setLocalPort`	Set the local port of the server.
`getLocalPortV6`	Get the local port of the server for IPv6 support.
`setLocalPortV6`	Set the local port of the server for IPv6 support.
`getMotd`	Get the message of the day message.
`setMotd`	Change the message of the day message.
`getNetworkProtocolVersion`	Get the network protocol version of this server.
`getMinecraftVersionNetwork`	Get the network version of Minecraft that is supported by this server.
`setMinecraftVersionNetwork`	Set the network version of Minecraft that is supported by this server.
`getNumPlayers`	Get the number of players online.
`setNumPlayers`	Set the number of players online.
`getMaxPlayers`	Get the maximum number of players allowed.
`setMaxPlayers`	Set the maximum number of players allowed.
`getLevelName`	Get the level name.
`setLevelName`	Set the level name.
`getGameMode`	Get the current game mode.
`setGameMode`	Set the current game mode.

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ServerListPingEvent)

`meth`ServerListPingEvent

ServerListPingEvent(SocketAddress address, std::string motd, int network_protocol_version, std::string minecraft_version_network, int num_players, int max_players, std::string server_guid, std::string level_name, GameMode game_mode, int local_port, int local_port_v6)

`meth`getAddressconst

SocketAddress getAddress() const

Get the address the ping is coming from.

Returns

Type	Description
`SocketAddress`	the address

`meth`getServerGuidconst

std::string getServerGuid() const

Get the unique identifier of the server.

Returns

Type	Description
`std::string`	The server guid

`meth`setServerGuid

void setServerGuid(std::string guid)

Set the unique identifier of the server.

Parameters

Name	Type	Description
`guid`	`std::string`	the server guid

`meth`getLocalPortconst

int getLocalPort() const

Get the local port of the server.

Returns

Type	Description
`int`	The local port

`meth`setLocalPort

void setLocalPort(int port)

Set the local port of the server.

Parameters

Name	Type	Description
`port`	`int`	the local port

`meth`getLocalPortV6const

int getLocalPortV6() const

Get the local port of the server for IPv6 support.

Returns

Type	Description
`int`	The local port for IPv6

`meth`setLocalPortV6

void setLocalPortV6(int port)

Set the local port of the server for IPv6 support.

Parameters

Name	Type	Description
`port`	`int`	the local port for IPv6

`meth`getMotdconst

std::string getMotd() const

Get the message of the day message.

Returns

Type	Description
`std::string`	the message of the day

`meth`setMotd

void setMotd(std::string motd)

Change the message of the day message.

Parameters

Name	Type	Description
`motd`	`std::string`	the message of the day

`meth`getNetworkProtocolVersionconst

int getNetworkProtocolVersion() const

Get the network protocol version of this server.

Returns

Type	Description
`int`	the network protocol version

`meth`getMinecraftVersionNetworkconst

std::string getMinecraftVersionNetwork() const

Get the network version of Minecraft that is supported by this server.

Returns

Type	Description
`std::string`	the network version of Minecraft

`meth`setMinecraftVersionNetwork

void setMinecraftVersionNetwork(std::string minecraft_version_network)

Set the network version of Minecraft that is supported by this server.

Parameters

Name	Type	Description
`minecraft_version_network`	`std::string`	the network version of Minecraft

`meth`getNumPlayersconst

int getNumPlayers() const

Get the number of players online.

Returns

Type	Description
`int`	the number of players

`meth`setNumPlayers

void setNumPlayers(int num_players)

Set the number of players online.

Parameters

Name	Type	Description
`num_players`	`int`	the number of players

`meth`getMaxPlayersconst

int getMaxPlayers() const

Get the maximum number of players allowed.

Returns

Type	Description
`int`	the maximum number of players

`meth`setMaxPlayers

void setMaxPlayers(int max_players)

Set the maximum number of players allowed.

Parameters

Name	Type	Description
`max_players`	`int`	the maximum number of players

`meth`getLevelNameconst

std::string getLevelName() const

Get the level name.

Returns

Type	Description
`std::string`	the level name

`meth`setLevelName

void setLevelName(std::string level_name)

Set the level name.

Parameters

Name	Type	Description
`level_name`	`std::string`	the level name

`meth`getGameModeconst

GameMode getGameMode() const

Get the current game mode.

Returns

Type	Description
`GameMode`	the game mode

`meth`setGameMode

void setGameMode(GameMode game_mode)

Set the current game mode.

Parameters

Name	Type	Description
`game_mode`	`GameMode`	the game mode

`class`ServerLoadEvent

Defined in <endstone/event/server/server_load_event.h>

Bases: ServerEvent

Called when either the server startup or reload has completed.

Enums

Name	Description
`LoadType`

Methods

Name	Description
`ENDSTONE_EVENT`
`ServerLoadEvent`
`getType`

`enum`LoadType

LoadType

Values

Name	Value	Description
`Startup`
`Reload`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ServerLoadEvent)

`meth`ServerLoadEventexplicit

ServerLoadEvent(LoadType type)

`meth`getTypeconst

LoadType getType() const

`class`ThunderChangeEvent

Defined in <endstone/event/weather/thunder_change_event.h>

Bases: Cancellable<WeatherEvent>

Called when the thunder state in a world is changing.

Methods

Name	Description
`ENDSTONE_EVENT`
`ThunderChangeEvent`
`~ThunderChangeEvent`
`toThunderState`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(ThunderChangeEvent)

`meth`ThunderChangeEvent

ThunderChangeEvent(Level& level, bool to)

`meth`~ThunderChangeEvent

~ThunderChangeEvent() override=default

`meth`toThunderStateconst

bool toThunderState() const

Gets the state of thunder that the world is being set to

Returns

Type	Description
`bool`	true if the weather is being set to thundering, false otherwise

`class`WeatherChangeEvent

Defined in <endstone/event/weather/weather_change_event.h>

Bases: Cancellable<WeatherEvent>

Called when the weather (rain) state in a world is changing.

Methods

Name	Description
`ENDSTONE_EVENT`
`WeatherChangeEvent`
`~WeatherChangeEvent`
`toWeatherState`

`meth`ENDSTONE_EVENT

ENDSTONE_EVENT(WeatherChangeEvent)

`meth`WeatherChangeEvent

WeatherChangeEvent(Level& level, const bool to)

`meth`~WeatherChangeEvent

~WeatherChangeEvent() override=default

`meth`toWeatherStateconst

bool toWeatherState() const

Gets the state of weather that the world is being set to

Returns

Type	Description
`bool`	true if the weather is being set to raining, false otherwise

`class`WeatherEvent

Defined in <endstone/event/weather/weather_event.h>

Bases: Event

Represents a Weather-related event.

Methods

Name	Description
`WeatherEvent`
`~WeatherEvent`
`getLevel`

`meth`WeatherEventexplicit

WeatherEvent(Level& level)

`meth`~WeatherEvent

~WeatherEvent() override=default

`meth`getLevelconst

Level& getLevel() const

Returns the Level where this event is occurring

Returns

Type	Description
`Level&`	Level this event is occurring in

`enum`EventPriority

EventPriority

Represents an event's priority in execution.

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

Values

Name	Value	Description
`Lowest`	`0`	Event call is of very low importance and should be run first, to allow other plugins to further customise the outcome
`Low`	`1`	Event call is of low importance
`Normal`	`2`	Event call is neither important nor unimportant, and may be run normally
`High`	`3`	Event call is of high importance
`Highest`	`4`	Event call is critical and must have the final say in what happens to the event
`Monitor`	`5`	Event is listened to purely for monitoring the outcome of an event. No modifications to the event should be made under this priority

`enum`EventResult

EventResult

Values

Name	Value	Description
`Deny`		Deny the event.
`Default`		Neither deny nor allow the event. The server will proceed with its normal handling.
`Allow`		Allow / Force the event.

classActorDamageEvent

methENDSTONE_EVENT

methActorDamageEvent

methgetDamageconst

methsetDamage

methgetDamageSourceconst

classActorDeathEvent

methENDSTONE_EVENT

methActorDeathEvent

methgetDamageSourceconst

classActorEvent

methActorEventexplicit

meth~ActorEvent

methgetActorconst

classActorExplodeEvent

methENDSTONE_EVENT

methActorExplodeEventexplicit

meth~ActorExplodeEvent

methgetLocationconst

methgetBlockListconst

methgetBlockList

classActorKnockbackEvent

methENDSTONE_EVENT

methActorKnockbackEventexplicit

methgetSourceconst

methgetKnockbackconst

methsetKnockback

classActorRemoveEvent

methENDSTONE_EVENT

methActorEventexplicit

classActorSpawnEvent

methENDSTONE_EVENT

methActorSpawnEventexplicit

meth~ActorSpawnEvent

classActorTeleportEvent

methENDSTONE_EVENT

methActorTeleportEventexplicit

meth~ActorTeleportEvent

methgetFromconst

methsetFrom

methgetToconst

methsetTo

classBlockBreakEvent

methENDSTONE_EVENT

methBlockBreakEventexplicit

meth~BlockBreakEvent

methgetPlayerconst

classBlockCookEvent

methENDSTONE_EVENT

methBlockCookEvent

methgetSourceconst

methgetResultconst

methsetResult

classBlockEvent

varblock_protected

methBlockEventexplicit

methgetBlockconst

classBlockExplodeEvent

methENDSTONE_EVENT

methBlockExplodeEventexplicit

meth~BlockExplodeEvent

methgetBlockListconst

methgetBlockList

classBlockFormEvent

methENDSTONE_EVENT

methBlockGrowEventexplicit

classBlockFromToEvent

varto_protected

methENDSTONE_EVENT

methBlockFromToEventexplicit

methgetToBlockconst

classBlockGrowEvent

methENDSTONE_EVENT

methBlockGrowEventexplicit

methgetNewStateconst

classBlockPistonEvent

methBlockPistonEventexplicit

methgetDirectionconst

classBlockPistonExtendEvent

`class`ActorDamageEvent

`meth`ENDSTONE_EVENT

`meth`ActorDamageEvent

`meth`getDamageconst

`meth`setDamage

`meth`getDamageSourceconst

`class`ActorDeathEvent

`meth`ENDSTONE_EVENT

`meth`ActorDeathEvent

`meth`getDamageSourceconst

`class`ActorEvent

`meth`ActorEventexplicit

`meth`~ActorEvent

`meth`getActorconst

`class`ActorExplodeEvent

`meth`ENDSTONE_EVENT

`meth`ActorExplodeEventexplicit

`meth`~ActorExplodeEvent

`meth`getLocationconst

`meth`getBlockListconst

`meth`getBlockList

`class`ActorKnockbackEvent

`meth`ENDSTONE_EVENT

`meth`ActorKnockbackEventexplicit

`meth`getSourceconst

`meth`getKnockbackconst

`meth`setKnockback

`class`ActorRemoveEvent

`meth`ENDSTONE_EVENT

`meth`ActorEventexplicit

`class`ActorSpawnEvent

`meth`ENDSTONE_EVENT

`meth`ActorSpawnEventexplicit

`meth`~ActorSpawnEvent

`class`ActorTeleportEvent

`meth`ENDSTONE_EVENT

`meth`ActorTeleportEventexplicit

`meth`~ActorTeleportEvent

`meth`getFromconst

`meth`setFrom

`meth`getToconst

`meth`setTo

`class`BlockBreakEvent

`meth`ENDSTONE_EVENT

`meth`BlockBreakEventexplicit

`meth`~BlockBreakEvent

`meth`getPlayerconst

`class`BlockCookEvent

`meth`ENDSTONE_EVENT

`meth`BlockCookEvent

`meth`getSourceconst

`meth`getResultconst

`meth`setResult

`class`BlockEvent

`var`block_protected

`meth`BlockEventexplicit

`meth`getBlockconst

`class`BlockExplodeEvent

`meth`ENDSTONE_EVENT

`meth`BlockExplodeEventexplicit

`meth`~BlockExplodeEvent

`meth`getBlockListconst

`meth`getBlockList

`class`BlockFormEvent

`meth`ENDSTONE_EVENT

`meth`BlockGrowEventexplicit

`class`BlockFromToEvent

`var`to_protected

`meth`ENDSTONE_EVENT

`meth`BlockFromToEventexplicit

`meth`getToBlockconst

`class`BlockGrowEvent

`meth`ENDSTONE_EVENT

`meth`BlockGrowEventexplicit

`meth`getNewStateconst

`class`BlockPistonEvent

`meth`BlockPistonEventexplicit

`meth`getDirectionconst

`class`BlockPistonExtendEvent

`meth`ENDSTONE_EVENT