Expand description
Events by plane — event::player::session::Join, event::block::Break, … —
subscribed with Registry::on / before / after.
Re-exports§
pub use crate::net;
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.
- media
- Media as the game takes it: a
.yog’s yimage handed to the game as PNG (yog_media::yimage; the runtime answers). - 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). - nanite
- Nanites (
docs/design/nanites.md). - 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.
- storage
- A mod’s declared state in its stores (
docs/design/storage.md): its objects’ records — a type’s saved members, as Yog Data — read when their owner loads, written as the world saves. Keyed by the mod: each mod’s native answers its own, overyog-storage. - tag
- Tags: the host’s actions.
- ui
- Mods’ screens: the host’s actions.
- video
- The videos a client plays (
docs/design/video.md; the runtime answers, on a client): a player opened on a mod’s video, played, paused, sought, closed — and, each frame it’s drawn, its picture. - 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. - Event
Info - 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).
- Service
Info - A service’s descriptor: its domain and name, address and shapes.
- World
- A dimension (
minecraft:overworld): every action whose first field isdim.
Enums§
- Event
Phase - 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). - SUBJECTS
- Which handle an action belongs to, by its first field: the actions
whose first field is
uuidareEntity’s,playerPlayer’s,dimWorld’s. What other languages see of the handles (Yog Script’s objects) reads this;handle_method!’s arms are the same three, as a macro must spell them.
Traits§
- Arg
- An argument given as
Selffor a field of typeT. - Event
- An event the bus carries; its payload is
Selfinyog-data’s binary form. - Message
- A message the bus carries; its payload is
Selfas 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 aService::Reply.
Functions§
- all
- Every event type, plane by plane.
- call
- Asks
request’s provider: its reply,Nonewhen no one answers (or the bus isn’t reached yet). - keyed
address’s branch forkey: 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.