EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Definitions

binding

A filtered event subscription with one owner source and an explicit snapshot.

Feature
authority
Rights
none
Errors
invalid_type faultmissing_reference faultout_of_range faultunknown_field fault

Signature

{ event: EventKind, filter: EventFilter, id: ContentId, kind: "binding", owner_from: BindingOwner, parameters: Parameters, script: ScriptId, snapshot: SnapshotSpec }

Fields

NameTypeMeaning
eventEventKindEvent kind or typed event payload selected by the handler declaration.
filterEventFilterDefinition references that restrict which matching events invoke the binding.
idContentIdPackage-qualified identity; unique within its declaring namespace.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$
kind"binding"Discriminant
owner_fromBindingOwnerEvent field that supplies the invocation owner.
parametersParametersExact closed argument record supplied by the selected definition.
scriptScriptIdAuthority handler declared by the same package.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: script
snapshotSnapshotSpecExplicit visibility requested for the frozen invocation snapshot.

Validated example

{
  "event": "dialogue_choice",
  "filter": {
    "choice": "accept",
    "dialogue": "core:milo_talk",
    "node": "offer"
  },
  "id": "core:a_place_to_rest_accept",
  "kind": "binding",
  "owner_from": "player",
  "parameters": {
    "quest": "core:a_place_to_rest"
  },
  "script": "core:quest_accept",
  "snapshot": {
    "anchors": [],
    "definitions_from": [
      "core"
    ],
    "radius_mm": 0,
    "variables": []
  }
}