Class createjs.Ticker

Extends .

Defined in: ticker.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	createjs.Ticker() A singleton class that provides a tick.

Field Summary
Field Attributes	Field Name and Description
<static>	createjs.Ticker.AUTO The mode representing the Ticker object chooses the best API for it.
<static>	createjs.Ticker.cancelAnimationFrame The cancelAnimationFrame() method used by the createjs.Ticker object.
<static>	createjs.Ticker.exports A table of exported functions.
	initialized_ Whether this ticker has been initialized.
	interval_ The interrupt interval for calling the 'tick_()' method repeatedly in milliseconds.
	lastTime_ The last time when this ticker has dispatched tick events.
	paused_ Whether this ticker is not running now.
	pausedTime_ The total period of time that this ticker stops dispatching tick events.
<static>	createjs.Ticker.RAF Represents the mode that the Ticker object uses the requestAnimationFrame API without synchronization to the target frame-rate.
<static>	createjs.Ticker.RAF_SYNCHED Represents the mode that the Ticker object uses the requestAnimationFrame API with synchronization to the target frame-rate.
<static>	createjs.Ticker.requestAnimationFrame The requestAnimationFrame() method used by the createjs.Ticker object.
<static>	createjs.Ticker.RETRY The maximum number of times to measure animation intervals.
	startTime_ The time when this ticker starts dispatching tick events.
<static>	createjs.Ticker.TIMEOUT The mode representing the Ticker object uses the setTimeout API.
	timerId_ Stores the timeout or requestAnimationFrame id.
	times_ The list of times when this ticker has dispatched tick events.
	useRAF_ True if currently using requestAnimationFrame, false if using setTimeout.

Method Summary
Method Attributes	Method Name and Description
<static>	createjs.Ticker.addListener(type, listener, opt_useCapture) Adds an event listener.
<static>	createjs.Ticker.dispatch(event, opt_target) Dispatches the specified event to all listeners.
<static>	createjs.Ticker.getEvent_(delta, paused, time, runTime) Returns the instance of the createjs.Ticker object.
<static>	createjs.Ticker.getEventTime(opt_runTime) Returns the last tick time.
<static>	createjs.Ticker.getFPS() Returns the target frame-rate in frames per second (FPS).
<static>	createjs.Ticker.getFrames() Returns the time elapsed since the last tick in frames.
<static>	createjs.Ticker.getInstance_() Returns the instance of the createjs.Ticker object.
<static>	createjs.Ticker.getInterval() Returns the current tick interval.
<static>	createjs.Ticker.getMeasuredFPS(opt_ticks) Returns the actual frames per second.
<static>	createjs.Ticker.getMeasuredTickTime(opt_ticks) Returns the average time spent within a tick.
<static>	createjs.Ticker.getPaused() Returns whether the Ticker object is paused.
<static>	createjs.Ticker.getRunTime() Returns the last time when this object dispatches a tick event.
<static>	createjs.Ticker.getTicks(pauseable) Returns the number of ticks that have been broadcast by Ticker.
<static>	createjs.Ticker.hasListener(type) Returns whether there is at least one listener for the specified event type.
<static>	createjs.Ticker.kick() Kicks the global ticker.
<static>	createjs.Ticker.removeAllListeners(opt_type) Removes all listeners for the specified type, or all listeners of all types.
<static>	createjs.Ticker.removeListener(type, listener, opt_useCapture) Removes the specified event listener.
<static>	createjs.Ticker.reset(opt_destroy) Stops the global ticker and removes all listeners.
<static>	createjs.Ticker.setFPS(value, opt_noClip) Sets the target frame-rate in frames per second (FPS).
<static>	createjs.Ticker.setInterval(interval) Sets the tick interval (in milliseconds).
<static>	createjs.Ticker.setPaused(value) Starts the Ticker object or stops it.

Class Detail

createjs.Ticker()

A singleton class that provides a tick.

Field Detail

<static> createjs.Ticker.AUTO

The mode representing the Ticker object chooses the best API for it.

<static> createjs.Ticker.cancelAnimationFrame

The cancelAnimationFrame() method used by the createjs.Ticker object.

<static> createjs.Ticker.exports

A table of exported functions.

initialized_

Whether this ticker has been initialized. (This does not mean the ticker is currently running or not.)

interval_

The interrupt interval for calling the 'tick_()' method repeatedly in milliseconds.

lastTime_

The last time when this ticker has dispatched tick events.

paused_

Whether this ticker is not running now.

pausedTime_

The total period of time that this ticker stops dispatching tick events.

<static> createjs.Ticker.RAF

Represents the mode that the Ticker object uses the requestAnimationFrame API without synchronization to the target frame-rate.

<static> createjs.Ticker.RAF_SYNCHED

Represents the mode that the Ticker object uses the requestAnimationFrame API with synchronization to the target frame-rate.

<static> createjs.Ticker.requestAnimationFrame

The requestAnimationFrame() method used by the createjs.Ticker object.

<static> createjs.Ticker.RETRY

The maximum number of times to measure animation intervals.

startTime_

The time when this ticker starts dispatching tick events.

<static> createjs.Ticker.TIMEOUT

The mode representing the Ticker object uses the setTimeout API.

timerId_

Stores the timeout or requestAnimationFrame id.

times_

The list of times when this ticker has dispatched tick events.

useRAF_

True if currently using requestAnimationFrame, false if using setTimeout.

Method Detail

<static> {Function|Object} createjs.Ticker.addListener(type, listener, opt_useCapture)

Adds an event listener.

Parameters:
{string} type
{Function|Object} listener
{boolean=} opt_useCapture

Returns:: {Function|Object}

<static> {boolean} createjs.Ticker.dispatch(event, opt_target)

Dispatches the specified event to all listeners.

Parameters:
{Object|string|Event} event
{Object=} opt_target

Returns:: {boolean}

<static> {createjs.TickEvent} createjs.Ticker.getEvent_(delta, paused, time, runTime)

Returns the instance of the createjs.Ticker object.

Parameters:
{number} delta
{boolean} paused
{number} time
{number} runTime

Returns:: {createjs.TickEvent}

<static> {number} createjs.Ticker.getEventTime(opt_runTime)

Returns the last tick time.

Parameters:
{boolean=} opt_runTime

Returns:: {number}

<static> {number} createjs.Ticker.getFPS()

Returns the target frame-rate in frames per second (FPS).

Returns:: {number}

<static> {number} createjs.Ticker.getFrames()

Returns the time elapsed since the last tick in frames.

Returns:: {number}

<static> {createjs.Ticker} createjs.Ticker.getInstance_()

Returns the instance of the createjs.Ticker object.

Returns:: {createjs.Ticker}

<static> {number} createjs.Ticker.getInterval()

Returns the current tick interval.

Returns:: {number}

<static> {number} createjs.Ticker.getMeasuredFPS(opt_ticks)

Returns the actual frames per second.

Parameters:
{number=} opt_ticks

Returns:: {number}

<static> {number} createjs.Ticker.getMeasuredTickTime(opt_ticks)

Returns the average time spent within a tick.

Parameters:
{number=} opt_ticks

Returns:: {number}

<static> {boolean} createjs.Ticker.getPaused()

Returns whether the Ticker object is paused.

Returns:: {boolean}

<static> {number} createjs.Ticker.getRunTime()

Returns the last time when this object dispatches a tick event.

Returns:: {number}

<static> {number} createjs.Ticker.getTicks(pauseable)

Returns the number of ticks that have been broadcast by Ticker.

Parameters:
{boolean} pauseable

Returns:: {number}

<static> {boolean} createjs.Ticker.hasListener(type)

Returns whether there is at least one listener for the specified event type.

Parameters:
{string} type

Returns:: {boolean}

<static> createjs.Ticker.kick()

Kicks the global ticker. This method explicitly calls the setInterval() callback added by the ticker if it uses the setInterval() method. (This is a workaround for Android Chrome, which does not call setInterval() callbacks while it dispatches touch events.)

<static> createjs.Ticker.removeAllListeners(opt_type)

Removes all listeners for the specified type, or all listeners of all types.

Parameters:
{string=} opt_type

<static> createjs.Ticker.removeListener(type, listener, opt_useCapture)

Removes the specified event listener.

Parameters:
{string} type
{Function|Object} listener
{boolean=} opt_useCapture

<static> createjs.Ticker.reset(opt_destroy)

Stops the global ticker and removes all listeners.

Parameters:
{boolean=} opt_destroy

<static> createjs.Ticker.setFPS(value, opt_noClip)

Sets the target frame-rate in frames per second (FPS).

Parameters:
{number} value
{boolean=} opt_noClip

<static> createjs.Ticker.setInterval(interval)

Sets the tick interval (in milliseconds).

Parameters:
{number} interval

<static> createjs.Ticker.setPaused(value)

Starts the Ticker object or stops it.

Parameters:
{boolean} value

Classes

Class createjs.Ticker