Character

Character controls the dialogues of the character.

Note: Character does not drive stage sprite layout by itself; use Image for on-stage displayables. For dialog box avatars (small portraits next to ADV text), configure avatar / portraits and render Avatar — see Dialog.

Public Method

constructor

name: string | null - If null, then it is a narrator. Narrator do not show any name in the dialogue box.
config?: DeepPartial<CharacterConfig> - CharacterConfig

[[Callable]]

The character.say can be used as a tag function.

character`Hello, ${Word.color("Alice", "#f00")}!`, // will output "Hello, Alice" with "Alice" in red color

// is equivalent to

character.say`Hello, ${Word.color("Alice", "#f00")}!`

Note: This short-hand is not chainable using some packaging tools like Webpack.
scene.action([
    character`sentence 1` `sentence 2`, // this will throw an error
]);

Chainable Method

say

Overload 1 of 4

Say a sentence.

character
    .say("Good morning!")
    .say("How are you?")

content: string - The content of the sentence
config?: SentenceUserConfig - SentenceUserConfig

Overload 2 of 4

Use custom Sentence object.

character.say(
    new Sentence(character, [
        "Good morning, I am ",
        new Word("Alice", {color: "#f00"}), // Some words can be colored
    ])
) // will output "Good morning, I am Alice" with "Alice" in red color

Note: The dialogues's name will be the same as the sentence's name.

content: Sentence - See Sentence

Overload 3 of 4

Use mixed content of string and Word object.

character.say([
    "Hello, ",
    new Word("Alice", {color: "#f00"}), // Some words can be colored
]) // will output "Hello, Alice" with "Alice" in red color

content: SentencePrompt - See SentencePrompt
config?: SentenceUserConfig - SentenceUserConfig

Overload 4 of 4

Use short-hand for SentencePrompt.

character.say`Hello, ${Word.color("Alice", "#f00")}!` // will output "Hello, Alice" with "Alice" in red color

texts: TemplateStringsArray - The template string array
...words: SingleWord[] - SingleWord

setName

Set the name of the character.

character
    .setName("Alice (angry)")
    .say("What do you want?")

name: string - The name of the character

A name change is carried by saves since 0.26.0. Before that, Character never serialised its state, so no save recorded a name change: a player who saved after the reveal of a speaker shown as "???" came back to "???", in the dialog box and in the backlog alike. Starting a new game or loading a save now hands back the authored name rather than whatever the last playthrough left behind.

Saves written by earlier versions carry no character entry and still load, leaving the authored name in place. Because characters now occupy save entries, and a generated element id describes a position in the action tree rather than an identity, an application that restores saves should name its cast through DevTools.setElementStaticId.

setAvatar

Set or clear the character-level dialog avatar (used for off-screen lines and as fallback when no visible bound portrait applies).

const alice = new Character("Alice")
    .setAvatar("/assets/alice/avatar-default.png");

alice.setAvatar(false); // disable character-level avatar

avatar: DialogAvatar | false | null — Image source, resolver, false to disable, or null to clear.

See Dialog for resolver semantics and resolution order.

addPortrait

Bind a stage Image to this character and optionally supply a portrait-level dialog avatar (string or resolver).

alice.addPortrait(aliceBody, {
    avatar: "/assets/alice/avatar-normal.png",
});

image: Image — The stage portrait image.
config?: { avatar?: DialogAvatar } — Optional avatar override for this binding.

setPortraits

Replace the entire portraits list (mixed Image or { image, avatar } entries).

alice.setPortraits([
    { image: aliceBody, avatar: "/assets/alice/avatar-a.png" },
    bobPortraitImage,
]);

portraits: (Image | CharacterPortraitConfig)[] — See CharacterConfig.

apply

This is a special alias of say. It proxies the tag to the say method.

Note: Using some packaging tools like Webpack, you can't chain this method like this:
scene.action([
    character`sentence 1` `sentence 2`,
]);
But you still can chain other methods after it:
scene.action([
    character`sentence 1`.setName("Alice"),
]);

This method shortens the code when the character is saying only one sentence.

scene.action([
    character`Hello, ${Word.color("Alice", "#f00")}!`,
]);

texts: TemplateStringsArray - The template string array
...words: SingleWord[] - SingleWord

Sentence

Word

Pause