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

The alias to remove after the effect is done

Default

[]

completeOnContinue?

> optional completeOnContinue?: boolean

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

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

The alias to resume after the effect is done

Default

[]

tickerIdToResume?

> optional tickerIdToResume?: string[] | string

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

The id of the ticker to resume after the effect is done

Default

[]