Skip to main content

Interface: CountdownSceneOptions

Extends​

  • SceneOptions

Properties​

alpha?​

optional alpha: number

Opacity of the node. 0 is fully transparent, 1 is fully opaque. Default is 1.0. Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's is alpha .4, then the node will appear with alpha .2.

Inherited from​

SceneOptions.alpha

Source​

core/dist/index.d.ts:100

anchorPoint?​

optional anchorPoint: Point

Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position

Inherited from​

SceneOptions.anchorPoint

Source​

core/dist/index.d.ts:43

backgroundColor?​

optional backgroundColor: RgbaColor

Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.White)

Inherited from​

SceneOptions.backgroundColor

Source​

core/dist/index.d.ts:401

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

SceneOptions.draggable

Source​

core/dist/index.d.ts:106

hidden?​

optional hidden: boolean

Is the node, and its children, hidden? (not displayed). Default is false

Inherited from​

SceneOptions.hidden

Source​

core/dist/index.d.ts:108

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

Does the node respond to user events, such as taps? Default is false

Inherited from​

SceneOptions.isUserInteractionEnabled

Source​

core/dist/index.d.ts:104

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

SceneOptions.layout

Source​

core/dist/index.d.ts:110

milliseconds​

milliseconds: number

Duration of the countdown, in milliseconds.

Source​

addons/src/scenes/countdown-scene.ts:20

name?​

optional name: string

Name of the node. Only needed if the node will be referred to by name in a later function

Inherited from​

SceneOptions.name

Source​

core/dist/index.d.ts:94

position?​

optional position: Point

Position of the node within its parent coordinate system. Default is (0, 0)

Inherited from​

SceneOptions.position

Source​

core/dist/index.d.ts:96

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

SceneOptions.scale

Source​

core/dist/index.d.ts:98

shapeVerticalBias?​

optional shapeVerticalBias: number

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

Source​

addons/src/scenes/countdown-scene.ts:48

suppressEvents?​

optional suppressEvents: boolean

Should the node not emit events to the EventStore? Default is false.

Remarks​

This property is for use by authors of Composite nodes. It is not intended for general use.

Inherited from​

SceneOptions.suppressEvents

Source​

core/dist/index.d.ts:115

text?​

optional text: string

Text shown below the countdown shape. Default is "GET READY".

Source​

addons/src/scenes/countdown-scene.ts:28

textFontColor?​

optional textFontColor: RgbaColor

Font color for text. Default is black.

Source​

addons/src/scenes/countdown-scene.ts:34

textFontName?​

optional textFontName: string

Font name for text

Source​

addons/src/scenes/countdown-scene.ts:30

textFontSize?​

optional textFontSize: number

Font size for text. Default is 50.

Source​

addons/src/scenes/countdown-scene.ts:32

textMarginTop?​

optional textMarginTop: number

Distance between bottom of countdown shape and text. Default is 32.

Source​

addons/src/scenes/countdown-scene.ts:36

timerNumbersFontColor?​

optional timerNumbersFontColor: RgbaColor

Font size for timer numbers. Default is white.

Source​

addons/src/scenes/countdown-scene.ts:42

timerNumbersFontName?​

optional timerNumbersFontName: string

Font name for timer numbers.

Source​

addons/src/scenes/countdown-scene.ts:38

timerNumbersFontSize?​

optional timerNumbersFontSize: number

Font size for timer numbers. Default is 50.

Source​

addons/src/scenes/countdown-scene.ts:40

timerShape?​

optional timerShape: TimerShape

Shape of the timer. Default is a Royal Blue circle with a radius of 100 centered vertically.

Source​

addons/src/scenes/countdown-scene.ts:46

transition?​

optional transition: Transition

A custom transition to use to present next scene after the countdown completes.

Source​

addons/src/scenes/countdown-scene.ts:24

transitionDurationMilliseconds?​

optional transitionDurationMilliseconds: number

Duration of the slide transition, in milliseconds, to the next scene after the countdown completes. Default is 500.

Source​

addons/src/scenes/countdown-scene.ts:22

uuid?​

Internal

optional uuid: string

Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only

Inherited from​

SceneOptions.uuid

Source​

core/dist/index.d.ts:112

zPosition?​

optional zPosition: number

Value along the z-axis to determine drawing and tap order. Larger values are on top.

Inherited from​

SceneOptions.zPosition

Source​

core/dist/index.d.ts:45

zRotation?​

optional zRotation: number

Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.

Inherited from​

SceneOptions.zRotation

Source​

core/dist/index.d.ts:102

zeroDwellMilliseconds?​

optional zeroDwellMilliseconds: number

Duration in milliseconds to stay on zero before transitioning to the next scene. Default is zero. This option should be used if transition is set to Transition.none(). Otherwise, the zero will flash for a single frame before presenting the next scene.

Source​

addons/src/scenes/countdown-scene.ts:26

zeroString?​

optional zeroString: string

String to show when the timer reaches zero. Default is "0". This could be changed to another value, such as "GO!"

Source​

addons/src/scenes/countdown-scene.ts:44