EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Events

dialogue_started

A dialogue session of a player with an NPC started.

Feature
authority
Rights
none
Errors
invalid_type faultmissing_reference faultout_of_range faultunknown_field fault

Signature

{ dialogue: DialogueId, instance: OpaqueRef, kind: "dialogue_started", npc: ActorRef, player: PlayerRef }

Fields

NameTypeMeaning
dialogueDialogueIdDialogue of the session.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: dialogue
instanceOpaqueRefHost-assigned identity of this dialogue or cutscene session.
Length: 1…256; Pattern: ^[\s\S]+$
kind"dialogue_started"Discriminant
npcActorRefNPC the player talks to.
Length: 1…256; Pattern: ^[\s\S]+$
playerPlayerRefPlayer the event belongs to.
Length: 1…256; Pattern: ^[\s\S]+$

Validated example

{
  "dialogue": "core:healer_greeting",
  "instance": "dialogue/1",
  "kind": "dialogue_started",
  "npc": "a2",
  "player": "p1"
}