Pixi’VNType Alias: PixiVNJsonLabelStep
> PixiVNJsonLabelStep = object
Defined in: src/schema/PixiVNJsonLabelStep.ts:116
Steps of a label. Order of operations:
- run all PixiVNJsonLabelStep.operations
- set PixiVNJsonLabelStep.choices, PixiVNJsonLabelStep.dialogue, PixiVNJsonLabelStep.glueEnabled
- open PixiVNJsonLabelStep.labelToOpen
- go to next step if PixiVNJsonLabelStep.goNextStep is true
- end the label if PixiVNJsonLabelStep.end is "label_end"
Properties
choices?
> optional choices?: PixiVNJsonChoices | PixiVNJsonConditionalStatements<PixiVNJsonChoices>
Defined in: src/schema/PixiVNJsonLabelStep.ts:124
Variable used to display a choice menu.
conditionalStep?
> optional conditionalStep?: PixiVNJsonConditionalStatements<PixiVNJsonLabelStep | PixiVNJsonLabelStep[]>
Defined in: src/schema/PixiVNJsonLabelStep.ts:157
If set, this step is replaced by the result of evaluating the given conditional statement. Allows an entire step to be chosen at runtime based on a condition or step-switch strategy.
dialogue?
> optional dialogue?: PixiVNJsonDialog<PixiVNJsonDialogText> | PixiVNJsonConditionalStatements<PixiVNJsonDialog<PixiVNJsonDialogText>>
Defined in: src/schema/PixiVNJsonLabelStep.ts:128
Variable used to display a dialog.
end?
> optional end?: "game_end" | "label_end" | PixiVNJsonConditionalStatements<"game_end" | "label_end">
Defined in: src/schema/PixiVNJsonLabelStep.ts:152
Variable used to end some elements of the narrative.
- game_end: ends the game
- label_end: ends the label
glueEnabled?
> optional glueEnabled?: boolean | PixiVNJsonConditionalStatements<boolean>
Defined in: src/schema/PixiVNJsonLabelStep.ts:135
This variable is used to add the next dialog text into the current dialog memory. This value was added to introduce Ink Glue functionality https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue
goNextStep?
> optional goNextStep?: boolean | PixiVNJsonConditionalStatements<boolean>
Defined in: src/schema/PixiVNJsonLabelStep.ts:146
If is true, the next step will be executed automatically.
labelToOpen?
> optional labelToOpen?: PixiVNJsonLabelToOpen | PixiVNJsonConditionalStatements<PixiVNJsonLabelToOpen> | (PixiVNJsonLabelToOpen | PixiVNJsonConditionalStatements<PixiVNJsonLabelToOpen>)[]
Defined in: src/schema/PixiVNJsonLabelStep.ts:139
Variable used to open a label.
operations?
> optional operations?: PixiVNJsonConditionalOperation[]
Defined in: src/schema/PixiVNJsonLabelStep.ts:120
Operations to execute at the start of this step (storage writes, canvas updates, sound, etc.).