LogoPixi’VN
indexInterfaces

Interface: ChoiceOptionInterface

Defined in: src/narration/interfaces/StoredChoiceInterface.ts:6

Extends

  • Omit<ChoiceInterface, "label" | "type" | "closeCurrentLabel">

Properties

autoSelect?

> optional autoSelect?: boolean

Defined in: src/pixi-vn.d.ts:65

If this is true and if is the only choice, it will be automatically selected, and call/jump to the label.

Inherited from

Omit.autoSelect


label

> label: string

Defined in: src/narration/interfaces/StoredChoiceInterface.ts:11

Label Id to be opened when the option is selected


oneTime?

> optional oneTime?: boolean

Defined in: src/pixi-vn.d.ts:57

If this is true, the choice can only be made once.

Inherited from

Omit.oneTime


onlyHaveNoChoice?

> optional onlyHaveNoChoice?: boolean

Defined in: src/pixi-vn.d.ts:61

If this is true, the choice can see only if there are no other choices. For example, all choices are one-time choices and they are already selected.

Inherited from

Omit.onlyHaveNoChoice


props?

> optional props?: any

Defined in: src/pixi-vn.d.ts:73

Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.

Inherited from

Omit.props


text

> text: string | string[]

Defined in: src/pixi-vn.d.ts:45

Text to be displayed in the menu

Inherited from

Omit.text


type

> type: LabelRunModeType

Defined in: src/narration/interfaces/StoredChoiceInterface.ts:15

Type of the label to be opened