# Interface: Ticker<TArgs> (/jsdoc/pixi-vn/index/interfaces/Ticker)



Defined in: [src/canvas/tickers/interfaces/Ticker.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L5)

Type Parameters [#type-parameters]

TArgs [#targs]

`TArgs` *extends* [`TickerArgs`](/jsdoc/pixi-vn/index/interfaces/TickerArgs)

Properties [#properties]

alias [#alias]

\> `readonly` **alias**: `string`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L21)

Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, [RegisteredTickers.getInstance](/jsdoc/pixi-vn/index/namespaces/RegisteredTickers/functions/getInstance)

***

args [#args]

\> **args**: `TArgs`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:9](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L9)

Arguments to pass to the ticker

***

canvasElementAliases [#canvaselementaliases]

\> **canvasElementAliases**: `string`\[]

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:29](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L29)

The aliases of the canvas elements that are connected to this ticker

***

complete [#complete]

\> **complete**: (`options?`) => `void` | `Promise`\<`void`>

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L33)

Completes the animation and applies the final state.

Parameters [#parameters]

options? [#options]

ignoreTickerSteps? [#ignoretickersteps]

`boolean`

Returns [#returns]

`void` | `Promise`\<`void`>

***

duration? [#duration]

\> `optional` &#x2A;*duration?**: `number`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L13)

Duration in seconds to run the ticker

***

id [#id]

\> `readonly` **id**: `string`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:25](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L25)

The id of the ticker. Must be unique for each ticker instance.

***

pause [#pause]

\> **pause**: () => `void`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:45](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L45)

Pauses the animation.

Returns [#returns-1]

`void`

***

paused [#paused]

\> `readonly` **paused**: `boolean`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:54](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L54)

Checks if the ticker is paused.

Returns [#returns-2]

true if the ticker is paused, false otherwise.

***

play [#play]

\> **play**: () => `void`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:49](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L49)

Plays the animation.

Returns [#returns-3]

`void`

***

priority? [#priority]

\> `optional` &#x2A;*priority?**: `UPDATE_PRIORITY`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:17](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L17)

Priority of the ticker

***

start [#start]

\> **start**: () => `void`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:41](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L41)

Starts the ticker. This will start the ticker and begin the animation.

Returns [#returns-4]

`void`

***

stop [#stop]

\> **stop**: () => `void`

Defined in: [src/canvas/tickers/interfaces/Ticker.ts:37](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/canvas/tickers/interfaces/Ticker.ts#L37)

Stops the animation at its current state, and prevents it from resuming when the animation is played again.

Returns [#returns-5]

`void`