Type Alias: CommonTickerProps

> CommonTickerProps = object

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:2

Properties

aliasToRemoveAfter?

> optional aliasToRemoveAfter?: string[] | string

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:7

An array of strings containing the aliases of the canvas components to remove after the animation completes.

Default

[]

completeOnContinue?

> optional completeOnContinue?: boolean

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:32

A boolean indicating whether the animation must complete before the next step of the game. If true, the game will force the animation to finish before proceeding. When true, calling () forces the current content to complete before advancing to the next narrative step.

Default

false

forceCompleteBeforeNext?

> optional forceCompleteBeforeNext?: boolean

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:26

Deprecated

Use completeOnContinue instead.

startOnlyIfHaveTexture?

> optional startOnlyIfHaveTexture?: boolean

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:12

If true, the effect only starts if the canvas element have a texture

Default

false

tickerAliasToResume?

> optional tickerAliasToResume?: string[] | string

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:17

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

Default

[]

tickerIdToResume?

> optional tickerIdToResume?: string[] | string

Defined in: src/canvas/tickers/types/CommonTickerProps.ts:22

A string containing the ticker ID to resume after the animation completes.

Default

[]