Skip to main content

Interface: InstructionScene

Properties​

backButtonBackgroundColor?​

optional backButtonBackgroundColor: RgbaColor

Color of back button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:73

backButtonFontColor?​

optional backButtonFontColor: RgbaColor

Color of back button text. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:75

backButtonHeight?​

optional backButtonHeight: number

Height of back button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:69

backButtonText?​

optional backButtonText: string

Button text for the back button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:57

backButtonTextInterpolation?​

optional backButtonTextInterpolation: StringInterpolationMap

Interpolation for back button text

Source​

addons/src/stories/instructions.ts:59

backButtonWidth?​

optional backButtonWidth: number

Width of back button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:65

backSceneTransition?​

optional backSceneTransition: Transition

Scene transition when returning to the previous instruction scene. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:83

backgroundColor?​

optional backgroundColor: RgbaColor

Background color for instruction scene. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:55

imageAboveText?​

optional imageAboveText: boolean

If an image is provided, should it appear above the primary text? Default is true

Source​

addons/src/stories/instructions.ts:53

imageMarginBottom?​

optional imageMarginBottom: number

If the image appears above the primary instruction text (imageAboveText = true), this is the margin from the bottom of the image to the top of the primary instruction text

Source​

addons/src/stories/instructions.ts:51

imageMarginTop?​

optional imageMarginTop: number

If the image appears below the primary instruction text (imageAboveText = false), this is the margin from the bottom of the primary instruction text to the top of the image

Source​

addons/src/stories/instructions.ts:49

imageName?​

optional imageName: string

Name of optional image to show

Source​

addons/src/stories/instructions.ts:45

imageVerticalBias?​

optional imageVerticalBias: number

Default is to center image vertically within the scene (imageVerticalBias = .5). Setting imageVerticalBias less than .5 will pull the image towards the top. Setting imageVerticalBias greater than .5 will pull the image towards the bottom

Source​

addons/src/stories/instructions.ts:47

nextButtonBackgroundColor?​

optional nextButtonBackgroundColor: RgbaColor

Color of next button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:77

nextButtonFontColor?​

optional nextButtonFontColor: RgbaColor

Color of next button text. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:79

nextButtonHeight?​

optional nextButtonHeight: number

Height of next button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:71

nextButtonText?​

optional nextButtonText: string

Button text for the next button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:61

nextButtonTextInterpolation?​

optional nextButtonTextInterpolation: StringInterpolationMap

Interpolation map for next button text

Source​

addons/src/stories/instructions.ts:63

nextButtonWidth?​

optional nextButtonWidth: number

Width of next button. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:67

nextSceneTransition?​

optional nextSceneTransition: Transition

Scene transition when advancing to the next instruction scene. Will override what is set in InstructionsOptions

Source​

addons/src/stories/instructions.ts:81

text?​

optional text: string

Primary instruction text

Source​

addons/src/stories/instructions.ts:23

textAlignmentMode?​

optional textAlignmentMode: LabelHorizontalAlignmentMode

Horizontal alignment of primary instruction text. see LabelHorizontalAlignmentMode. Default is LabelHorizontalAlignmentMode.left.

Source​

addons/src/stories/instructions.ts:31

textFontSize?​

optional textFontSize: number

Font size of primary instruction text. Default is 16

Source​

addons/src/stories/instructions.ts:35

textInterpolation?​

optional textInterpolation: StringInterpolationMap

Interpolation for text

Source​

addons/src/stories/instructions.ts:25

textMarginEnd?​

optional textMarginEnd: number

Margin from right to primary instruction text. Default is 48

Source​

addons/src/stories/instructions.ts:29

textMarginStart?​

optional textMarginStart: number

Margin from left screen edge to primary instruction text. Default is 48

Source​

addons/src/stories/instructions.ts:27

textVerticalBias?​

optional textVerticalBias: number

Default is to center primary instructions vertically within the scene (textVerticalBias = .5). Setting textVerticalBias less than .5 will pull the text towards the top. Setting textVerticalBias greater than .5 will pull the text towards the bottom

Source​

addons/src/stories/instructions.ts:33

title?​

optional title: string

A text heading to appear at the top of the scene

Source​

addons/src/stories/instructions.ts:37

titleFontSize?​

optional titleFontSize: number

Font size of title text. Default is 16

Source​

addons/src/stories/instructions.ts:43

titleInterpolation?​

optional titleInterpolation: StringInterpolationMap

Interpolation for title

Source​

addons/src/stories/instructions.ts:39

titleMarginTop?​

optional titleMarginTop: number

Margin from top of screen edge to title text. Default is 48

Source​

addons/src/stories/instructions.ts:41