Function: showDialog()

> showDialog(request, character?, options?): Promise<string>

Defined in: src/show.ts:66

Generate a dialogue from a developer request and set it as the current Pixi'VN narration dialogue. This is the combination of ai.text.generateDialog and Pixi'VN's narration.dialogue.

Parameters

request

string

Natural language description of the dialogue to generate.

character?

CharacterItem

The character speaking, if any. Set as the dialogue's character, and also used as DialogGenerateOptions.speaker (so the model knows who it's writing for) when options.speaker isn't already set.

options?

DialogGenerateOptions

Options controlling which context gets included in the prompt.

Returns

Promise<string>

The generated dialogue text.