yog-ids 0.5.1

Yog's shared names — namespaces, content kinds, schemes, separators, its own ids — defined once, exported to TypeScript and Java.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

//! The bus's event addresses (`docs/design/bus.md`); services' are in `services.rs`.

names! {
    /// The words the bus's event and service addresses are made of.
    bus_word {
        ATTACK = "attack",
        ATTRIBUTE_VALUE = "attribute_value",
        CALL = "call",
        CHAT = "chat",
        CLIENT = "client",
        CLOSE = "close",
        CONTAINER = "container",
        CRAFT = "craft",
        DEATH = "death",
        GET = "get",
        DECLARE = "declare",
        DECLARED = "declared",
        GAME = "game",
        INFO = "info",
        INPUT = "input",
        LIFE = "life",
        NBT = "nbt",
        NET = "net",
        OPEN = "open",
        PACKET = "packet",
        PLACE = "place",
        RELEASE = "release",
        SERVER = "server",
        SET = "set",
        SET_DIMENSIONS = "set_dimensions",
        SET_NBT = "set_nbt",
        SPAWN = "spawn",
        TELEPORT = "teleport",
        TELEPORT_TO_DIM = "teleport_to_dim",
        TICK = "tick",
        USE_ITEM = "use_item",
        WORLD = "world",
    }

    /// The bus's events (`docs/design/bus.md`): `yog:event/<plane>/<name>`
    /// after the game did it, `…/pre` before (a cancel stops it).
    event {
        /// What every event address starts with.
        PREFIX = crate::concatcp!(crate::ns::YOG, crate::sep::NAMESPACE, crate::word::EVENT, crate::sep::PATH),
        /// What a pre-event's address ends with.
        PRE = crate::concatcp!(crate::sep::PATH, "pre"),
    }

    /// `yog:event/log/…`.
    event_log {
        PLANE = crate::concatcp!(crate::event::PREFIX, "log", crate::sep::PATH),
        RECORD = crate::concatcp!(PLANE, "record"),
    }

    /// `yog:event/player/session/…`.
    event_player_session {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::PLAYER, crate::sep::PATH, "session", crate::sep::PATH),
        JOIN = crate::concatcp!(PLANE, "join"),
        LEAVE = crate::concatcp!(PLANE, "leave"),
    }

    /// `yog:event/player/life/…`.
    event_player_life {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::PLAYER, crate::sep::PATH, crate::bus_word::LIFE, crate::sep::PATH),
        DEATH = crate::concatcp!(PLANE, crate::bus_word::DEATH),
        DEATH_PRE = crate::concatcp!(DEATH, crate::event::PRE),
        RESPAWN = crate::concatcp!(PLANE, "respawn"),
    }

    /// `yog:event/player/chat/…`.
    event_player_chat {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::PLAYER, crate::sep::PATH, crate::bus_word::CHAT, crate::sep::PATH),
        MESSAGE = crate::concatcp!(PLANE, "message"),
        MESSAGE_PRE = crate::concatcp!(MESSAGE, crate::event::PRE),
    }

    /// `yog:event/player/action/…`.
    event_player_action {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::PLAYER, crate::sep::PATH, "action", crate::sep::PATH),
        MOVE = crate::concatcp!(PLANE, "move"),
        USE_ITEM = crate::concatcp!(PLANE, crate::bus_word::USE_ITEM),
        USE_ITEM_PRE = crate::concatcp!(USE_ITEM, crate::event::PRE),
        ATTACK = crate::concatcp!(PLANE, crate::bus_word::ATTACK),
        INTERACT = crate::concatcp!(PLANE, "interact"),
        INTERACT_PRE = crate::concatcp!(INTERACT, crate::event::PRE),
        CRAFT = crate::concatcp!(PLANE, crate::bus_word::CRAFT),
        PICKUP = crate::concatcp!(PLANE, "pickup"),
        PICKUP_PRE = crate::concatcp!(PICKUP, crate::event::PRE),
    }

    /// `yog:event/player/progress/…`.
    event_player_progress {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::PLAYER, crate::sep::PATH, "progress", crate::sep::PATH),
        ADVANCEMENT = crate::concatcp!(PLANE, crate::kind::ADVANCEMENT),
    }

    /// `yog:event/block/…`.
    event_block {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::word::BLOCK, crate::sep::PATH),
        BREAK = crate::concatcp!(PLANE, "break"),
        BREAK_PRE = crate::concatcp!(BREAK, crate::event::PRE),
        PLACE = crate::concatcp!(PLANE, crate::bus_word::PLACE),
        PLACE_PRE = crate::concatcp!(PLACE, crate::event::PRE),
        USE = crate::concatcp!(PLANE, "use"),
        USE_PRE = crate::concatcp!(USE, crate::event::PRE),
    }

    /// `yog:event/entity/life/…`.
    event_entity_life {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::kind::ENTITY, crate::sep::PATH, crate::bus_word::LIFE, crate::sep::PATH),
        SPAWN = crate::concatcp!(PLANE, crate::bus_word::SPAWN),
        SPAWN_PRE = crate::concatcp!(SPAWN, crate::event::PRE),
        DEATH = crate::concatcp!(PLANE, crate::bus_word::DEATH),
    }

    /// `yog:event/entity/combat/…`.
    event_entity_combat {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::kind::ENTITY, crate::sep::PATH, "combat", crate::sep::PATH),
        DAMAGE = crate::concatcp!(PLANE, crate::word::DAMAGE),
        DAMAGE_PRE = crate::concatcp!(DAMAGE, crate::event::PRE),
        PROJECTILE_HIT = crate::concatcp!(PLANE, "projectile_hit"),
        PROJECTILE_HIT_PRE = crate::concatcp!(PROJECTILE_HIT, crate::event::PRE),
    }

    /// `yog:event/entity/game/…`; keyed by the entity's type.
    event_entity_game {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::kind::ENTITY, crate::sep::PATH, crate::bus_word::GAME, crate::sep::PATH),
        TICK = crate::concatcp!(PLANE, crate::bus_word::TICK),
    }

    /// `yog:event/world/…`.
    event_world {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::WORLD, crate::sep::PATH),
        EXPLOSION = crate::concatcp!(PLANE, "explosion"),
        EXPLOSION_PRE = crate::concatcp!(EXPLOSION, crate::event::PRE),
    }

    /// `yog:event/world/generation/…`; keyed by the generator type.
    event_world_generation {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::WORLD, crate::sep::PATH, "generation", crate::sep::PATH),
        CHUNK = crate::concatcp!(PLANE, crate::word::CHUNK),
    }

    /// `yog:event/world/loot/…`.
    event_world_loot {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::WORLD, crate::sep::PATH, crate::word::LOOT, crate::sep::PATH),
        ROLL = crate::concatcp!(PLANE, "roll"),
    }

    /// `yog:event/container/…`.
    event_container {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CONTAINER, crate::sep::PATH),
        OPEN = crate::concatcp!(PLANE, crate::bus_word::OPEN),
        OPEN_PRE = crate::concatcp!(OPEN, crate::event::PRE),
        CLOSE = crate::concatcp!(PLANE, crate::bus_word::CLOSE),
    }

    /// `yog:event/container/machine/…`.
    event_container_machine {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CONTAINER, crate::sep::PATH, "machine", crate::sep::PATH),
        CRAFT = crate::concatcp!(PLANE, crate::bus_word::CRAFT),
        CRAFT_PRE = crate::concatcp!(CRAFT, crate::event::PRE),
    }

    /// `yog:event/server/game/…`.
    event_server_game {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::SERVER, crate::sep::PATH, crate::bus_word::GAME, crate::sep::PATH),
        TICK = crate::concatcp!(PLANE, crate::bus_word::TICK),
    }

    /// `yog:event/server/life/…`.
    event_server_life {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::SERVER, crate::sep::PATH, crate::bus_word::LIFE, crate::sep::PATH),
        STARTED = crate::concatcp!(PLANE, "started"),
        STOPPING = crate::concatcp!(PLANE, "stopping"),
        SAVING = crate::concatcp!(PLANE, "saving"),
    }

    /// `yog:event/server/command/…`; keyed by the command's name.
    event_server_command {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::SERVER, crate::sep::PATH, crate::yui_vm::COMMAND, crate::sep::PATH),
        RUN = crate::concatcp!(PLANE, "run"),
    }

    /// `yog:event/server/net/…`; keyed by channel.
    event_server_net {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::SERVER, crate::sep::PATH, crate::bus_word::NET, crate::sep::PATH),
        PACKET = crate::concatcp!(PLANE, crate::bus_word::PACKET),
    }

    /// `yog:event/client/game/…`.
    event_client_game {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, crate::bus_word::GAME, crate::sep::PATH),
        TICK = crate::concatcp!(PLANE, crate::bus_word::TICK),
        TRAVEL = crate::concatcp!(PLANE, "travel"),
    }

    /// `yog:event/client/input/…`.
    event_client_input {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, crate::bus_word::INPUT, crate::sep::PATH),
        KEY = crate::concatcp!(PLANE, crate::word::KEY),
        KEY_PRE = crate::concatcp!(KEY, crate::event::PRE),
        BINDING = crate::concatcp!(PLANE, "binding"),
        SCROLL = crate::concatcp!(PLANE, "scroll"),
        SCROLL_PRE = crate::concatcp!(SCROLL, crate::event::PRE),
    }

    /// `yog:event/client/chat/…`: what the player sends to the chat.
    event_client_chat {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, "chat", crate::sep::PATH),
        SEND = crate::concatcp!(PLANE, "send"),
        SEND_PRE = crate::concatcp!(SEND, crate::event::PRE),
    }

    /// `yog:event/client/ui/…`.
    event_client_ui {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, crate::word::UI, crate::sep::PATH),
        OPEN = crate::concatcp!(PLANE, crate::bus_word::OPEN),
        CLOSE = crate::concatcp!(PLANE, crate::bus_word::CLOSE),
        INPUT = crate::concatcp!(PLANE, crate::bus_word::INPUT),
        INPUT_PRE = crate::concatcp!(INPUT, crate::event::PRE),
    }

    /// `yog:event/client/render/…`.
    event_client_render {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, "render", crate::sep::PATH),
        HUD = crate::concatcp!(PLANE, "hud"),
        WORLD = crate::concatcp!(PLANE, crate::bus_word::WORLD),
        UI = crate::concatcp!(PLANE, crate::word::UI),
        TOOLTIP = crate::concatcp!(PLANE, crate::yui_attr::TOOLTIP),
        PAGE = crate::concatcp!(PLANE, "page"),
        CAMERA = crate::concatcp!(PLANE, "camera"),
        BODY = crate::concatcp!(PLANE, "body"),
    }

    /// `yog:event/client/net/…`; keyed by channel.
    event_client_net {
        PLANE = crate::concatcp!(crate::event::PREFIX, crate::bus_word::CLIENT, crate::sep::PATH, crate::bus_word::NET, crate::sep::PATH),
        PACKET = crate::concatcp!(PLANE, crate::bus_word::PACKET),
    }
}