Docs: change persists to persist

This commit is contained in:
samme 2023-09-23 08:12:22 -07:00
parent e21c6f4596
commit 76a6786fba
3 changed files with 5 additions and 5 deletions

View file

@ -23,7 +23,7 @@ The following are breaking changes:
* The `TweenOnYoyoCallback` now has the following parameters: `tween`, `targets`, `key` (the property being tweened), `current` (the current value of the property), `previous` (the previous value of the property) and finally any of the params that were passed in the `onYoyoParams` array when the Tween was created.
* The `TweenOnRepeatCallback` now has the following parameters: `tween`, `targets`, `key` (the property being tweened), `current` (the current value of the property), `previous` (the previous value of the property) and finally any of the params that were passed in the `onRepeatParams` array when the Tween was created.
* `Tween.stop` has had the `resetTo` parameter removed from it. Calling `stop` on a Tween will now prepare the tween for immediate destruction. If you only wish to pause the tween, see `Tween.pause` instead.
* Tweens will now be automatically destroyed by the Tween Manager upon completion. This helps massively in reducing stale references and memory consumption. However, if you require your Tween to live-on, even after playback, then you can now specify a new `persists` boolean flag when creating it, or toggle the `Tween.persist` property before playback. This will force the Tween to _not_ be destroyed by the Tween Manager, allowing you to replay it at any later point. The trade-off is that _you_ are now entirely responsible for destroying the Tween when you are finished with it, in order to free-up resources.
* Tweens will now be automatically destroyed by the Tween Manager upon completion. This helps massively in reducing stale references and memory consumption. However, if you require your Tween to live-on, even after playback, then you can now specify a new `persist` boolean flag when creating it, or toggle the `Tween.persist` property before playback. This will force the Tween to _not_ be destroyed by the Tween Manager, allowing you to replay it at any later point. The trade-off is that _you_ are now entirely responsible for destroying the Tween when you are finished with it, in order to free-up resources.
* All of the 'Scope' tween configuration callback properties have been removed, including `onActiveScope`, `onCompleteScope`, `onLoopScope`, `onPauseScope`, `onRepeatScope`, `onResumeScope`, `onStartScope`, `onStopScope`, `onUpdateScope` and `onYoyoScope`. You should set the `callbackScope` property instead, which will globally set the scope for all callbacks. You can also set the `Tween.callbackScope` property.
The following are to do with the new Chained Tweens feature:
@ -54,7 +54,7 @@ The following are further updates within the Tween system:
* The `TweenBuilder` now uses the new `GetInterpolationFunction` function internally.
* The `TweenBuilder` has been optimized to perform far less functions when creating the TweenData instances.
* The keyword `interpolation` has been added to the Reserved Words list and Defaults list (it defaults to `null`).
* The keyword `persists` has been added to the Reserved Words list and Defaults list (it defaults to `false`).
* The keyword `persist` has been added to the Reserved Words list and Defaults list (it defaults to `false`).
* `Tween.initTweenData` is a new method that handles the initialisation of all the Tween Data and Tween values. This replaces what took place in the `init` and `seek` methods previously. This is called automatically and should not usually be invoked directly.
* The internal `Tween.calcDuration` method has been removed. This is now handled as part of the `initTweenData` call.
* Fixed a bug where setting `repeat` and `hold` would cause the Tween to include one final hold before marking itself as complete. It now completes as soon as the final repeat concludes, not after an addition hold.

View file

@ -413,7 +413,7 @@ var TweenManager = new Class({
*
* The tweens are played in order, from start to finish. You can optionally set the chain
* to repeat as many times as you like. Once the chain has finished playing, or repeating if set,
* all tweens in the chain will be destroyed automatically. To override this, set the 'persists'
* all tweens in the chain will be destroyed automatically. To override this, set the `persist`
* argument to 'true'.
*
* Playback will start immediately unless the _first_ Tween has been configured to be paused.

View file

@ -19,7 +19,7 @@ var TWEEN_CONST = require('./const');
*
* The tweens are played in order, from start to finish. You can optionally set the chain
* to repeat as many times as you like. Once the chain has finished playing, or repeating if set,
* all tweens in the chain will be destroyed automatically. To override this, set the 'persists'
* all tweens in the chain will be destroyed automatically. To override this, set the 'persist'
* argument to 'true'.
*
* Playback will start immediately unless the _first_ Tween has been configured to be paused.
@ -99,7 +99,7 @@ var TweenChain = new Class({
*
* The tweens are played in order, from start to finish. You can optionally set the chain
* to repeat as many times as you like. Once the chain has finished playing, or repeating if set,
* all tweens in the chain will be destroyed automatically. To override this, set the 'persists'
* all tweens in the chain will be destroyed automatically. To override this, set the 'persist'
* argument to 'true'.
*
* Playback will start immediately unless the _first_ Tween has been configured to be paused.