Class: NarrationManagerStatic

Defined in: src/narration/NarrationManagerStatic.ts:26

Properties

_stepCounter

> static _stepCounter: number = 0

Defined in: src/narration/NarrationManagerStatic.ts:201

---

choiceMadeTemp

> static choiceMadeTemp: number | undefined = undefined

Defined in: src/narration/NarrationManagerStatic.ts:28

---

lastHistoryStep

> static lastHistoryStep: Omit<HistoryStep, "diff"> | null = null

Defined in: src/narration/NarrationManagerStatic.ts:29

---

onLoadingLabel?

> static optional onLoadingLabel?: (stepId, label) => void | Promise<void>

Defined in: src/narration/NarrationManagerStatic.ts:356

Parameters

stepId

number

label

LabelAbstract<any>

Returns

void | Promise<void>

---

onStepEnd?

> static optional onStepEnd?: (stepId, label) => void | Promise<void>

Defined in: src/narration/NarrationManagerStatic.ts:357

Parameters

stepId

number

label

LabelAbstract<any>

Returns

void | Promise<void>

Accessors

_currentLabel

Get Signature

> get static _currentLabel(): Label<{ }> | undefined

Defined in: src/narration/NarrationManagerStatic.ts:222

Returns

Label<{ }> | undefined

---

allChoicesMade

Get Signature

> get static allChoicesMade(): ChoicesMadeType[]

Defined in: src/narration/NarrationManagerStatic.ts:186

is a list of all choices made by the player during the progression of the steps.

Returns

ChoicesMadeType[]

Set Signature

> set static allChoicesMade(value): void

Defined in: src/narration/NarrationManagerStatic.ts:194

Parameters

value

ChoicesMadeType[]

Returns

void

---

allOpenedLabels

Get Signature

> get static allOpenedLabels(): AllOpenedLabelsType

Defined in: src/narration/NarrationManagerStatic.ts:34

is a list of all labels that have been opened during the progression of the steps. the key is the label id and the biggest step opened.

Returns

AllOpenedLabelsType

Set Signature

> set static allOpenedLabels(value): void

Defined in: src/narration/NarrationManagerStatic.ts:42

Parameters

value

AllOpenedLabelsType

Returns

void

---

currentLabelId

Get Signature

> get static currentLabelId(): string | undefined

Defined in: src/narration/NarrationManagerStatic.ts:231

currentLabelId is the current label id that occurred during the progression of the steps.

Returns

string | undefined

---

currentLabelStepIndex

Get Signature

> get static currentLabelStepIndex(): number | null

Defined in: src/narration/NarrationManagerStatic.ts:241

Returns

number | null

---

onStepStart

Get Signature

> get static onStepStart(): ((stepId, label) => Promise<void[]>) | undefined

Defined in: src/narration/NarrationManagerStatic.ts:342

Returns

((stepId, label) => Promise<void[]>) | undefined

Set Signature

> set static onStepStart(value): void

Defined in: src/narration/NarrationManagerStatic.ts:336

Parameters

value

(stepId, label) => void | Promise<void>

Returns

void

---

openedLabels

Get Signature

> get static openedLabels(): OpenedLabel[]

Defined in: src/narration/NarrationManagerStatic.ts:209

Returns

OpenedLabel[]

Set Signature

> set static openedLabels(value): void

Defined in: src/narration/NarrationManagerStatic.ts:212

Parameters

value

OpenedLabel[]

Returns

void

---

originalOpenedLabels

Get Signature

> get static originalOpenedLabels(): OpenedLabel[]

Defined in: src/narration/NarrationManagerStatic.ts:216

Returns

OpenedLabel[]

Set Signature

> set static originalOpenedLabels(value): void

Defined in: src/narration/NarrationManagerStatic.ts:219

Parameters

value

OpenedLabel[]

Returns

void

Methods

addChoicesMade()

> static addChoicesMade(label, stepIndex, stepSha, choiceMade): void

Defined in: src/narration/NarrationManagerStatic.ts:268

Parameters

label

string

stepIndex

number

stepSha

string

choiceMade

number

Returns

void

---

addLabelHistory()

> static addLabelHistory(label, stepIndex): void

Defined in: src/narration/NarrationManagerStatic.ts:259

Add a label to the history.

Parameters

label

string

The label to add to the history.

stepIndex

number

The step index of the label.

Returns

void

---

getCurrentStepTimesCounter()

> static getCurrentStepTimesCounter(nestedId?): number

Defined in: src/narration/NarrationManagerStatic.ts:109

Parameters

nestedId?

string = ""

Returns

number

---

getCurrentStepTimesCounterData()

> static getCurrentStepTimesCounterData(nestedId?): CurrentStepTimesCounterMemotyData | null

Defined in: src/narration/NarrationManagerStatic.ts:49

Parameters

nestedId?

string = ""

Returns

CurrentStepTimesCounterMemotyData | null

---

getRandomNumber()

> static getRandomNumber(min, max, options?): number | undefined

Defined in: src/narration/NarrationManagerStatic.ts:125

Parameters

min

number

max

number

options?

nestedId?

string

onceOnly?

boolean

Returns

number | undefined

---

increaseCurrentStepIndex()

> static increaseCurrentStepIndex(): void

Defined in: src/narration/NarrationManagerStatic.ts:318

Increase the current step index of the current label.

Returns

void

---

increaseStepCounter()

> static increaseStepCounter(): void

Defined in: src/narration/NarrationManagerStatic.ts:205

Increase the last step index that occurred during the progression of the steps.

Returns

void

---

pushNewLabel()

> static pushNewLabel(label): void

Defined in: src/narration/NarrationManagerStatic.ts:300

Add a label to the history.

Parameters

label

string

The label to add to the history.

Returns

void

Throws

when the label is not found in the registered labels.

---

resetCurrentStepTimesCounter()

> static resetCurrentStepTimesCounter(nestedId?): void

Defined in: src/narration/NarrationManagerStatic.ts:160

Parameters

nestedId?

string = ""

Returns

void