# Class: NarrationManagerStatic (/jsdoc/pixi-vn/index/classes/NarrationManagerStatic)



Defined in: [src/narration/NarrationManagerStatic.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L26)

Properties [#properties]

\_stepCounter [#_stepcounter]

\> `static` **\_stepCounter**: `number` = `0`

Defined in: [src/narration/NarrationManagerStatic.ts:201](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L201)

***

choiceMadeTemp [#choicemadetemp]

\> `static` **choiceMadeTemp**: `number` | `undefined` = `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:28](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L28)

***

lastHistoryStep [#lasthistorystep]

\> `static` **lastHistoryStep**: `Omit`\<[`HistoryStep`](/jsdoc/pixi-vn/index/interfaces/HistoryStep), `"diff"`> | `null` = `null`

Defined in: [src/narration/NarrationManagerStatic.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L29)

***

onLoadingLabel? [#onloadinglabel]

\> `static` `optional` &#x2A;*onLoadingLabel?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/NarrationManagerStatic.ts:356](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L356)

Parameters [#parameters]

stepId [#stepid]

`number`

label [#label]

[`LabelAbstract`](/jsdoc/pixi-vn/index/classes/LabelAbstract)\<`any`>

Returns [#returns]

`void` | `Promise`\<`void`>

***

onStepEnd? [#onstepend]

\> `static` `optional` &#x2A;*onStepEnd?**: (`stepId`, `label`) => `void` | `Promise`\<`void`>

Defined in: [src/narration/NarrationManagerStatic.ts:357](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L357)

Parameters [#parameters-1]

stepId [#stepid-1]

`number`

label [#label-1]

[`LabelAbstract`](/jsdoc/pixi-vn/index/classes/LabelAbstract)\<`any`>

Returns [#returns-1]

`void` | `Promise`\<`void`>

Accessors [#accessors]

\_currentLabel [#_currentlabel]

Get Signature [#get-signature]

\> **get** `static&#x60; **\_currentLabel**(): [`Label`](/jsdoc/pixi-vn/index/classes/Label)\<\{ }> | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:222](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L222)

Returns [#returns-2]

[`Label`](/jsdoc/pixi-vn/index/classes/Label)\<\{ }> | `undefined`

***

allChoicesMade [#allchoicesmade]

Get Signature [#get-signature-1]

\> **get** `static` **allChoicesMade**(): `ChoicesMadeType`\[]

Defined in: [src/narration/NarrationManagerStatic.ts:186](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L186)

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

Returns [#returns-3]

`ChoicesMadeType`\[]

Set Signature [#set-signature]

\> **set** `static` **allChoicesMade**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:194](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L194)

Parameters [#parameters-2]

value [#value]

`ChoicesMadeType`\[]

Returns [#returns-4]

`void`

***

allOpenedLabels [#allopenedlabels]

Get Signature [#get-signature-2]

\> **get** `static` **allOpenedLabels**(): `AllOpenedLabelsType`

Defined in: [src/narration/NarrationManagerStatic.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L34)

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 [#returns-5]

`AllOpenedLabelsType`

Set Signature [#set-signature-1]

\> **set** `static` **allOpenedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L42)

Parameters [#parameters-3]

value [#value-1]

`AllOpenedLabelsType`

Returns [#returns-6]

`void`

***

currentLabelId [#currentlabelid]

Get Signature [#get-signature-3]

\> **get** `static` **currentLabelId**(): `string` | `undefined`

Defined in: [src/narration/NarrationManagerStatic.ts:231](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L231)

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

Returns [#returns-7]

`string` | `undefined`

***

currentLabelStepIndex [#currentlabelstepindex]

Get Signature [#get-signature-4]

\> **get** `static` **currentLabelStepIndex**(): `number` | `null`

Defined in: [src/narration/NarrationManagerStatic.ts:241](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L241)

Returns [#returns-8]

`number` | `null`

***

onStepStart [#onstepstart]

Get Signature [#get-signature-5]

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

Defined in: [src/narration/NarrationManagerStatic.ts:342](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L342)

Returns [#returns-9]

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

Set Signature [#set-signature-2]

\> **set** `static` **onStepStart**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:336](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L336)

Parameters [#parameters-4]

value [#value-2]

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

Returns [#returns-10]

`void`

***

openedLabels [#openedlabels]

Get Signature [#get-signature-6]

\> **get** `static` **openedLabels**(): [`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/NarrationManagerStatic.ts:209](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L209)

Returns [#returns-11]

[`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Set Signature [#set-signature-3]

\> **set** `static` **openedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:212](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L212)

Parameters [#parameters-5]

value [#value-3]

[`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Returns [#returns-12]

`void`

***

originalOpenedLabels [#originalopenedlabels]

Get Signature [#get-signature-7]

\> **get** `static` **originalOpenedLabels**(): [`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Defined in: [src/narration/NarrationManagerStatic.ts:216](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L216)

Returns [#returns-13]

[`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Set Signature [#set-signature-4]

\> **set** `static` **originalOpenedLabels**(`value`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:219](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L219)

Parameters [#parameters-6]

value [#value-4]

[`OpenedLabel`](/jsdoc/pixi-vn/index/interfaces/OpenedLabel)\[]

Returns [#returns-14]

`void`

Methods [#methods]

addChoicesMade() [#addchoicesmade]

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

Defined in: [src/narration/NarrationManagerStatic.ts:268](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L268)

Parameters [#parameters-7]

label [#label-2]

`string`

stepIndex [#stepindex]

`number`

stepSha [#stepsha]

`string`

choiceMade [#choicemade]

`number`

Returns [#returns-15]

`void`

***

addLabelHistory() [#addlabelhistory]

\> `static` **addLabelHistory**(`label`, `stepIndex`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:259](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L259)

Add a label to the history.

Parameters [#parameters-8]

label [#label-3]

`string`

The label to add to the history.

stepIndex [#stepindex-1]

`number`

The step index of the label.

Returns [#returns-16]

`void`

***

getCurrentStepTimesCounter() [#getcurrentsteptimescounter]

\> `static` **getCurrentStepTimesCounter**(`nestedId?`): `number`

Defined in: [src/narration/NarrationManagerStatic.ts:109](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L109)

Parameters [#parameters-9]

nestedId? [#nestedid]

`string` = `""`

Returns [#returns-17]

`number`

***

getCurrentStepTimesCounterData() [#getcurrentsteptimescounterdata]

\> `static` **getCurrentStepTimesCounterData**(`nestedId?`): `CurrentStepTimesCounterMemotyData` | `null`

Defined in: [src/narration/NarrationManagerStatic.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L49)

Parameters [#parameters-10]

nestedId? [#nestedid-1]

`string` = `""`

Returns [#returns-18]

`CurrentStepTimesCounterMemotyData` | `null`

***

getRandomNumber() [#getrandomnumber]

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

Defined in: [src/narration/NarrationManagerStatic.ts:125](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L125)

Parameters [#parameters-11]

min [#min]

`number`

max [#max]

`number`

options? [#options]

nestedId? [#nestedid-2]

`string`

onceOnly? [#onceonly]

`boolean`

Returns [#returns-19]

`number` | `undefined`

***

increaseCurrentStepIndex() [#increasecurrentstepindex]

\> `static` **increaseCurrentStepIndex**(): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:318](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L318)

Increase the current step index of the current label.

Returns [#returns-20]

`void`

***

increaseStepCounter() [#increasestepcounter]

\> `static` **increaseStepCounter**(): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:205](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L205)

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

Returns [#returns-21]

`void`

***

pushNewLabel() [#pushnewlabel]

\> `static` **pushNewLabel**(`label`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:300](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L300)

Add a label to the history.

Parameters [#parameters-12]

label [#label-4]

`string`

The label to add to the history.

Returns [#returns-22]

`void`

Throws [#throws]

when the label is not found in the registered labels.

***

resetCurrentStepTimesCounter() [#resetcurrentsteptimescounter]

\> `static` **resetCurrentStepTimesCounter**(`nestedId?`): `void`

Defined in: [src/narration/NarrationManagerStatic.ts:160](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/narration/NarrationManagerStatic.ts#L160)

Parameters [#parameters-13]

nestedId? [#nestedid-3]

`string` = `""`

Returns [#returns-23]

`void`