Interface: NarrationHistory

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

Properties

choices?

> optional choices?: HistoryChoiceMenuOption[]

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

List of choices asked of the player

---

dialogue?

> optional dialogue?: DialogueInterface

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

Dialogue to be shown in the game

---

inputValue?

> optional inputValue?: StorageElementType

Defined in: src/narration/interfaces/NarrationHistory.ts:24

The input value of the player

---

openedLabelsNumber?

> optional openedLabelsNumber?: number

Defined in: src/narration/interfaces/NarrationHistory.ts:33

The number of labels that were opened (via NarrationManagerInterface.call or NarrationManagerInterface.jump) when this step ran.

This is the size of the label call-stack at this step, and can be used to split a page into paragraphs: every time this number increases compared to the previous step, a call opened a new paragraph. A jump instead starts a whole new page, so it is already reflected by HistoryManagerInterface.currentLabelHistory starting over.

---

playerMadeChoice?

> optional playerMadeChoice?: boolean

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

The player made a choice

---

stepIndex

> stepIndex: number

Defined in: src/narration/interfaces/NarrationHistory.ts:20

The index of the step in the history.