data/cues/
A cue: a sound or particle effect gameplay plays for clients, such as a hit, a footstep or an ability’s telegraph. Damage types, elements, effects, hooks and abilities name cues by key, and a key falls back to its nearest declared ancestor (x:cue.hit.blunt.big plays x:cue.hit.blunt when only that is declared). The cue’s entry says who receives it, how far it carries and what is dropped first over budget.
| Registry | manifold:cue |
| Files | data/cues/*.ron, *.update.ron, *.final.ron |
| Sides | both: the server and every client load it, and the handshake’s data hash covers it |
| Reads | nothing |
| Contract | Gameplay framework, data stage |
Entry
A record, written Cue(..); the name before the parentheses is optional.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | yes | The cue’s key, <mod-id>:<name>; dots make fallback ancestors. | |
kind | CueKind | no | Burst | A one-off burst, or a state that lasts while its source does. |
particle | string or None | no | none | A particle effect’s address. |
sound | string or None | no | none | A sound’s address (flagship:block/break). |
audience | CueAudience | no | Public | Who receives it. |
max_distance | f32 | no | 48 | The farthest a client may be, in metres. |
priority | CuePriority | no | Normal | What is dropped first over budget. |
Example
From game/flagship-game/data/cues/flagship.ron:
Cue(id: "flagship-game:cue.hit", sound: Some("flagship:block/break"), audience: Public, max_distance: 32.0)
Types
CueKind
A cue’s kind.
| Variant | Written | Description |
|---|---|---|
Burst | Burst | Plays once. |
Persistent | Persistent | Lasts while its effect instance, telegraph or ability does. |
CueAudience
Who receives a cue.
| Variant | Written | Description |
|---|---|---|
Public | Public | Every client in range. |
Party | Party | The involved players and their party members. |
Owner | Owner | The owner of the entity it plays on. |
Involved | Involved | The owners of the attacker and the target. |
CuePriority
A cue’s priority over budget.
| Variant | Written | Description |
|---|---|---|
Cosmetic | Cosmetic | Dropped first. |
Normal | Normal | The usual. |
Essential | Essential | Never dropped. |