archive-gh-me/tween.js
1
0
Fork 0
mirror of https://github.com/tweenjs/tween.js.git synced 2025-12-08 20:16:12 +00:00
Code Issues Projects Releases Wiki Activity

docs: provide correct, non misleading usage of the onStart callback. Also clarify a bit the onStop paragraph.

Browse Source
This commit is contained in:
sole 2015-09-29 22:05:41 +01:00
parent 10d7068b5b
commit 42387a9466
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/user_guide.md
View File

@ -272,25 +272,27 @@ var trickyObjTween = new TWEEN.Tween({
});
````
Or imagine you want to ensure the values of an object are in an specific state each time the tween is started. You'll assign a `start` callback:
Or imagine you want to play a sound when a tween is started. You can use an `start` callback:
````javascript
var tween = new TWEEN.Tween(obj)
.to({ x: 100 })
.onStart(function() {
this.x = 0;
sound.play();
});
````
The scope for each callback is the tweened object.
The scope for each callback is the tweened object--in this case, `obj`.
### onStart
Executed right before the tween starts-i.e. before the deltas are calculated. This is the place to reset values in order to have the tween always start from the same point, for example.
Executed right before the tween starts--i.e. before the deltas are calculated. This will be executed only once per tween, i.e. it will *not* be run when the tween is repeated via `repeat()`.
It is great for synchronising to other events or triggering actions you want to happen when a tween starts.
### onStop
Executed when a tween is explicitly stopped (not when it is completed normally), and before stopping any possible chained tween.
Executed when a tween is explicitly stopped via `stop()`, but not when it is completed normally, and before stopping any possible chained tween.
### onUpdate