Docs update
Some more stuff for docs
This commit is contained in:
30
docs/objects/Animation/addMode.md
Normal file
30
docs/objects/Animation/addMode.md
Normal file
@@ -0,0 +1,30 @@
|
||||
## addMode
|
||||
Adds a new easing curve into the available easing list. Checkout the animation object if you want to know how this works.
|
||||
|
||||
#### Parameters:
|
||||
|
||||
1. `string` - The name of the curve you want to use.
|
||||
2. `functon` - The function to call
|
||||
|
||||
#### Returns:
|
||||
|
||||
1. `animation` Animation in use
|
||||
|
||||
#### Usage:
|
||||
|
||||
* Creates a new curve
|
||||
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local testButton = mainFrame:addButton("buttonToAnimate")
|
||||
local aAnimation = mainFrame:addAnimation():setObject(testButton)
|
||||
|
||||
local function easeInBack(t) -- t is the time from 0 to 1
|
||||
local c1 = 1.70158;
|
||||
local c3 = c1 + 1
|
||||
return c3*t^3-c1*t^2
|
||||
end
|
||||
|
||||
aAnimation:addMode("coolEaseInBack", easeInBack)
|
||||
aAnimation:setMode("coolEaseInBack"):move(15,3,2):play()
|
||||
```
|
||||
16
docs/objects/Animation/onStart.md
Normal file
16
docs/objects/Animation/onStart.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## onStart
|
||||
`onStart(self)`<br>
|
||||
This is a event which gets fired as soon as the animation is started.
|
||||
|
||||
```lua
|
||||
local basalt = require("Basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local testButton = mainFrame:addButton("buttonToAnimate")
|
||||
local aAnimation = mainFrame:addAnimation():setObject(testButton):changeTextColor({colors.red, colors.yellow, colors.green}, 2)
|
||||
aAnimation:onStart(function()
|
||||
basalt.debug("The animation is started")
|
||||
end)
|
||||
|
||||
aAnimation:play()
|
||||
```
|
||||
36
docs/objects/Animation/setMode.md
Normal file
36
docs/objects/Animation/setMode.md
Normal file
@@ -0,0 +1,36 @@
|
||||
## setMode
|
||||
Changes the easing curve. If you want to test them, here is a interesting website: https://easings.co
|
||||
|
||||
#### Parameters:
|
||||
1. `string` - The name of the curve you want to use.
|
||||
|
||||
#### Returns:
|
||||
1. `animation` Animation in use
|
||||
|
||||
#### Usage:
|
||||
* Takes 2 seconds to move the object from its current position to x15 y3
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local testButton = mainFrame:addButton("buttonToAnimate")
|
||||
local aAnimation = mainFrame:addAnimation():setObject(testButton):setMode("easeInBounce"):move(15,3,2):play()
|
||||
```
|
||||
|
||||
## Easing Curve List
|
||||
|
||||
Here is a list of all available easing curves:
|
||||
|
||||
| | | |
|
||||
|---|---|---|
|
||||
|linear||
|
||||
|easIn|easeOut|easeInOut
|
||||
|easeInSine|easeOutSine|easeInOutSine
|
||||
|easeInBack|easeOutBack|easeInOutBack
|
||||
|easeInCubic|easeOutCubic|easeInOutCubic
|
||||
|easeInElastic|easeOutElastic|easeInOutElastic
|
||||
|easeInExpo|easeOutExpo|easeInOutExpo
|
||||
|easeInBack|easeOutBack|easeInOutBack
|
||||
|easeInQuad|easeOutQuad|easeInOutQuad
|
||||
|easeInQuint|easeOutQuint|easeInOutQuint
|
||||
|easeInQuart|easeOutQuart|easeInOutQuart
|
||||
|easeInCirc|easeOutCirc|easeInOutCirc
|
||||
|easeInBounce|easeOutBounce|easeInOutBounce
|
||||
Reference in New Issue
Block a user