# Interface: NarrationInputInterface (/jsdoc/pixi-vn/index/interfaces/NarrationInputInterface)



Defined in: [src/narration/interfaces/NarrationInputInterface.ts:4](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L4)

## Properties [#properties]

### isRequired [#isrequired]

\> `readonly` **isRequired**: `boolean`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:12](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L12)

If true, the player must enter a value.

***

### type [#type]

\> `readonly` **type**: `string` | `undefined`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:16](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L16)

Returns the type of input prompt requested.

***

### value [#value]

\> **value**: [`StorageElementType`](/jsdoc/pixi-vn/index/type-aliases/StorageElementType)

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L8)

The input value to be inserted by the player.

## Methods [#methods]

### removeRequest() [#removerequest]

\> **removeRequest**(): `void`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L26)

Remove the input request.

#### Returns [#returns]

`void`

***

### request() [#request]

\> **request**(`info?`, `defaultValue?`): `void`

Defined in: [src/narration/interfaces/NarrationInputInterface.ts:22](https://github.com/DRincs-Productions/pixi-vn/blob/4b8909bd13b1cc1fa7efb0238c44a5af3767e61f/src/narration/interfaces/NarrationInputInterface.ts#L22)

Returns `true` if the player must enter a value.

#### Parameters [#parameters]

##### info? [#info]

`Omit`\<[`InputInfo`](/jsdoc/pixi-vn/index/type-aliases/InputInfo), `"isRequired"`>

The input value to be inserted by the player.

##### defaultValue? [#defaultvalue]

[`StorageElementType`](/jsdoc/pixi-vn/index/type-aliases/StorageElementType)

The default value to be inserted.

#### Returns [#returns-1]

`void`