Ease.BackIn
Property in Ease
Declaration
BackIn = 22")?function(e,t){return o.createElement(o.Fragment,{key:`$br-${t}`},o.createElement("br",null),o.createElement("br",null))}(0,t):(0,v.Jx)(e)))):t};var E=function(){const e=(0,o.useContext)(a.G),t=(0,v.oX)(e.item,e);return t?o.createElement("section",{className:"api__description"},o.createElement("h2",{className:"h4"},"Description"),o.createElement("p",{className:"color-foreground-muted font-lg"},o.createElement(w,{text:t}))):null};var k=function(){const e=(0,o.useContext)(a.G),t=(0,o.useMemo)((()=>({parent:(0,g.fD)(e.item,e.api),inheritance:(0,v.nT)(e.item),implementing:(0,v.Dx)(e.item)})),[e]);return o.createElement("section",{className:"api__heading"},o.createElement("h1",{className:"h2"},(0,v.Ui)(e.item)),o.createElement("div",{className:"h6 color-foreground-muted"},e.item.type,t.parent&&o.createElement(o.Fragment,null," ","in"," ",o.createElement(n.rU,{ElementType:l.Link,to:(0,v.dI)(t.parent)},(0,v.gl)(e.item,e.api)))),t.inheritance&&t.inheritance.length>0&&o.createElement("div",{className:"h6 color-foreground-muted"},"Inherits from"," ",o.createElement(b,{name:t.inheritance[t.inheritance.length-1]})),t.implementing&&t.implementing.length>0&&o.createElement("div",{className:"h6 color-foreground-muted"},"Implements"," ",t.implementing.map(((e,r)=>o.createElement(o.Fragment,{key:e},o.createElement(b,{name:e}),r!==t.implementing.length-1&&", ")))),o.createElement("hr",{className:"thick"}))};function x(e,t,r){return r.findIndex((t=>t.name===e.name))===t}var C=function(e){let{items:t,linked:r=!0,showHeader:n=!1,unique:i}=e;const s=(0,o.useContext)(a.G),l=(0,o.useMemo)((()=>i?t.filter(x):t),[t,i]);return o.createElement("table",{className:"bordered"},n&&o.createElement("tr",null,o.createElement("th",{className:"eyebrow"},"Name"),o.createElement("th",{className:"eyebrow"},"Description")),l.map((e=>o.createElement("tr",{key:e.uid},o.createElement("td",{className:"h6"},r?o.createElement(b,{item:!0===r?e:null,name:e.name}):e.name),o.createElement("td",null,o.createElement(w,{text:(0,v.oX)(e,s)}))))))};var S=function(){const e=(0,o.useContext)(a.G),t=(0,o.useMemo)((()=>{const t=(0,v.ZX)(e.item),r=(0,g.nD)(t,e.api);return(0,g.K1)(r)}),[e]);return o.createElement(o.Fragment,null,t.map((e=>{const t=e.title.toLowerCase();return o.createElement("section",{className:`api__${t}`,key:t},o.createElement("div",{className:"eyebrow"},"Inherited"),o.createElement("h2",{className:"h4"},e.title),o.createElement(C,{items:e.items,unique:!0}))})))};var A=function(){const e=(0,o.useContext)(a.G),t=(0,o.useMemo)((()=>{const t=e.item.children||[],r=(e.node.items||[]).filter((e=>t.includes(e.uid)));return(0,g.Cx)(r)}),[e]);return o.createElement(o.Fragment,null,t.map((e=>{const t=e.title.toLowerCase();return o.createElement("section",{className:`api__${t}`,key:t},o.createElement("h2",{className:"h4"},e.title),o.createElement(C,{items:e.items,unique:!0}))})))};var O=function(){const e=(0,o.useContext)(a.G),t=(0,o.useMemo)((()=>{const{api:t,item:r}=e,n=(0,g.kk)(r.children,t).sort(i.Wf);return(0,g.o2)(n)}),[e]);return o.createElement(o.Fragment,null,t.map((t=>{const r=t.title.toLowerCase();return o.createElement("section",{className:`api__${r}`,key:r},o.createElement("h2",{className:"h3"},t.title),o.createElement("ul",null,t.items.map((t=>{const r=(0,v.oX)(t,e);return o.createElement("li",{key:t.uid},o.createElement("h3",{className:"h5"},o.createElement(n.rU,{ElementType:l.Link,to:(0,v.dI)(t)},t.name)),o.createElement("p",null,o.createElement(w,{text:r})),o.createElement("hr",null))}))))})))};var T=function(){const e=(0,o.useContext)(a.G),t=(0,o.useMemo)((()=>[{key:"typeparams",title:"Type Parameters",linked:!1,items:(0,g.$b)(e.item)},{key:"params",title:"Parameters",linked:!1,items:(0,g.ZS)(e.item)},{key:"returns",title:"Returns",linked:"auto",items:(0,g.Au)(e.item).map((t=>{let r=(0,v.jM)(t.name,e.item);return r=r.replace(/(
Changelog
+Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
@@ -115,4 +115,4 @@Added
")?function(e,t){return c.createElement(c.Fragment,{key:"$br-"+t},c.createElement("br",null),c.createElement("br",null))}(0,n):(0,x.Jx)(e)})))})):n};var w=function(){return c.createElement(i.Consumer,null,(function(e){var t=(0,x.oX)(e.item,e);return t?c.createElement("section",{className:"api__description"},c.createElement("h2",{className:"h4"},"Description"),c.createElement("p",{className:"color-on-surface-medium font-lg"},c.createElement(M,{text:t}))):null}))};var O=function(){var e=(0,c.useContext)(i),t=e.api,n=e.item,r=(0,c.useMemo)((function(){return(0,N.fD)(n,t)}),[n,t]),a=(0,c.useMemo)((function(){return(0,x.nT)(n)}),[n]),u=(0,c.useMemo)((function(){return(0,x.Dx)(n)}),[n]);return c.createElement("section",{className:"api__heading"},c.createElement("h1",{className:"h2"},(0,x.Ui)(n)),c.createElement("div",{className:"h6 color-on-surface-medium"},n.type,r&&c.createElement(c.Fragment,null," ","in"," ",c.createElement(m.rU,{ElementType:l.Link,to:(0,x.dI)(r)},(0,x.gl)(n,t)))),a&&a.length>0&&c.createElement("div",{className:"h6 color-on-surface-medium"},"Inherits from ",c.createElement(b,{name:a[a.length-1]})),u&&u.length>0&&c.createElement("div",{className:"h6 color-on-surface-medium"},"Implements"," ",u.map((function(e,t){return c.createElement(c.Fragment,{key:e},c.createElement(b,{name:e}),t!==u.length-1&&", ")}))),c.createElement("hr",{className:"thick"}))},T=function(e,t,n){return n.findIndex((function(t){return t.name===e.name}))===t};var F=function(e){var t=e.items,n=e.linked,r=void 0===n||n,a=e.showHeader,l=void 0!==a&&a,m=e.unique,u=(0,c.useMemo)((function(){return m?t.filter(T):t}),[t,m]);return c.createElement(i.Consumer,null,(function(e){return c.createElement("table",{className:"bordered"},l&&c.createElement("thead",null,c.createElement("tr",null,c.createElement("th",{className:"eyebrow"},"Name"),c.createElement("th",{className:"eyebrow"},"Description"))),c.createElement("tbody",null,u.map((function(t){return c.createElement("tr",{key:t.uid},c.createElement("td",{className:"h6"},r?c.createElement(b,{item:!0===r?t:null,name:t.name}):t.name),c.createElement("td",null,c.createElement(M,{text:(0,x.oX)(t,e)})))}))))}))};var L=function(){var e=(0,c.useContext)(i),t=(0,c.useMemo)((function(){var t=(0,x.ZX)(e.item),n=(0,N.nD)(t,e.api);return(0,N.K1)(n)}),[e]);return c.createElement(c.Fragment,null,t.map((function(e){var t=e.title.toLowerCase();return c.createElement("section",{className:"api__"+t,key:t},c.createElement("div",{className:"eyebrow"},"Inherited"),c.createElement("h2",{className:"h4"},e.title),c.createElement(F,{items:e.items,unique:!0}))})))};var I=function(){var e=(0,c.useContext)(i),t=(0,c.useMemo)((function(){var t=e.item.children||[],n=(e.node.items||[]).filter((function(e){return t.includes(e.uid)}));return(0,N.Cx)(n)}),[e]);return c.createElement(c.Fragment,null,t.map((function(e){var t=e.title.toLowerCase();return c.createElement("section",{className:"api__"+t,key:t},c.createElement("h2",{className:"h4"},e.title),c.createElement(F,{items:e.items,unique:!0}))})))};var S=function(){var e=(0,c.useContext)(i),t=(0,c.useMemo)((function(){var t=e.api,n=e.item,r=(0,N.kk)(n.children,t).sort(s.Wf);return(0,N.o2)(r)}),[e]);return c.createElement(c.Fragment,null,t.map((function(t){var n=t.title.toLowerCase();return c.createElement("section",{className:"api__"+n,key:n},c.createElement("h2",{className:"h3"},t.title),c.createElement("ul",null,t.items.map((function(t){var n=(0,x.oX)(t,e);return c.createElement("li",{key:t.uid},c.createElement("h3",{className:"h5"},c.createElement(m.rU,{ElementType:l.Link,to:(0,x.dI)(t)},t.name)),c.createElement("p",null,c.createElement(M,{text:n})),c.createElement("hr",null))}))))})))};var j=function(){var e=(0,c.useContext)(i),t=(0,c.useMemo)((function(){return[{key:"typeparams",title:"Type Parameters",linked:!1,items:(0,N.$b)(e.item)},{key:"params",title:"Parameters",linked:!1,items:(0,N.ZS)(e.item)},{key:"returns",title:"Returns",linked:"auto",items:(0,N.Au)(e.item).map((function(t){var n=(0,x.jM)(t.name,e.item);return n=n.replace(/(
License
MIT License
+License
MIT License
Copyright (c) 2021 Zigurous
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -14,4 +14,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE.
Callbacks
+Callbacks
Callbacks are used to respond to state changes of a tween. A TweenCallback function delegate is invoked for each of the following events:
- onUpdate: Invoked every time the tween is updated @@ -22,4 +22,4 @@
🗣️ Assigning callbacks
// assigning a callback with a function
Tween tween = transform.TweenPosition(Vector3.zero, 1f);
tween.onComplete = SomeFunction;
-Easing
+Easing
Easing functions specify the rate of change of a parameter over time. The website https://easings.net/ is a good resource to visualize common easing functions.
Objects in real life don’t just start and stop instantly, and almost never move at a constant speed. When we open a drawer, we first move it quickly, and slow it down as it comes out. Drop something on the floor, and it will first accelerate downwards, and then bounce back up after hitting the floor.
@@ -44,4 +44,4 @@
➰ Available Eases
Tweening
+Tweening
The Tweening package provides a system for tweening object properties in Unity. A tween is an animation of a value from a start position to an end position using an easing function, providing a natural sense of motion.
The system is lightweight, optimized, type-safe, and memory efficient. Hundreds of predefined tweening functions can be called on many common Unity objects, or you can animate anything using generic tweening functions. Tweens can be controlled with many different control methods and various callback functions.
@@ -20,4 +20,4 @@
📖 Reference
Managing Tweens
+Managing Tweens
Apart from controlling the state of an individual tween, you can also manage tweens globally using the static class Tweening. This class contains functions to change the state of all managed tweens:
Tweening.PlayAll();
Tweening.StopAll();
@@ -37,4 +37,4 @@ 🎬 Scene Unloading
Tweens will be killed automatically when the scene they are apart of is unloaded which prevents errors. However, this only works automatically if the tween knows which target object it is animating (see above). You should only need to worry about this if you are creating tweens manually using the generic approach.
Make sure to kill your tweens before transitioning scenes, or set the target reference as outlined above. You can also manually set the scene index if desired.
tween.sceneIndex = SceneManager.GetActiveScene().buildIndex;
-
Property Chaining
+Property Chaining
Property/method chaining is a technique that allows multiple properties to be assigned in a single statement without requiring a variable to store the intermediate results. This is most useful when creating new tweens. See the PropertyChaining Scripting API for a full list of properties that can be chained.
⛓️ Example
@@ -8,4 +8,4 @@⛓️ Example
.SetEase(Ease.CubicInOut) .SetLoops(-1, LoopType.PingPong) .OnLoop(() => Debug.Log("looped!")); -Sequences
+Sequences
A Sequence play a list of tweens in order. The sequence itself maintains its own state and can be controlled the same as any other tween (although not every property has an effect).
🧬 Creating a sequence
@@ -25,4 +25,4 @@🔆 State control
sequence.SetLoops(-1, LoopType.PingPong); sequence.OnComplete(() => Debug.Log("sucess!")); sequence.Play(); -Settings
+Settings
The Tweening package provides global settings that can be modified. Settings can either be changed through a static class, or through a MonoBehaviour:
- defaultEase: The default Ease assigned to every tween (
Ease.QuadOut). The ease used by a tween can be set manually if desired.
@@ -26,4 +26,4 @@
⚙️ Changing settings with code
🖥️ Changing settings in the editor
The Settings class can also be used as a MonoBehaviour added to your scene. This is generally used to provide a simple interface for changing settings in the Unity editor rather than with code. You can, of course, still use this behavior to change settings at runtime if desired, in which case there is a function to set each respective setting.
-
Supported Types
+Supported Types
⚡ Generics
When creating tweens using the generic functions, the following types of values can be animated:
-
@@ -108,4 +108,4 @@
VideoPlayerWheelColliderWindZone
-
💠 Shortcuts
Tweens
+Tweens
A tween is an animation of a value from a start position to an end position using an easing function, providing a natural sense of motion. The Tweening package provides two main types of tweens, both of which inherit from the base class Tween.
- Tweener @@ -76,4 +76,4 @@