Class ATween

Copyright (c) 2022 amin2312
Version 1.0.0
MIT License

ATween is a easy, fast and tiny tween library.=

Hierarchy

ATween

Index

Constructors

constructor

new ATween(target: any): ATween

- Defined in ATween.ts:172
Constructor.

Parameters
- target: any
Returns ATween

Properties

elapsedMs

elapsedMs: number = 0

Elapsed time of tween(unit: millisecond).

elapsedPercentage

elapsedPercentage: number = 0

Elapsed percentage of tween.

Static stop

stop: boolean = false

Specifies whether to stop all tweens.

Methods

attach

attach(obj: string | HTMLElement, convert?: (curValue: number, startValue: number, endValue: number, percent: number, property: string) => any): ATween

- Defined in ATween.ts:531
Attach to HTMLElement element (The tween value will auto sync to this element).

Parameters
- obj: string | HTMLElement
  
  HTMLElement or element id
- convert: (curValue: number, startValue: number, endValue: number, percent: number, property: string) => any = null
  
  You can use it to convert the current value to its final form, e.g. convert "int" to "rgb"
  - - (curValue: number, startValue: number, endValue: number, percent: number, property: string): any
    - Parameters
      - curValue: number
      - startValue: number
      - endValue: number
      - percent: number
      - property: string
      Returns any
Returns ATween
Tween instance

callRepeat

callRepeat(): ATween

- Defined in ATween.ts:575
Calls the "onRepeat" function immediately(repeat times is 0).

remark
IF you need to init the environment, then it's a good choice.

Returns ATween
Tween instance

cancel

cancel(withComplete?: boolean): void

- Defined in ATween.ts:495
Cancel this tween.

Parameters
- withComplete: boolean = false
  
  Specifies whether to call complete function.
Returns void
Tween instance

data

data(v: any): ATween

- Defined in ATween.ts:549
Store arbitrary data associated with this tween.

Parameters
- v: any
Returns ATween

easing

easing(func: (v: number) => number): ATween

- Defined in ATween.ts:589
Set easing function.

Parameters
- func: (v: number) => number
  - - (v: number): number
    - Parameters
      - v: number
      Returns number
Returns ATween
Tween instance

getAttachment

getAttachment(): any

- Defined in ATween.ts:651
Get attachment.

Returns any

getData

getData(): any

- Defined in ATween.ts:658
Get data.

Returns any

getPause

getPause(): boolean

- Defined in ATween.ts:630
Get pause state.

Returns boolean

getRepeatTimes

getRepeatTimes(): number

- Defined in ATween.ts:637
Get repeat times.

Returns number

getTarget

getTarget(): any

- Defined in ATween.ts:644
Get target.

Returns any

isRetained

isRetained(): boolean

- Defined in ATween.ts:616
Indicates whether the tween is keeping.

Returns boolean
Tween instance

onCancel

onCancel(callback: () => void): ATween

- Defined in ATween.ts:698
Set the callback function when canceled.

Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns ATween
Tween instance

onComplete

onComplete(callback: (...argArray: any[]) => void, params?: any[]): ATween

- Defined in ATween.ts:684
Set the callback function when completion.

Parameters
- callback: (...argArray: any[]) => void
  - - (...argArray: any[]): void
    - Parameters
      - Rest ...argArray: any[]
      Returns void
- params: any[] = null
Returns ATween
Tween instance

onRepeat

onRepeat(callback: (steps: number) => boolean): ATween

- Defined in ATween.ts:709
Set the callback function when repeating.

remarks
if return FASLE, then will cancel this timer.

Parameters
- callback: (steps: number) => boolean
  - - (steps: number): boolean
    - Parameters
      - steps: number
      Returns boolean
Returns ATween
Tween instance

onStart

onStart(callback: () => void): ATween

- Defined in ATween.ts:666
Set the callback function when startup.

Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns ATween
Tween instance

onUpdate

onUpdate(callback: (percent: number, times: number) => void): ATween

- Defined in ATween.ts:675
Set the callback function when updating.

Parameters
- callback: (percent: number, times: number) => void
  - - (percent: number, times: number): void
    - Parameters
      - percent: number
      - times: number
      Returns void
Returns ATween
Tween instance

release

release(): ATween

- Defined in ATween.ts:607
Release this retained tween.

Returns ATween
Tween instance

repeat

repeat(times: number, yoyo?: boolean, delayMs?: number): ATween

- Defined in ATween.ts:561
Set repeat execution.

Parameters
- times: number
  
  the repeat times(-1 is infinity)
- yoyo: boolean = false
  
  where true causes the tween to go back and forth, alternating backward and forward on each repeat.
- delayMs: number = 0
  
  delay trigger time
Returns ATween
Tween instance

retain

retain(): ATween

- Defined in ATween.ts:598
Keep this tween, "killAll" has no effect on it.

Returns ATween
Tween instance

setPause

setPause(v: boolean): void

- Defined in ATween.ts:623
Set pause state.

Parameters
- v: boolean
Returns void

start

start(): ATween

- Defined in ATween.ts:266
Start the tween/timer.

Returns ATween
Tween instance

to

to(endValues: any): ATween

- Defined in ATween.ts:520
The destination values that the target wants to achieves.

Parameters
- endValues: any
  
  destination values.
Returns ATween
Tween instance

toAlpha

toAlpha(v: number): ATween

- Defined in ATween.ts:717
Simplified function for "to" - set alpha.

Parameters
- v: number
Returns ATween

toX

toX(v: number): ATween

- Defined in ATween.ts:724
Simplified function for "to" - set crood x.

Parameters
- v: number
Returns ATween

toXY

toXY(a: number, b: number): ATween

- Defined in ATween.ts:738
Simplified function for "to" - set crood x and y.

Parameters
- a: number
- b: number
Returns ATween

toY

toY(v: number): ATween

- Defined in ATween.ts:731
Simplified function for "to" - set crood y.

Parameters
- v: number
Returns ATween

update

update(ms: number): boolean

- Defined in ATween.ts:392
Update tween by the specified time.

Parameters
- ms: number
  
  millisecond unit
Returns boolean

Static isTweening

isTweening(targetOrAttachment: any): boolean

- Defined in ATween.ts:155
Check the target or attachment is tweening.

Parameters
- targetOrAttachment: any
  
  the target or attachment.
Returns boolean

Static killAll

killAll(withComplete?: boolean): void

- Defined in ATween.ts:119
Kill all tweens.

remarks
WHEN the tween is retain, then it will be ignored.

Parameters
- withComplete: boolean = false
  
  Specifies whether to call complete function.
Returns void

Static killTweens

killTweens(targetOrAttachment: any, withComplete?: boolean): number

- Defined in ATween.ts:135
Kill all tweens of specified the target or attachment.

Parameters
- targetOrAttachment: any
  
  the target or attachment.
- withComplete: boolean = false
  
  Specifies whether to call complete function.
Returns number
Number of killed instances

Static newOnce

newOnce(intervalMs: number, onCompleteCallback: any, onCompleteParams?: any[]): ATween

- Defined in ATween.ts:231
Create a once timer.

remarks
It will AUTO start, you don't need to call "start()" function.

Parameters
- intervalMs: number
  
  interval millisecond
- onCompleteCallback: any
  
  The callback function when completion.
- onCompleteParams: any[] = null
  
  The callback parameters when completion.
Returns ATween
Tween instance

Static newTimer

newTimer(intervalMs: number, times: number, onRepeatCallback: (steps: number) => boolean, onCompleteCallback?: any, onCompleteParams?: any[]): ATween

- Defined in ATween.ts:251
Create a timer.

remarks
It will AUTO start, you don't need to call "start()" function.

Parameters
- intervalMs: number
  
  interval millisecond
- times: number
  
  the repeat times(-1 is infinity)
- onRepeatCallback: (steps: number) => boolean
  
  if return FASLE, then will cancel this timer.
  - - (steps: number): boolean
    - Parameters
      - steps: number
      Returns boolean
- onCompleteCallback: any = null
  
  The callback function when completion.
- onCompleteParams: any[] = null
  
  The callback parameters when completion.
Returns ATween
Tween instance

Static newTween

newTween(target: any, durationMs: number, delayMs?: number): ATween

- Defined in ATween.ts:210
Create a tween.

Parameters
- target: any
  
  the targer object.
- durationMs: number
  
  set duration, not including any repeats or delays.
- delayMs: number = 0
  
  set initial delay which is the length of time in ms before the tween should begin.
Returns ATween
Tween instance

Static updateAll

updateAll(ms: number): void

- Defined in ATween.ts:92
Updates all tweens by the specified time.

Parameters
- ms: number
  
  millisecond unit
Returns void

Generated using TypeDoc