Skip to main content

Module event

Module event 

Source
Expand description

Events by plane — event::player::session::Join, event::block::Break, … — subscribed with Registry::on / before / after.

Modules§

advancement
Advancements: the host’s actions.
block
What happens to blocks.
bossbar
Boss bars: the host’s actions.
bus
The bus described: what each address carries, asked of the bus itself (services the runtime provides) — discovery, checking, bindings.
chat
Messages to players: the host’s actions.
client
The client.
command
Commands mods declare: what the host registers with the game.
container
Containers opened and closed.
content
What mods register: content the hosts make into the game’s.
entity
What happens to entities.
game
The game: the host’s actions.
item
Items’ services: what a mod says about its items’ stacks.
java
The bus’s messages for Java: a record per event (dev.yog.bus.YogEvents) and per service (YogServices), from the same schemas, that encodes itself and goes on the bus — the host fires events and calls services through these instead of a JNI method each, and reads the replies.
jvm
Java mods’ code, reached by reflection: the host’s actions.
key_binding
Key bindings mods declare: keys the player sees and rebinds in the game’s controls; presses come as client::input::Binding.
log
Records written to the game’s log.
menu
Menu entries mods declare: buttons the host puts on the game’s screens.
mirror
Mirrors (docs/design/bus.md, “Mirrors”): declaring one, providing one, its keys — services the runtime answers. A declaration’s reply is where its data is: addresses in this process, read in place (yog_mirror::view).
net
Sending over the network: the host’s actions.
particle
Particles: the host’s actions.
player
What players do.
scoreboard
The scoreboard: the host’s actions.
server
The server.
sound
Sounds: the host’s actions.
tag
Tags: the host’s actions.
ui
Mods’ screens: the host’s actions.
world
What happens to the world.

Structs§

Cached
A message type’s address, resolved the first time it’s asked for.
Entity
An entity, by its uuid: every action whose first field is uuid.
EventInfo
An event type’s descriptor: its plane and name, addresses and payload shape.
Player
An online player, by name: every action whose first field is player.
Point
A point in a world (blocks, fractional).
ServiceInfo
A service’s descriptor: its domain and name, address and shapes.
World
A dimension (minecraft:overworld): every action whose first field is dim.

Enums§

EventPhase
Whether a handler is running before or after the action.

Constants§

NO_ADDRESS
No address: what an empty name resolves to (yog_abi::NO_ADDRESS).

Traits§

Arg
An argument given as Self for a field of type T.
Event
An event the bus carries; its payload is Self in yog-data’s binary form.
Message
A message the bus carries; its payload is Self as a frame (yog_data::frame: packed by position — both sides have the schema).
Service
A call the bus carries: its payload is Self, its answer a Service::Reply.

Functions§

all
Every event type, plane by plane.
call
Asks request’s provider: its reply, None when no one answers (or the bus isn’t reached yet).
keyed
address’s branch for key: where a keyed message with that key goes.
resolve
name’s address.
services
Every service, domain by domain: the listed ones, then the actions.
set_caller
How this binary reaches the bus; the first one set stays.

Type Aliases§

Address
An address: its name’s atom number.
Caller
Sends payload to address’s provider: its reply’s bytes, None when no one answers.