API Reference / Tween

# Class: Tween

# Hierarchy

EventEmitter

↳ Tween

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

# Constructors

# constructor

• Protected new Tween(target, option?)

# Parameters

Name	Type
`target`	`Layer`
`option?`	`TweenOption`

# Overrides

EventEmitter.constructor

# Defined in

tween/Tween.ts:20 (opens new window)

# Properties

# $boundOnEnterFrame

• Protected $boundOnEnterFrame: () => void

# Type declaration

▸ (): void

# Returns

void

# Defined in

tween/Tween.ts:18 (opens new window)

# $emittingType

• Protected $emittingType: string = null

# Inherited from

EventEmitter.$emittingType

# Defined in

event/EventEmitter.ts:6 (opens new window)

# $events

• Protected $events: Object = {}

# Inherited from

EventEmitter.$events

# Defined in

event/EventEmitter.ts:5 (opens new window)

# $paused

• Protected $paused: boolean = true

# Defined in

tween/Tween.ts:11 (opens new window)

# $removedListeners

• Protected $removedListeners: Listener[] = []

# Inherited from

EventEmitter.$removedListeners

# Defined in

event/EventEmitter.ts:7 (opens new window)

# $shouldSaveProps

• Protected $shouldSaveProps: boolean = true

# Defined in

tween/Tween.ts:17 (opens new window)

# $stepIndex

• Protected $stepIndex: number = 0

# Defined in

tween/Tween.ts:13 (opens new window)

# $stepPosition

• Protected $stepPosition: number = 0

# Defined in

tween/Tween.ts:14 (opens new window)

# $stepProps

• Protected $stepProps: Object[] = []

# Defined in

tween/Tween.ts:16 (opens new window)

# $steps

• Protected $steps: TweenStep[] = []

# Defined in

tween/Tween.ts:15 (opens new window)

# $stopped

• Protected $stopped: boolean = true

# Defined in

tween/Tween.ts:12 (opens new window)

# $target

• Protected $target: Layer = null

# Defined in

tween/Tween.ts:10 (opens new window)

# loop

• loop: boolean = false

# Defined in

tween/Tween.ts:8 (opens new window)

# $tweens

▪ Static Protected Readonly $tweens: Tween[] = []

# Defined in

tween/Tween.ts:181 (opens new window)

# Accessors

# paused

• get paused(): boolean

# Returns

boolean

# Defined in

tween/Tween.ts:27 (opens new window)

# stopped

• get stopped(): boolean

# Returns

boolean

# Defined in

tween/Tween.ts:31 (opens new window)

# Methods

# $easeProps

▸ Protected $easeProps(stepIndex, props, position, duration, ease): void

# Parameters

Name	Type
`stepIndex`	`number`
`props`	`Object`
`position`	`number`
`duration`	`number`
`ease`	`Function`

# Returns

void

# Defined in

tween/Tween.ts:158 (opens new window)

# $nextFrame

▸ Protected $nextFrame(dt): void

# Parameters

Name	Type
`dt`	`number`

# Returns

void

# Defined in

tween/Tween.ts:106 (opens new window)

# $onEnterFrame

▸ Protected $onEnterFrame(e): void

# Parameters

Name	Type
`e`	`Event`

# Returns

void

# Defined in

tween/Tween.ts:102 (opens new window)

# $saveOriginalProps

▸ Protected $saveOriginalProps(stepIndex, props): void

# Parameters

Name	Type
`stepIndex`	`number`
`props`	`Object`

# Returns

void

# Defined in

tween/Tween.ts:148 (opens new window)

# $setProps

▸ Protected $setProps(props): void

# Parameters

Name	Type
`props`	`Object`

# Returns

void

# Defined in

tween/Tween.ts:174 (opens new window)

# call

▸ call(callback): Tween

# Parameters

Name	Type
`callback`	`Function`

# Returns

Tween

# Defined in

tween/Tween.ts:61 (opens new window)

# emit

▸ emit(event): boolean

# Parameters

Name	Type
`event`	`Event`

# Returns

boolean

# Inherited from

EventEmitter.emit

# Defined in

event/EventEmitter.ts:42 (opens new window)

▸ emit(type, ...args): boolean

# Parameters

Name	Type
`type`	`string`
`...args`	`any`[]

# Returns

boolean

# Inherited from

EventEmitter.emit

# Defined in

event/EventEmitter.ts:43 (opens new window)

# hasEventListener

▸ hasEventListener(type): boolean

# Parameters

Name	Type
`type`	`string`

# Returns

boolean

# Inherited from

EventEmitter.hasEventListener

# Defined in

event/EventEmitter.ts:80 (opens new window)

# off

▸ off(type, listener?): Tween

# Parameters

Name	Type
`type`	`string`
`listener?`	`Listener`

# on

▸ on(type, listener): Tween

# Parameters

Name	Type
`type`	`string`
`listener`	`Listener`

# Returns

Tween

# Inherited from

EventEmitter.on

# Defined in

event/EventEmitter.ts:9 (opens new window)

# once

▸ once(type, listener): Tween

# Parameters

Name	Type
`type`	`string`
`listener`	`Listener`

# Returns

Tween

# Inherited from

EventEmitter.once

# Defined in

event/EventEmitter.ts:33 (opens new window)

# pause

▸ pause(): Tween

# Returns

Tween

# Defined in

tween/Tween.ts:77 (opens new window)

# play

▸ play(): Tween

# Returns

Tween

# Defined in

tween/Tween.ts:69 (opens new window)

# removeAllListeners

▸ removeAllListeners(): Tween

# Returns

Tween

# Inherited from

EventEmitter.removeAllListeners

# Defined in

event/EventEmitter.ts:85 (opens new window)

# resume

▸ resume(): Tween

# Returns

Tween

# Defined in

tween/Tween.ts:83 (opens new window)

# set

▸ set(props): Tween

# Parameters

Name	Type
`props`	`Object`

# Returns

Tween

# Defined in

tween/Tween.ts:35 (opens new window)

# stop

▸ stop(): Tween

# Returns

Tween

# Defined in

tween/Tween.ts:92 (opens new window)

# to

▸ to(props, duration, ease?): Tween

# Parameters

Name	Type
`props`	`Object`
`duration`	`number`
`ease?`	`Function`

# Returns

Tween

# Defined in

tween/Tween.ts:43 (opens new window)

# wait

▸ wait(duration): Tween

# Parameters

Name	Type
`duration`	`number`

# Returns

Tween

# Defined in

tween/Tween.ts:53 (opens new window)

# get

▸ Static get(target, option?): Tween

# Parameters

Name	Type
`target`	`Layer`
`option?`	`Object`
`option.loop?`	`boolean`

# Returns

Tween

# Defined in

tween/Tween.ts:183 (opens new window)

# pauseTweens

▸ Static pauseTweens(target): void

# Parameters

Name	Type
`target`	`Layer`

# Returns

void

# Defined in

tween/Tween.ts:187 (opens new window)

# removeAllTweens

▸ Static removeAllTweens(): void

# Returns

void

# Defined in

tween/Tween.ts:215 (opens new window)

# removeTweens

▸ Static removeTweens(target): void

# Parameters

Name	Type
`target`	`Layer`

# Returns

void

# Defined in

tween/Tween.ts:205 (opens new window)

# resumeTweens

▸ Static resumeTweens(target): void

# Parameters

Name	Type
`target`	`Layer`

# Returns

void

# Defined in

tween/Tween.ts:196 (opens new window)