Event

endstone.event

ActorDamageEvent

Bases: MobEvent, Cancellable

Called when an Actor is damaged.

damage property writable

damage: float

Gets or sets the amount of damage caused by the event

damage_source property

damage_source: DamageSource

Gets the source of damage.

ActorDeathEvent

Bases: MobEvent

Called when an Actor dies.

damage_source property

damage_source: DamageSource

Gets the source of damage which caused the death.

ActorEvent

Bases: Event

Represents an Actor-related event.

actor property

actor: Actor

Returns the Actor involved in this event

ActorExplodeEvent

Bases: ActorEvent, Cancellable

Called when an Actor explodes.

block_list property writable

block_list: list[Block]

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

location property

location: Location

Returns the location where the explosion happened.

ActorKnockbackEvent

Bases: MobEvent, Cancellable

Called when a living entity receives knockback.

knockback property writable

knockback: Vector

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

source property

source: Actor

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

ActorRemoveEvent

Bases: ActorEvent

Called when an Actor is removed.

ActorSpawnEvent

Bases: ActorEvent, Cancellable

Called when an Actor is spawned into a world.

ActorTeleportEvent

Bases: ActorEvent, Cancellable

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

from_location property writable

from_location: Location

Gets or sets the location that this actor moved from.

to_location property writable

to_location: Location

Gets or sets the location that this actor moved to.

BlockBreakEvent

Bases: BlockEvent, Cancellable

Called when a block is broken by a player.

player property

player: Player

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

BlockEvent

Bases: Event

Represents an Block-related event

block property

block: Block

Gets the block involved in this event.

BlockPlaceEvent

Bases: BlockEvent, Cancellable

Called when a block is placed by a player.

block_against property

block_against: Block

Gets the block that this block was placed against

block_placed_state property

block_placed_state: BlockState

Gets the BlockState for the block which was placed.

block_replaced property

block_replaced: Block

Gets the block which was replaced.

player property

player: Player

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

BroadcastMessageEvent

Bases: ServerEvent, Cancellable

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

message property writable

message: str

Gets or sets the message to broadcast.

recipients property

recipients: set[CommandSender]

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

Cancellable

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

cancelled property writable

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 property writable

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.

cancel

cancel() -> None

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

DataPacketReceiveEvent

Bases: ServerEvent, Cancellable

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

data property

data: bytes

Gets the raw packet data

player property

player: Player

Gets the player involved in this event

DataPacketSendEvent

Bases: ServerEvent, Cancellable

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

data property

data: bytes

Gets the raw packet data

player property

player: Player

Gets the player involved in this event

Event

Represents an event.

event_name property

event_name: str

Gets a user-friendly identifier for this event.

is_asynchronous property

is_asynchronous: bool

Whether the event fires asynchronously.

EventPriority

EventPriority(value: int)

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

HIGH class-attribute

HIGH: EventPriority

HIGHEST class-attribute

HIGHEST: EventPriority

LOW class-attribute

LOW: EventPriority

LOWEST class-attribute

LOWEST: EventPriority

MONITOR class-attribute

MONITOR: EventPriority

NORMAL class-attribute

NORMAL: EventPriority

name property

name: str

value property

value: int

MobEvent

Bases: Event

Represents an Mob-related event.

actor property

actor: Mob

Returns the Mob involved in this event

PlayerChatEvent

Bases: PlayerEvent, Cancellable

Called when a player sends a chat message.

message property writable

message: str

Gets or sets the message that the player will send.

PlayerCommandEvent

Bases: PlayerEvent, Cancellable

Called whenever a player runs a command.

command property writable

command: str

Gets or sets the command that the player will send.

PlayerDeathEvent

Bases: ActorDeathEvent, PlayerEvent

Called when a player dies

death_message property writable

death_message: str

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

PlayerEmoteEvent

Bases: PlayerEvent

Called when a player uses and emote

emote_id property

emote_id: str

Gets the emote ID

PlayerEvent

Bases: Event

Represents a player related event

player property

player: Player

Returns the player involved in this event.

PlayerGameModeChangeEvent

Bases: PlayerEvent, Cancellable

Called when the GameMode of the player is changed.

new_game_mode property

new_game_mode: GameMode

Gets the GameMode the player is switched to.

PlayerInteractActorEvent

Bases: PlayerEvent, Cancellable

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

actor property

actor: Actor

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

PlayerInteractEvent

Bases: PlayerEvent, Cancellable

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

block property

block: Block

Returns the clicked block

block_face property

block_face: BlockFace

Returns the face of the block that was clicked

clicked_position property

clicked_position: Vector

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

has_block property

has_block: bool

Check if this event involved a block

has_item property

has_item: bool

Check if this event involved an item

item property

item: ItemStack

Returns the item in hand represented by this event

PlayerJoinEvent

Bases: PlayerEvent

Called when a player joins a server

join_message property writable

join_message: str

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

PlayerKickEvent

Bases: PlayerEvent, Cancellable

Called when a player gets kicked from the server

reason property writable

reason: str

Gets or sets the reason why the player is getting kicked

PlayerLoginEvent

Bases: PlayerEvent, Cancellable

Called when a player attempts to login in.

kick_message property writable

kick_message: str

Gets or sets kick message to display if event is cancelled

PlayerQuitEvent

Bases: PlayerEvent

Called when a player leaves a server.

quit_message property writable

quit_message: str

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

PlayerRespawnEvent

Bases: PlayerEvent

Called when a player respawns.

PlayerTeleportEvent

Bases: PlayerEvent, Cancellable

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

from_location property writable

from_location: Location

Gets or sets the location that this player moved from.

to_location property writable

to_location: Location

Gets or sets the location that this player moved to.

PluginDisableEvent

Bases: ServerEvent

Called when a plugin is disabled.

plugin property

plugin: Plugin

PluginEnableEvent

Bases: ServerEvent

Called when a plugin is enabled.

plugin property

plugin: Plugin

ScriptMessageEvent

Bases: ServerEvent, Cancellable

Called when a message is sent by /scriptevent command

message property

message: str

Get the message to send.

message_id property

message_id: str

Get the message id to send.

sender property

sender: CommandSender

Gets the command sender who initiated the command.

ServerCommandEvent

Bases: ServerEvent, Cancellable

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

command property writable

command: str

Gets or sets the command that the server will execute

sender property

sender: CommandSender

Get the command sender.

ServerEvent

Bases: Event

Represents a server-related event

ServerListPingEvent

Bases: ServerEvent, Cancellable

Called when a server ping is coming in.

game_mode property writable

game_mode: GameMode

Gets or sets the current game mode.

level_name property writable

level_name: str

Gets or sets the level name.

local_port property writable

local_port: int

Get or set the local port of the server.

local_port_v6 property writable

local_port_v6: int

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

max_players property writable

max_players: int

Gets or sets the maximum number of players allowed.

minecraft_version_network property writable

minecraft_version_network: str

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

motd property writable

motd: str

Gets or sets the message of the day message.

network_protocol_version property

network_protocol_version: int

Get the network protocol version of this server

num_players property writable

num_players: int

Gets or sets the number of players online.

remote_host property

remote_host: str

Get the host the ping is coming from.

remote_port property

remote_port: int

Get the port the ping is coming from.

server_guid property writable

server_guid: str

Get or set the unique identifier of the server.

ServerLoadEvent

Bases: Event

Called when either the server startup or reload has completed.

STARTUP class-attribute

STARTUP: LoadType

type property

type: LoadType

LoadType

LoadType(value: int)

STARTUP class-attribute

STARTUP: LoadType

name property

name: str

value property

value: int

ThunderChangeEvent

Bases: WeatherEvent, Cancellable

Called when the thunder state in a world is changing.

to_thunder_state property

to_thunder_state: bool

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

WeatherChangeEvent

Bases: WeatherEvent, Cancellable

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

to_weather_state property

to_weather_state: bool

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

WeatherEvent

Bases: Event

Represents a weather-related event

level property

level: Level

Returns the Level where this event is occurring

event_handler

event_handler(
    func=None,
    *,
    priority: EventPriority = NORMAL,
    ignore_cancelled: bool = False
)