diff --git a/docs/user_guide.md b/docs/user_guide.md index 1e533c8..5c39ef5 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -351,7 +351,7 @@ It is great for synchronising to other events or triggering actions you want to The tweened object is passed in as the first parameter. -### onStartEvery +### onEveryStart As per `onStart`, except that it _will_ be run on every repeat of the tween. @@ -381,7 +381,7 @@ Executed whenever a tween has just finished one repetition and will begin anothe The tweened object is passed in as the first parameter. -To clarify when `onStart`, `onStartEvery` and `onRepeat` are called, consider: +To clarify when `onStart`, `onEveryStart` and `onRepeat` are called, consider: ```javascript const obj = {x: 0} @@ -395,8 +395,8 @@ const t = new TWEEN.Tween(obj) .onRepeat(() => { console.log('onRepeat') }) - .onStartEvery(() => { - console.log('onStartEvery') + .onEveryStart(() => { + console.log('onEveryStart') }) .start(0) @@ -414,7 +414,7 @@ The output would look like this, on the left as above, and on the right with `.d ``` Tick 0 Tick 0 onStart { x: 0 } -onStartEvery +onEveryStart { x: 0 } Tick 1 Tick 1 @@ -431,11 +431,11 @@ Tick 4 Tick 4 Tick 5 Tick 5 onRepeat onStart -{ x: 5 } onStartEvery +{ x: 5 } onEveryStart { x: 0 } Tick 6 Tick 6 -onStartEvery { x: 1 } +onEveryStart { x: 1 } { x: 1 } Tick 7 Tick 7 @@ -452,7 +452,7 @@ onRepeat onRepeat { x: 5 } { x: 5 } Tick 11 Tick 11 -onStartEvery { x: 5 } +onEveryStart { x: 5 } { x: 1 } Tick 12 Tick 12 @@ -465,11 +465,11 @@ Tick 14 Tick 14 { x: 4 } { x: 5 } Tick 15 Tick 15 -onRepeat onStartEvery +onRepeat onEveryStart { x: 5 } { x: 0 } Tick 16 Tick 16 -onStartEvery { x: 1 } +onEveryStart { x: 1 } { x: 1 } Tick 17 Tick 17 @@ -486,7 +486,7 @@ onRepeat onRepeat { x: 5 } { x: 5 } Tick 21 Tick 21 -onStartEvery { x: 5 } +onEveryStart { x: 5 } { x: 1 } ``` diff --git a/src/Tween.ts b/src/Tween.ts index 11bcc72..7ad8ab9 100644 --- a/src/Tween.ts +++ b/src/Tween.ts @@ -38,8 +38,8 @@ export class Tween { private _chainedTweens: Array> = [] private _onStartCallback?: (object: T) => void private _onStartCallbackFired = false - private _onStartEveryCallback?: (object: T) => void - private _onStartEveryCallbackFired = false + private _onEveryStartCallback?: (object: T) => void + private _onEveryStartCallbackFired = false private _onUpdateCallback?: (object: T, elapsed: number) => void private _onRepeatCallback?: (object: T) => void private _onCompleteCallback?: (object: T) => void @@ -107,7 +107,7 @@ export class Tween { this._isPaused = false this._onStartCallbackFired = false - this._onStartEveryCallbackFired = false + this._onEveryStartCallbackFired = false this._isChainStopped = false @@ -307,8 +307,8 @@ export class Tween { return this } - onStartEvery(callback?: (object: T) => void): this { - this._onStartEveryCallback = callback + onEveryStart(callback?: (object: T) => void): this { + this._onEveryStartCallback = callback return this } @@ -366,12 +366,12 @@ export class Tween { this._onStartCallbackFired = true } - if (this._onStartEveryCallbackFired === false) { - if (this._onStartEveryCallback) { - this._onStartEveryCallback(this._object) + if (this._onEveryStartCallbackFired === false) { + if (this._onEveryStartCallback) { + this._onEveryStartCallback(this._object) } - this._onStartEveryCallbackFired = true + this._onEveryStartCallbackFired = true } elapsed = (time - this._startTime) / this._duration @@ -422,7 +422,7 @@ export class Tween { this._onRepeatCallback(this._object) } - this._onStartEveryCallbackFired = false + this._onEveryStartCallbackFired = false return true } else { diff --git a/src/tests.ts b/src/tests.ts index b85123c..e87c070 100644 --- a/src/tests.ts +++ b/src/tests.ts @@ -203,8 +203,8 @@ export const tests = { test.ok(t.onStart() instanceof TWEEN.Tween) test.equal(t.onStart(), t) - test.ok(t.onStartEvery() instanceof TWEEN.Tween) - test.equal(t.onStartEvery(), t) + test.ok(t.onEveryStart() instanceof TWEEN.Tween) + test.equal(t.onEveryStart(), t) test.ok(t.onStop() instanceof TWEEN.Tween) test.equal(t.onStop(), t) @@ -979,7 +979,7 @@ export const tests = { test.done() }, - 'Test TWEEN.Tween.onStartEvery'(test: Test): void { + 'Test TWEEN.Tween.onEveryStart'(test: Test): void { const obj = {}, t = new TWEEN.Tween(obj) let counter = 0 @@ -987,7 +987,7 @@ export const tests = { t.to({x: 2}, 500) t.delay(500) t.repeat(Infinity) - t.onStartEvery(function (): void { + t.onEveryStart(function (): void { counter++ }) @@ -995,16 +995,16 @@ export const tests = { t.start(0) TWEEN.update(0) - test.deepEqual(counter, 0, 'onStartEvery callback not called before delayed start') + test.deepEqual(counter, 0, 'onEveryStart callback not called before delayed start') TWEEN.update(500) - test.deepEqual(counter, 1, 'onStartEvery callback called at delayed start') + test.deepEqual(counter, 1, 'onEveryStart callback called at delayed start') TWEEN.update(1000) - test.deepEqual(counter, 1, 'onStartEvery callback not called before delayed repeat start') + test.deepEqual(counter, 1, 'onEveryStart callback not called before delayed repeat start') TWEEN.update(1500) - test.deepEqual(counter, 2, 'onStartEvery callback called at delayed repeat start') + test.deepEqual(counter, 2, 'onEveryStart callback called at delayed repeat start') test.done() },