Difference between revisions of "Dialogue"

Revision as of 08:53, 23 February 2017

The built in dialogue (speech) system can be used to create conversations between any number of players or 'items' (typically NPCs), or can be used for cutscenes or a sing along. It fully supports the localisation system and can be cued from speech playback, synthesis, the player or anything else via scripting. It's also built on top of the window system so dialogue can be easily displayed inside drop-and-go templates.

Basic structure

All dialogue is JSON compatible with PowerSlide. Here's the general structure of those JSON files:

[
  {"speaker":"player"},
  "Hello! My name is &Username;.",
  "All of this text will be said <b>by the player</b>.",
  "It's just an array of text. Because we aren't defining any timing information, it will be cued by the player.",
  "That typically means the player will see something like <i>'press x to continue'</i>.",
  
  {"speaker":"system"},
  "You feel a rush of excitement",
  
  {"speaker":"player"},
  "Ah. That was the system speaker - speaker names can be whatever you want",
  "'system' is reserved as meaning a narrator-style speaker usually present in RPGs.",
  "By convention, spaces are added between speakers, so you can clearly see when a speaker changes."
]

Save a file like that in Resources/Dialogue. For example, Resources/Dialogue/myDialogue.json. To use it, you then use startDialogue:

/* Loads myDialogue_en.json with the specified visual template. */
UI.document.startDialogue("myDialogue","templateToUse");

For example, call that when a player clicked on an NPC.

As it's PowerSlide, you can also define other tracks in there too (such as a style track and potentially in the future a variety of cutscene management tracks - camera position etc).

Localisation

As seen above with 'Username', localisation variables are fully supported. However, for the purposes of translating all your dialogue, provide multiple versions of the file instead.

myDialogue_en.json:

[
  {"speaker":"player"},
  "Hello! My name is &Username;.",
  "All of this text will be said <b>by the player</b>.",
  
  {"speaker":"system"},
  "You feel a rush of excitement"
]

myDialogue_fr.json:

[
  {"speaker":"player"},
  "Salut! Je m'appelle &Username;.",
  "Tout ce texte sera <b>dit par le joueur</b>.",
  
  {"speaker":"system"},
  "Vous sentez une pointe d'excitation"
]

To automatically switch based on the available languages (declared in your languages meta tag) and the UI.Language setting, use {language} in your file path:

/* Loads myDialogue_en.json with the specified visual template. */
UI.document.startDialogue("myDialogue_{language}","templateToUse");

Streamed Dialogue

If you want to stream it over any of your schemas, the first argument of startDialogue accepts a complete URL. Use the various PowerSlide start events to catch when it's actually starting up.

/* Just use a full URL */
UI.document.startDialogue("cdn://myDialogue.json","templateName");

Further Details

Like other PowerSlide tracks, a dialogue track is just a list of slides. If a slide does not define a speaker then it adopts the speaker applied to the previous slide. If a slide only defines a speaker, then it's completely ignored from the dialogue stream (but does affect the speaker of the following slides).

So, the first example is short for:

[
  {
    "speaker":"player",
    "markup":"Hello! My name is &Username;."
  },
  {
    "speaker":"player",
    "markup":"All of this text will be said <b>by the player</b>."
  },
  {
    "speaker":"player",
    "markup":"It's just an array of text. Because we aren't defining any timing information, it will be cued by the player."
  },
  {
    "speaker":"player",
    "markup":"That typically means the player will see something like <i>'press x to continue'</i>."
  },

  "etc"
]

Available properties

Here's the available properties on dialogue slides.

Speakers

Most of the time, speaker information is already available elsewhere. So, PowerSlide does not include a way for storing speaker details (like their name, a chat head etc). Instead, you'll need to provide those details via the PowerSlide.Dialogue.OnGetSpeaker delegate:

// using PowerSlide;

Dialogue.OnGetSpeaker=delegate(SpeakerType type,string id){
    
    // Create the speaker object (instance/ return a custom type if you want):
    Speaker speaker=new Speaker(type,id);
    
    /* 
        Get the information for whatever type/id refers to now!
    
    e.g:
    
    if(type==SpeakerType.Player && id==null){
        
        // Current player! You can use localisation variables 
        // here if you want, or directly set it:
        speaker.fullName="&Username;";
        
    }
    
    */
    // Ok!
    return speaker;
};

Multiple speakers

A single speaker name could represent a group; for example "clan-members" could be all clan members in the scene. However, if you need to list out multiple speakers, then you simply provide an array like so:

[
   {"speakers":["player","joey"]},
   "STOP!!"
]

Advanced speakers

You might want dialogue between two players in a multiplayer game. The above speaker strings are actually short forms of this:

"speaker":{"type":"player","id":"2"} /* Some remote player */

"speaker":{"type":"player"} /* Current player */

Events

Along with all the ordinary window events and PowerSlide events, dialogue also generates these:

Mood

Mood can change very rapidly throughout dialogue, and can occasionally be hard to translate. Something happy in one culture can actually be upsetting in another, for example. So, mood is declared in the markup as part of SSML - that way it can be translated correctly and is also useful in audio recordings or speech synthesis. See the note about SSML below.

Cutscenes and Timed Dialogue

To make dialogue appear and dissappear at specific times, you simply need to add a start and optionally a duration to each entry. Here's an example:

[
  {
    "speaker":"player",
    "start":"0s",
    "duration":"2s",
    "markup":"Hello! My name is &Username;."
  },
  {
    "start":"3s",
    "duration":"3s",
    "markup":"All of this text will be said <b>by the player</b>."
  },
  {
    "start":"7s",
    "duration":"7s",
    "markup":"It's just an array of text. We're defining timing information this time so it won't wait for cues."
  }
]

If you don't add a duration it will be set as the time until the following slide (in the same way as all other PowerSlide duration values).

Sing along

Sing alongs typically come in two categories: follow the bouncing ball and style changes, such as changing the colour of the word/ syllable currently being sung.

The structure of the JSON is the same as timed dialogue except you can optionally add additional per-word or per-syllable timing information. Note that you'll need to use a specific "sing along" dialogue template to make use of that additional timing information and e.g. display a bouncing ball. Here's how that additional timing information is added:

[
  {
    "speaker":"player",
    "start":"0s",
    "duration":"2s",
    "markup":"Hello! My name is &Username;."
  },
  {
    "speaker":"player",
    "start":"3s",
    "duration":"3s",
    "markup":"<cue at='3.1s'>All</cue> <cue at='3.6s'>of</cue> <cue at='3.8s'>this</cue> <cue at='4.2s'>text</cue> <cue at='4.5s'>will</cue> <cue at='4.8s'>be</cue> <cue at='5s'>said</cue> <b><cue at='5.3s'>by</cue> <cue at='5.5s'>the</cue> <cue at='5.7s'>player</cue></b>."
  },
  {
    "speaker":"player",
    "start":"7s",
    "duration":"7s",
    "markup":"It's just an array of text. We're defining timing information this time so it won't wait for cues."
  }
]

If you don't add additional timing information then a sing along template is expected to assume a constant speed through the current text.

Speech markup language (SSML)

All dialogue is actually an extended version of SSML. It can contain all HTML as well as speech hints. It may potentially be forwarded to a speech synthesis engine or otherwise checked for mood cues within the speech.

<!-- The SSML describes both how it sounds and how it appears on the UI (it fully supports HTML too) -->
<happy>Hello &Username; - I'm feeling <i>great</i> today!</happy> <sad>But..</sad>