Interface: NarrationInputInterface

Defined in: src/narration/interfaces/NarrationInputInterface.ts:4

Properties

isRequired

> readonly isRequired: boolean

Defined in: src/narration/interfaces/NarrationInputInterface.ts:12

If true, the player must enter a value.

---

type

> readonly type: string | undefined

Defined in: src/narration/interfaces/NarrationInputInterface.ts:16

Returns the type of input prompt requested.

---

value

> value: StorageElementType

Defined in: src/narration/interfaces/NarrationInputInterface.ts:8

The input value to be inserted by the player.

Methods

removeRequest()

> removeRequest(): void

Defined in: src/narration/interfaces/NarrationInputInterface.ts:26

Remove the input request.

Returns

void

---

request()

> request(info?, defaultValue?): void

Defined in: src/narration/interfaces/NarrationInputInterface.ts:22

Returns true if the player must enter a value.

Parameters

info?

Omit<InputInfo, "isRequired">

The input value to be inserted by the player.

defaultValue?

StorageElementType

The default value to be inserted.

Returns

void