Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

data/tags/

A tag: a name in a dotted hierarchy (mymod:state.charging) that entities, effects, abilities and hits carry. Conditions and tag queries test for tags, and a query for a tag also matches its descendants. Declaring a tag declares its ancestors. Tags are granted by archetypes (tags), effects (grant_tags) and abilities (owned_tags); a tag’s entry says who sees it, whether gaining or losing it notifies observers, and whether loose grants are saved.

Registrymanifold:tag
Filesdata/tags/*.ron, *.update.ron, *.final.ron
Sidesboth: the server and every client load it, and the handshake’s data hash covers it
Readsnothing
ContractGameplay framework, data stage

Entry

A record, written Tag(..); the name before the parentheses is optional.

FieldTypeRequiredDefaultDescription
idstringyesThe tag’s key: <mod-id>:<segment>(.<segment>)*, each segment of lower-case letters, digits and _.
replicateTagAudiencenoServerWho sees the tag.
notifyboolnofalseWhether a change between none and some of the tag notifies observers (TagChanged).
persistboolnofalseWhether grants that no effect or ability owns are saved.

Example

From tools/test-mods/enki-stub/data/tags/enki-stub.ron:

Tag(id: "enki-stub:tool.box")

Types

TagAudience

Who sees a tag. It is the ceiling for every client and client mod.

VariantWrittenDescription
ServerServerOnly the server.
OwnerOwnerThe server and the entity’s owner.
PublicPublicEvery client with the entity in scope.