EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

notify

Show one localized text key to the permitted player after commit.

Feature
presentation
Rights
player_notification
Debits
none
Conflict
accumulating
Errors
invalid_type faultmissing_reference faultscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ kind: "notify", player: PlayerRef, text: TextKey }

Fields

NameTypeMeaning
kind"notify"Discriminant
playerPlayerRefPlayer instance whose state or inventory the invocation may access.
Length: 1…256; Pattern: ^[\s\S]+$
textTextKeyLocalized text key resolved by the receiving player's locale.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: text

Validated example

{
  "kind": "notify",
  "player": "p1",
  "text": "core:first_aid_complete"
}