# Interface: DialogGenerateOptions (/pixi-vn-ai/index/interfaces/DialogGenerateOptions)



Defined in: [src/types/DialogGenerateOptions.ts:7](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L7)

Options accepted by [ai.text.generateDialog](/pixi-vn-ai/index/namespaces/ai/namespaces/text/functions/generateDialog).

## Extends [#extends]

* [`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/GenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

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

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/GenerateOptions#history)

***

### language? [#language]

\> `optional` **language?**: `string`

Defined in: [src/types/DialogGenerateOptions.ts:24](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L24)

Output language.

***

### listeners? [#listeners]

\> `optional` **listeners?**: [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem) | [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem)\[]

Defined in: [src/types/DialogGenerateOptions.ts:20](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L20)

Character(s) receiving the dialogue.

Can be any serializable object (or array of objects).

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-2]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/GenerateOptions#scene)

***

### speaker? [#speaker]

\> `optional` **speaker?**: [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem) | [`CharacterItem`](/pixi-vn-ai/index/type-aliases/CharacterItem)\[]

Defined in: [src/types/DialogGenerateOptions.ts:14](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/DialogGenerateOptions.ts#L14)

Character(s) speaking.

Can be any serializable object (or array of objects). Pixi'VN AI does not define a
`Character` model: developers are free to pass whatever shape fits their game.

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

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

#### Inherited from [#inherited-from-3]

[`GenerateOptions`](/pixi-vn-ai/index/interfaces/GenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/GenerateOptions#style)