Pixi’VNInterface: Ticker<TArgs>
Defined in: src/canvas/tickers/interfaces/Ticker.ts:5
Type Parameters
TArgs
TArgs extends TickerArgs
Properties
alias
> readonly alias: string
Defined in: src/canvas/tickers/interfaces/Ticker.ts:21
Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, RegisteredTickers.getInstance
args
> args: TArgs
Defined in: src/canvas/tickers/interfaces/Ticker.ts:9
Arguments to pass to the ticker
canvasElementAliases
> canvasElementAliases: string[]
Defined in: src/canvas/tickers/interfaces/Ticker.ts:29
The aliases of the canvas elements that are connected to this ticker
complete
> complete: (options?) => void | Promise<void>
Defined in: src/canvas/tickers/interfaces/Ticker.ts:33
Completes the animation and applies the final state.
Parameters
options?
ignoreTickerSteps?
boolean
Returns
void | Promise<void>
duration?
> optional duration?: number
Defined in: src/canvas/tickers/interfaces/Ticker.ts:13
Duration in seconds to run the ticker
id
> readonly id: string
Defined in: src/canvas/tickers/interfaces/Ticker.ts:25
The id of the ticker. Must be unique for each ticker instance.
pause
> pause: () => void
Defined in: src/canvas/tickers/interfaces/Ticker.ts:45
Pauses the animation.
Returns
void
paused
> readonly paused: boolean
Defined in: src/canvas/tickers/interfaces/Ticker.ts:54
Checks if the ticker is paused.
Returns
true if the ticker is paused, false otherwise.
play
> play: () => void
Defined in: src/canvas/tickers/interfaces/Ticker.ts:49
Plays the animation.
Returns
void
priority?
> optional priority?: UPDATE_PRIORITY
Defined in: src/canvas/tickers/interfaces/Ticker.ts:17
Priority of the ticker
start
> start: () => void
Defined in: src/canvas/tickers/interfaces/Ticker.ts:41
Starts the ticker. This will start the ticker and begin the animation.
Returns
void
stop
> stop: () => void
Defined in: src/canvas/tickers/interfaces/Ticker.ts:37
Stops the animation at its current state, and prevents it from resuming when the animation is played again.
Returns
void