EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

start_dialogue

Start a dialogue session of a player with a living NPC in reach.

Feature
authority
Rights
player_session
Debits
none
Conflict
guarded
Errors
invalid_type faultmissing_reference faultout_of_range faultprecondition_failed rejectionscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ dialogue: DialogueId, kind: "start_dialogue", npc: ActorRef, player: PlayerRef }

Fields

NameTypeMeaning
dialogueDialogueIdDialogue whose npc matches the target.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: dialogue
kind"start_dialogue"Discriminant
npcActorRefNPC the player talks to.
Length: 1…256; Pattern: ^[\s\S]+$
playerPlayerRefPlayer that talks.
Length: 1…256; Pattern: ^[\s\S]+$

Validated example

{
  "dialogue": "core:healer_greeting",
  "kind": "start_dialogue",
  "npc": "a2",
  "player": "p1"
}