endstone.event

Classes relating to handling triggered code executions.

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.
`BlockFormEvent`	Called when a block is formed or spreads based on world conditions. If a Block Form event is cancelled, the block will not be formed.
`BlockFromToEvent`	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).
`BlockGrowEvent`	Called when a block grows naturally in the world. If a Block Grow event is cancelled, the block will not grow.
`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`	Represents an event 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 dimension
`Event`	Represents an event.
`EventPriority`	Listeners are called in following order: LOWEST -> LOW -> NORMAL -> HIGH -> HIGHEST -> MONITOR
`EventResult`
`LeavesDecayEvent`	Called when leaves are decaying naturally. If a Leaves Decay event is cancelled, the leaves will not decay.
`LevelEvent`	Represents events within a level
`MapInitializeEvent`	Called when a map is initialized.
`MobEvent`	Represents an Mob-related event.
`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 and 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

Functions

Name	Description
`event_handler`

Name	Type	Description
`damage`	`float`	Gets or sets the amount of damage caused by the event
`damage_source`	`DamageSource`	Gets the source of damage.

`class`ActorDeathEvent

Bases: MobEvent

ActorDeathEvent()

Called when an Actor dies.

Attributes

Name	Type	Description
`damage_source`	`DamageSource`	Gets the source of damage which caused the death.

`attr`damage_sourceproperty

damage_source: DamageSource

Gets the source of damage which caused the death.

Name	Type	Description
`actor`	`Actor`	Returns the Actor involved in this event

`class`ActorExplodeEvent

Bases: ActorEvent, Cancellable

ActorExplodeEvent()

Called when an Actor explodes.

Attributes

Name	Type	Description
`block_list`	`list[Block]`	Gets or sets the list of blocks that would have been removed or were removed from the explosion event.
`location`	`Location`	Returns the location where the explosion happened.

`attr`block_listproperty

block_list: list[Block]

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

`attr`locationproperty

location: Location

Returns the location where the explosion happened.

`class`ActorKnockbackEvent

Bases: MobEvent, Cancellable

ActorKnockbackEvent()

Called when a living entity receives knockback.

Attributes

Name	Type	Description
`knockback`	`Vector`	Gets or sets the knockback that will be applied to the entity.
`source`	`Actor`	Get the source actor that has caused knockback to the defender, if exists.

`attr`knockbackproperty

knockback: Vector

Gets or sets the knockback that will be applied to the entity.

`attr`sourceproperty

source: Actor

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

`class`ActorSpawnEvent

Bases: ActorEvent, Cancellable

ActorSpawnEvent()

Called when an Actor is spawned into a world.

`class`ActorTeleportEvent

Bases: ActorEvent, Cancellable

ActorTeleportEvent()

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

Attributes

Name	Type	Description
`from_location`	`Location`	Gets or sets the location that this actor moved from.
`to_location`	`Location`	Gets or sets the location that this actor moved to.

`attr`from_locationproperty

from_location: Location

Gets or sets the location that this actor moved from.

`attr`to_locationproperty

to_location: Location

Gets or sets the location that this actor moved to.

`class`BlockBreakEvent

Bases: BlockEvent, Cancellable

BlockBreakEvent()

Called when a block is broken by a player.

Attributes

Name	Type	Description
`player`	`Player`	Gets the Player that is breaking the block involved in this event.

`attr`playerproperty

player: Player

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

`class`BlockCookEvent

Bases: BlockEvent, Cancellable

BlockCookEvent()

Called when an ItemStack is successfully cooked in a block.

Attributes

Name	Type	Description
`result`	`ItemStack`	Gets or sets the resultant ItemStack for this event
`source`	`ItemStack`	Gets the smelted ItemStack for this event

`attr`resultproperty

result: ItemStack

Gets or sets the resultant ItemStack for this event

`attr`sourceproperty

source: ItemStack

Gets the smelted ItemStack for this event

Name	Type	Description
`block`	`Block`	Gets the block involved in this event.

`class`BlockExplodeEvent

Bases: BlockEvent, Cancellable

BlockExplodeEvent()

Called when a block explodes.

Attributes

Name	Type	Description
`block_list`	`list[Block]`	Gets or sets the list of blocks that would have been removed or were removed from the explosion event.

`attr`block_listproperty

block_list: list[Block]

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

`class`BlockFormEvent

Bases: BlockGrowEvent

BlockFormEvent()

Called when a block is formed or spreads based on world conditions. If a Block Form event is cancelled, the block will not be formed.

`class`BlockFromToEvent

Bases: BlockEvent, Cancellable

BlockFromToEvent()

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).

Attributes

Name	Type	Description
`to_block`	`Block`	Gets the faced Block.

`attr`to_blockproperty

to_block: Block

Gets the faced Block.

`class`BlockGrowEvent

Bases: BlockEvent, Cancellable

BlockGrowEvent()

Called when a block grows naturally in the world. If a Block Grow event is cancelled, the block will not grow.

Attributes

Name	Type	Description
`new_state`	`BlockState`	Gets the state of the block where it will form or spread to.

`attr`new_stateproperty

new_state: BlockState

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

`class`BlockPistonEvent

Bases: BlockEvent, Cancellable

BlockPistonEvent()

Called when a piston block is triggered

Attributes

Name	Type	Description
`direction`	`BlockFace`	Return the direction in which the piston will operate.

`attr`directionproperty

direction: BlockFace

Return the direction in which the piston will operate.

`class`BlockPistonExtendEvent

Bases: BlockPistonEvent

BlockPistonExtendEvent()

Called when a piston extends.

`class`BlockPistonRetractEvent

Bases: BlockPistonEvent

BlockPistonRetractEvent()

Called when a piston retracts.

`class`BlockPlaceEvent

Bases: BlockEvent, Cancellable

BlockPlaceEvent()

Called when a block is placed by a player.

Attributes

Name	Type	Description
`block_against`	`Block`	Gets the block that this block was placed against
`block_placed_state`	`BlockState`	Gets the BlockState for the block which was placed.
`block_replaced`	`Block`	Gets the block which was replaced.
`player`	`Player`	Gets the player who placed the block involved in this event.

`attr`block_againstproperty

block_against: Block

Gets the block that this block was placed against

`attr`block_placed_stateproperty

block_placed_state: BlockState

Gets the BlockState for the block which was placed.

`attr`block_replacedproperty

block_replaced: Block

Gets the block which was replaced.

`attr`playerproperty

player: Player

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

`class`BroadcastMessageEvent

Bases: ServerEvent, Cancellable

BroadcastMessageEvent()

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

Attributes

Name	Type	Description
`message`	`str \| Translatable`	Gets or sets the message to broadcast.
`recipients`	`set[CommandSender]`	Gets a set of recipients that this broadcast message will be displayed to.

`attr`messageproperty

message: str | Translatable

Gets or sets the message to broadcast.

`attr`recipientsproperty

recipients: set[CommandSender]

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

`class`Cancellable

Cancellable()

Represents an event that may be cancelled by a plugin or the server.

Methods

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

Attributes

Name	Type	Description
`cancelled`	`bool`	Gets or sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins. [Warning] Deprecated: Use is_cancelled instead.
`is_cancelled`	`bool`	Gets or sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

`attr`cancelledproperty

cancelled: bool

Gets or sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins. [Warning] Deprecated: Use is_cancelled instead.

`attr`is_cancelledproperty

is_cancelled: bool

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

`meth`cancel

cancel() -> None

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

`class`ChunkEvent

Bases: DimensionEvent

ChunkEvent()

Represents a Chunk related event

Attributes

Name	Type	Description
`chunk`	`Chunk`	Gets the chunk being loaded/unloaded

`attr`chunkproperty

chunk: Chunk

Gets the chunk being loaded/unloaded

`class`ChunkLoadEvent

Bases: ChunkEvent

ChunkLoadEvent()

Called when a chunk is loaded

`class`ChunkUnloadEvent

Bases: ChunkEvent

ChunkUnloadEvent()

Called when a chunk is unloaded

`class`DimensionEvent

Bases: LevelEvent

DimensionEvent()

Represents events within a dimension

Attributes

Name	Type	Description
`dimension`	`Dimension`	Gets the dimension primarily involved with this event

`attr`dimensionproperty

dimension: Dimension

Gets the dimension primarily involved with this event

`class`Event

Event()

Represents an event.

Attributes

Name	Type	Description
`event_name`	`str`	Gets a user-friendly identifier for this event.
`is_asynchronous`	`bool`	Whether the event fires asynchronously.

`attr`event_nameproperty

event_name: str

Gets a user-friendly identifier for this event.

`attr`is_asynchronousproperty

is_asynchronous: bool

Whether the event fires asynchronously.

`class`EventPriority

Bases: IntEnum

EventPriority()

Listeners are called in following order: LOWEST -> LOW -> NORMAL -> HIGH -> HIGHEST -> MONITOR

Attributes

Name	Type	Description
`HIGH`		Event call is of high importance
`HIGHEST`		Event call is critical and must have the final say in what happens to the event
`LOW`		Event call is of low importance
`LOWEST`		Event call is of very low importance and should be run first, to allow other plugins to further customise the outcome
`MONITOR`		Event is listened to purely for monitoring the outcome of an event. No modifications to the event should be made under this priority.
`NORMAL`		Event call is neither important nor unimportant, and may be run normally

`attr`HIGH

HIGH = 3

Event call is of high importance

`attr`HIGHEST

HIGHEST = 4

Event call is critical and must have the final say in what happens to the event

`attr`LOW

LOW = 1

Event call is of low importance

`attr`LOWEST

LOWEST = 0

Event call is of very low importance and should be run first, to allow other plugins to further customise the outcome

`attr`MONITOR

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.

`attr`NORMAL

NORMAL = 2

Event call is neither important nor unimportant, and may be run normally

`class`EventResult

Bases: Enum

EventResult()

Attributes

Name	Type	Description
`ALLOW`
`DEFAULT`
`DENY`

`attr`ALLOW

ALLOW = 2

`attr`DEFAULT

DEFAULT = 1

`attr`DENY

DENY = 0

`class`LeavesDecayEvent

Bases: BlockEvent, Cancellable

LeavesDecayEvent()

Called when leaves are decaying naturally. If a Leaves Decay event is cancelled, the leaves will not decay.

`class`LevelEvent

Bases: Event

LevelEvent()

Represents events within a level

Attributes

Name	Type	Description
`level`	`Level`	Gets the level primarily involved with this event

`attr`levelproperty

level: Level

Gets the level primarily involved with this event

`class`MapInitializeEvent

Bases: ServerEvent

MapInitializeEvent()

Called when a map is initialized.

Attributes

Name	Type	Description
`map`	`MapView`	Gets the map initialized in this event.

`attr`mapproperty

map: MapView

Gets the map initialized in this event.

`class`MobEvent

Bases: Event

MobEvent()

Represents an Mob-related event.

Attributes

Name	Type	Description
`actor`	`Mob`	Returns the Mob involved in this event

`attr`actorproperty

actor: Mob

Returns the Mob involved in this event

`class`PacketReceiveEvent

Bases: ServerEvent, Cancellable

PacketReceiveEvent()

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

Attributes

Name	Type	Description
`address`	`SocketAddress`	Gets the network address to which this packet is being sent.
`packet_id`	`int`	Gets the ID of the packet.
`payload`	`bytes`	Gets or sets the raw packet data excluding the header.
`player`	`Player`	Gets the player involved in this event NOTE: This may return None if the packet is sent before the player completes the login process.
`sub_client_id`	`int`	Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).

`attr`addressproperty

address: SocketAddress

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

`attr`packet_idproperty

packet_id: int

Gets the ID of the packet.

`attr`payloadproperty

payload: bytes

Gets or sets the raw packet data excluding the header.

`attr`playerproperty

player: Player

Gets the player involved in this event NOTE: This may return None if the packet is sent before the player completes the login process.

`attr`sub_client_idproperty

sub_client_id: int

Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).

`class`PacketSendEvent

Bases: ServerEvent, Cancellable

PacketSendEvent()

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

Attributes

Name	Type	Description
`address`	`SocketAddress`	Gets the network address to which this packet is being sent.
`packet_id`	`int`	Gets the ID of the packet.
`payload`	`bytes`	Gets or sets the raw packet data excluding the header.
`player`	`Player`	Gets the player involved in this event NOTE: This may return None if the packet is sent before the player completes the login process.
`sub_client_id`	`int`	Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).

`attr`addressproperty

address: SocketAddress

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

`attr`packet_idproperty

packet_id: int

Gets the ID of the packet.

`attr`payloadproperty

payload: bytes

Gets or sets the raw packet data excluding the header.

`attr`playerproperty

player: Player

Gets the player involved in this event NOTE: This may return None if the packet is sent before the player completes the login process.

`attr`sub_client_idproperty

sub_client_id: int

Gets the SubClient ID (0 = primary client; 1-3 = split-screen clients).

`class`PlayerBedEnterEvent

Bases: PlayerEvent, Cancellable

PlayerBedEnterEvent()

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

Attributes

Name	Type	Description
`bed`	`Block`	Returns the bed block involved in this event.

`attr`bedproperty

bed: Block

Returns the bed block involved in this event.

`class`PlayerBedLeaveEvent

Bases: PlayerEvent

PlayerBedLeaveEvent()

Called when a player is leaving a bed.

Attributes

Name	Type	Description
`bed`	`Block`	Returns the bed block involved in this event.

`attr`bedproperty

bed: Block

Returns the bed block involved in this event.

`class`PlayerChatEvent

Bases: PlayerEvent, Cancellable

PlayerChatEvent()

Called when a player sends a chat message.

Attributes

Name	Type	Description
`format`	`str`	Sets the format to use to display this chat message
`message`	`str`	Gets or sets the message that the player will send.
`player`	`Player`	Gets or sets the player that this message will display as
`recipients`	`list[Player]`	Gets a set of recipients that this chat message will be displayed to

`attr`formatproperty

format: str

Sets the format to use to display this chat message

`attr`messageproperty

message: str

Gets or sets the message that the player will send.

`attr`playerproperty

player: Player

Gets or sets the player that this message will display as

`attr`recipientsproperty

recipients: list[Player]

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

`class`PlayerCommandEvent

Bases: PlayerEvent, Cancellable

PlayerCommandEvent()

Called whenever a player runs a command.

Attributes

Name	Type	Description
`command`	`str`	Gets or sets the command that the player will send.

`attr`commandproperty

command: str

Gets or sets the command that the player will send.

`class`PlayerDeathEvent

Bases: ActorDeathEvent

PlayerDeathEvent()

Called when a player dies

Attributes

Name	Type	Description
`death_message`	`str \| Translatable \| None`	Gets or sets the death message that will appear to everyone on the server.
`player`	`Player`	Gets the Player that is breaking the block involved in this event.

`attr`death_messageproperty

death_message: str | Translatable | None

Gets or sets the death message that will appear to everyone on the server.

`attr`playerproperty

player: Player

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

`class`PlayerDimensionChangeEvent

Bases: PlayerEvent

PlayerDimensionChangeEvent()

Called when a player switches to another dimension.

Attributes

Name	Type	Description
`from_dimension`	`Dimension`	Gets the dimension the player is switching from.
`to_dimension`	`Dimension`	Gets the dimension the player is switching to.

`attr`from_dimensionproperty

from_dimension: Dimension

Gets the dimension the player is switching from.

`attr`to_dimensionproperty

to_dimension: Dimension

Gets the dimension the player is switching to.

`class`PlayerDropItemEvent

Bases: PlayerEvent, Cancellable

PlayerDropItemEvent()

Called when a player drops an item from their inventory

Attributes

Name	Type	Description
`item`	`ItemStack`	Gets the ItemStack dropped by the player

`attr`itemproperty

item: ItemStack

Gets the ItemStack dropped by the player

`class`PlayerEmoteEvent

Bases: PlayerEvent, Cancellable

PlayerEmoteEvent()

Called when a player uses and emote

Attributes

Name	Type	Description
`emote_id`	`str`	Gets the emote piece ID
`is_muted`	`bool`	Gets or sets the muted state for the emote.

`attr`emote_idproperty

emote_id: str

Gets the emote piece ID

`attr`is_mutedproperty

is_muted: bool

Gets or sets the muted state for the emote.

`class`PlayerEvent

Bases: Event

PlayerEvent()

Represents a player related event

Attributes

Name	Type	Description
`player`	`Player`	Returns the player involved in this event.

`attr`playerproperty

player: Player

Returns the player involved in this event.

`class`PlayerGameModeChangeEvent

Bases: PlayerEvent, Cancellable

PlayerGameModeChangeEvent()

Called when the GameMode of the player is changed.

Attributes

Name	Type	Description
`new_game_mode`	`GameMode`	Gets the GameMode the player is switched to.

`attr`new_game_modeproperty

new_game_mode: GameMode

Gets the GameMode the player is switched to.

`class`PlayerInteractActorEvent

Bases: PlayerEvent, Cancellable

PlayerInteractActorEvent()

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

Attributes

Name	Type	Description
`actor`	`Actor`	Gets the actor that was right-clicked by the player.

`attr`actorproperty

actor: Actor

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

`class`PlayerInteractEvent

Bases: PlayerEvent, Cancellable

PlayerInteractEvent()

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

Classes

Name	Description
`Action`

Attributes

Name	Type	Description
`LEFT_CLICK_AIR`
`LEFT_CLICK_BLOCK`
`RIGHT_CLICK_AIR`
`RIGHT_CLICK_BLOCK`
`action`	`Action`	Returns the action type of interaction
`block`	`Block`	Returns the clicked block
`block_face`	`BlockFace`	Returns the face of the block that was clicked
`clicked_position`	`Vector \| None`	Gets the exact position on the block the player interacted with.
`has_block`	`bool`	Check if this event involved a block
`has_item`	`bool`	Check if this event involved an item
`item`	`ItemStack \| None`	Returns the item in hand represented by this event

`attr`LEFT_CLICK_AIR

LEFT_CLICK_AIR

`attr`LEFT_CLICK_BLOCK

LEFT_CLICK_BLOCK

`attr`RIGHT_CLICK_AIR

RIGHT_CLICK_AIR

`attr`RIGHT_CLICK_BLOCK

RIGHT_CLICK_BLOCK

`attr`actionproperty

action: Action

Returns the action type of interaction

`attr`blockproperty

block: Block

Returns the clicked block

`attr`block_faceproperty

block_face: BlockFace

Returns the face of the block that was clicked

`attr`clicked_positionproperty

clicked_position: Vector | None

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

`attr`has_blockproperty

has_block: bool

Check if this event involved a block

`attr`has_itemproperty

has_item: bool

Check if this event involved an item

`attr`itemproperty

item: ItemStack | None

Returns the item in hand represented by this event

`class`Action

Bases: Enum

Action()

Attributes

Name	Type	Description
`LEFT_CLICK_AIR`
`LEFT_CLICK_BLOCK`
`RIGHT_CLICK_AIR`
`RIGHT_CLICK_BLOCK`

`attr`LEFT_CLICK_AIR

LEFT_CLICK_AIR = 2

`attr`LEFT_CLICK_BLOCK

LEFT_CLICK_BLOCK = 0

`attr`RIGHT_CLICK_AIR

RIGHT_CLICK_AIR = 3

`attr`RIGHT_CLICK_BLOCK

RIGHT_CLICK_BLOCK = 1

`class`PlayerItemConsumeEvent

Bases: PlayerEvent, Cancellable

PlayerItemConsumeEvent()

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

Attributes

Name	Type	Description
`hand`	`EquipmentSlot`	Get the hand used to consume the item.
`item`	`ItemStack`	Gets the item that is being consumed.

`attr`handproperty

hand: EquipmentSlot

Get the hand used to consume the item.

`attr`itemproperty

item: ItemStack

Gets the item that is being consumed.

`class`PlayerItemHeldEvent

Bases: PlayerEvent, Cancellable

PlayerItemHeldEvent()

Called when a player changes their currently held item.

Attributes

Name	Type	Description
`new_slot`	`int`	Gets the new held slot index
`previous_slot`	`int`	Gets the previous held slot index.

`attr`new_slotproperty

new_slot: int

Gets the new held slot index

`attr`previous_slotproperty

previous_slot: int

Gets the previous held slot index.

`class`PlayerJoinEvent

Bases: PlayerEvent

PlayerJoinEvent()

Called when a player joins a server

Attributes

Name	Type	Description
`join_message`	`str \| Translatable \| None`	Gets or sets the join message to send to all online players.

`attr`join_messageproperty

join_message: str | Translatable | None

Gets or sets the join message to send to all online players.

`class`PlayerJumpEvent

Bases: PlayerMoveEvent

PlayerJumpEvent()

Called when a player jumps.

`class`PlayerKickEvent

Bases: PlayerEvent, Cancellable

PlayerKickEvent()

Called when a player gets kicked from the server

Attributes

Name	Type	Description
`reason`	`str`	Gets or sets the reason why the player is getting kicked

`attr`reasonproperty

reason: str

Gets or sets the reason why the player is getting kicked

`class`PlayerLoginEvent

Bases: PlayerEvent, Cancellable

PlayerLoginEvent()

Called when a player attempts to login in.

Attributes

Name	Type	Description
`kick_message`	`str`	Gets or sets kick message to display if event is cancelled

`attr`kick_messageproperty

kick_message: str

Gets or sets kick message to display if event is cancelled

`class`PlayerMoveEvent

Bases: PlayerEvent, Cancellable

PlayerMoveEvent()

Called when a player moves.

Attributes

Name	Type	Description
`from_location`	`Location`	Gets or sets the location that this player moved from.
`to_location`	`Location`	Gets or sets the location that this player moved to.

`attr`from_locationproperty

from_location: Location

Gets or sets the location that this player moved from.

`attr`to_locationproperty

to_location: Location

Gets or sets the location that this player moved to.

`class`PlayerPickupItemEvent

Bases: PlayerEvent, Cancellable

PlayerPickupItemEvent()

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

Attributes

Name	Type	Description
`item`	`Item`	Gets the Item picked up by the entity.

`attr`itemproperty

item: Item

Gets the Item picked up by the entity.

`class`PlayerPortalEvent

Bases: PlayerTeleportEvent

PlayerPortalEvent()

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

`class`PlayerQuitEvent

Bases: PlayerEvent

PlayerQuitEvent()

Called when a player leaves a server.

Attributes

Name	Type	Description
`quit_message`	`str \| Translatable \| None`	Gets or sets the quit message to send to all online players.

`attr`quit_messageproperty

quit_message: str | Translatable | None

Gets or sets the quit message to send to all online players.

`class`PlayerRespawnEvent

Bases: PlayerEvent

PlayerRespawnEvent()

Called when a player respawns.

`class`PlayerSkinChangeEvent

Bases: PlayerEvent, Cancellable

PlayerSkinChangeEvent()

Called when a player changes their skin.

Attributes

Name	Type	Description
`new_skin`	`Skin`	Gets the player's new skin.
`skin_change_message`	`str \| Translatable \| None`	Gets or sets the message to send to all online players for this skin change.

`attr`new_skinproperty

new_skin: Skin

Gets the player's new skin.

`attr`skin_change_messageproperty

skin_change_message: str | Translatable | None

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

`class`PlayerTeleportEvent

Bases: PlayerMoveEvent

PlayerTeleportEvent()

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

`class`PluginDisableEvent

Bases: ServerEvent

PluginDisableEvent()

Called when a plugin is disabled.

Attributes

Name	Type	Description
`plugin`	`Plugin`

`attr`pluginproperty

plugin: Plugin

`class`PluginEnableEvent

Bases: ServerEvent

PluginEnableEvent()

Called when a plugin is enabled.

Attributes

Name	Type	Description
`plugin`	`Plugin`

`attr`pluginproperty

plugin: Plugin

`class`ScriptMessageEvent

Bases: ServerEvent, Cancellable

ScriptMessageEvent()

Called when a message is sent by /scriptevent command

Attributes

Name	Type	Description
`message`	`str`	Get the message to send.
`message_id`	`str`	Get the message id to send.
`sender`	`CommandSender`	Gets the command sender who initiated the command.

`attr`messageproperty

message: str

Get the message to send.

`attr`message_idproperty

message_id: str

Get the message id to send.

`attr`senderproperty

sender: CommandSender

Gets the command sender who initiated the command.

`class`ServerCommandEvent

Bases: ServerEvent, Cancellable

ServerCommandEvent()

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

Attributes

Name	Type	Description
`command`	`str`	Gets or sets the command that the server will execute
`sender`	`CommandSender`	Get the command sender.

`attr`commandproperty

command: str

Gets or sets the command that the server will execute

`attr`senderproperty

sender: CommandSender

Get the command sender.

`class`ServerEvent

Bases: Event

ServerEvent()

Represents a server-related event

`class`ServerListPingEvent

Bases: ServerEvent, Cancellable

ServerListPingEvent()

Called when a server ping is coming in.

Attributes

Name	Type	Description
`address`	`SocketAddress`	Get the address the ping is coming from.
`game_mode`	`GameMode`	Gets or sets the current game mode.
`level_name`	`str`	Gets or sets the level name.
`local_port`	`int`	Get or set the local port of the server.
`local_port_v6`	`int`	Get or set the local port of the server for IPv6 support
`max_players`	`int`	Gets or sets the maximum number of players allowed.
`minecraft_version_network`	`str`	Gets or sets the network version of Minecraft that is supported by this server
`motd`	`str`	Gets or sets the message of the day message.
`network_protocol_version`	`int`	Get the network protocol version of this server
`num_players`	`int`	Gets or sets the number of players online.
`server_guid`	`str`	Get or set the unique identifier of the server.

`attr`addressproperty

address: SocketAddress

Get the address the ping is coming from.

`attr`game_modeproperty

game_mode: GameMode

Gets or sets the current game mode.

`attr`level_nameproperty

level_name: str

Gets or sets the level name.

`attr`local_portproperty

local_port: int

Get or set the local port of the server.

`attr`local_port_v6property

local_port_v6: int

Get or set the local port of the server for IPv6 support

`attr`max_playersproperty

max_players: int

Gets or sets the maximum number of players allowed.

`attr`minecraft_version_networkproperty

minecraft_version_network: str

Gets or sets the network version of Minecraft that is supported by this server

`attr`motdproperty

motd: str

Gets or sets the message of the day message.

`attr`network_protocol_versionproperty

network_protocol_version: int

Get the network protocol version of this server

`attr`num_playersproperty

num_players: int

Gets or sets the number of players online.

`attr`server_guidproperty

server_guid: str

Get or set the unique identifier of the server.

`class`ServerLoadEvent

Bases: Event

ServerLoadEvent()

Called when either the server startup or reload has completed.

Classes

Name	Description
`LoadType`

Attributes

Name	Type	Description
`STARTUP`
`type`	`LoadType`

`attr`STARTUP

STARTUP

`attr`typeproperty

type: LoadType

`class`LoadType

Bases: Enum

LoadType()

Attributes

Name	Type	Description
`STARTUP`

`attr`STARTUP

STARTUP = 0

`class`ThunderChangeEvent

Bases: WeatherEvent, Cancellable

ThunderChangeEvent()

Called when the thunder state in a world is changing.

Attributes

Name	Type	Description
`to_thunder_state`	`bool`	Gets the state of thunder that the world is being set to

`attr`to_thunder_stateproperty

to_thunder_state: bool

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

`class`WeatherChangeEvent

Bases: WeatherEvent, Cancellable

WeatherChangeEvent()

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

Attributes

Name	Type	Description
`to_weather_state`	`bool`	Gets the state of weather that the world is being set to

`attr`to_weather_stateproperty

to_weather_state: bool

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

`class`WeatherEvent

Bases: Event

WeatherEvent()

Represents a weather-related event

Attributes

Name	Type	Description
`level`	`Level`	Returns the Level where this event is occurring

`attr`levelproperty

level: Level

Returns the Level where this event is occurring

`func`event_handler

event_handler(func=None, *, priority: EventPriority = EventPriority.NORMAL, ignore_cancelled: bool = False) -> Any

classActorDamageEvent

attrdamageproperty

attrdamage_sourceproperty

classActorDeathEvent

attrdamage_sourceproperty

classActorEvent

attractorproperty

classActorExplodeEvent

attrblock_listproperty

attrlocationproperty

classActorKnockbackEvent

attrknockbackproperty

attrsourceproperty

classActorRemoveEvent

classActorSpawnEvent

classActorTeleportEvent

attrfrom_locationproperty

attrto_locationproperty

classBlockBreakEvent

attrplayerproperty

classBlockCookEvent

attrresultproperty

attrsourceproperty

classBlockEvent

attrblockproperty

classBlockExplodeEvent

attrblock_listproperty

classBlockFormEvent

classBlockFromToEvent

attrto_blockproperty

classBlockGrowEvent

attrnew_stateproperty

classBlockPistonEvent

attrdirectionproperty

classBlockPistonExtendEvent

classBlockPistonRetractEvent

classBlockPlaceEvent

attrblock_againstproperty

attrblock_placed_stateproperty

attrblock_replacedproperty

attrplayerproperty

classBroadcastMessageEvent

attrmessageproperty

attrrecipientsproperty

classCancellable

attrcancelledproperty

attris_cancelledproperty

methcancel

classChunkEvent

attrchunkproperty

classChunkLoadEvent

classChunkUnloadEvent

classDimensionEvent

attrdimensionproperty

classEvent

attrevent_nameproperty

attris_asynchronousproperty

classEventPriority

attrHIGH

attrHIGHEST

attrLOW

attrLOWEST

attrMONITOR

attrNORMAL

classEventResult

attrALLOW

attrDEFAULT

attrDENY

classLeavesDecayEvent

classLevelEvent

attrlevelproperty

classMapInitializeEvent

attrmapproperty

classMobEvent

attractorproperty

classPacketReceiveEvent

attraddressproperty

attrpacket_idproperty

attrpayloadproperty

`class`ActorDamageEvent

`attr`damageproperty

`attr`damage_sourceproperty

`class`ActorDeathEvent

`attr`damage_sourceproperty

`class`ActorEvent

`attr`actorproperty

`class`ActorExplodeEvent

`attr`block_listproperty

`attr`locationproperty

`class`ActorKnockbackEvent

`attr`knockbackproperty

`attr`sourceproperty

`class`ActorRemoveEvent

`class`ActorSpawnEvent

`class`ActorTeleportEvent

`attr`from_locationproperty

`attr`to_locationproperty

`class`BlockBreakEvent

`attr`playerproperty

`class`BlockCookEvent

`attr`resultproperty

`attr`sourceproperty

`class`BlockEvent

`attr`blockproperty

`class`BlockExplodeEvent

`attr`block_listproperty

`class`BlockFormEvent

`class`BlockFromToEvent

`attr`to_blockproperty

`class`BlockGrowEvent

`attr`new_stateproperty

`class`BlockPistonEvent

`attr`directionproperty

`class`BlockPistonExtendEvent

`class`BlockPistonRetractEvent

`class`BlockPlaceEvent

`attr`block_againstproperty

`attr`block_placed_stateproperty

`attr`block_replacedproperty

`attr`playerproperty

`class`BroadcastMessageEvent

`attr`messageproperty

`attr`recipientsproperty

`class`Cancellable

`attr`cancelledproperty

`attr`is_cancelledproperty

`meth`cancel

`class`ChunkEvent

`attr`chunkproperty

`class`ChunkLoadEvent

`class`ChunkUnloadEvent

`class`DimensionEvent

`attr`dimensionproperty

`class`Event

`attr`event_nameproperty

`attr`is_asynchronousproperty

`class`EventPriority

`attr`HIGH

`attr`HIGHEST

`attr`LOW

`attr`LOWEST

`attr`MONITOR

`attr`NORMAL

`class`EventResult

`attr`ALLOW

`attr`DEFAULT

`attr`DENY

`class`LeavesDecayEvent

`class`LevelEvent

`attr`levelproperty

`class`MapInitializeEvent

`attr`mapproperty

`class`MobEvent

`attr`actorproperty

`class`PacketReceiveEvent

`attr`addressproperty

`attr`packet_idproperty

`attr`payloadproperty

`attr`playerproperty