Interface: GenerateOptions

Defined in: src/types/GenerateOptions.ts:8

Options shared by ai.text.generateDialog, ai.image.generateBackground and ai.image.generateElement.

These options describe what should be included in the generated prompt. The actual prompt text is always assembled internally by the PromptBuilder.

Extended by

• DialogGenerateOptions
• ImageGenerateOptions

Properties

context?

> optional context?: string

Defined in: src/types/GenerateOptions.ts:19

Additional developer context, injected verbatim into the prompt.

history?

> optional history?: boolean

Defined in: src/types/GenerateOptions.ts:15

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

Default

true

scene?

> optional scene?: string

Defined in: src/types/GenerateOptions.ts:23

Scene description.

style?

> optional style?: string

Defined in: src/types/GenerateOptions.ts:27

Desired style (tone of voice, art style, etc).