GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Updated Animation (markdown)

Robert Jelic
2022-04-02 18:00:44 +02:00
parent e580d5b394
commit 9a9adbfc54
1 changed files with 62 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
Animation.md

@@ -1 +1,62 @@
WIP
With animations you can create a beautiful experience for users while interacting with objects.<br>
For now the animation class is very basic, i will expand it in the future, but i have to say already now you can do almost everything you can imaginge!
Right now animation is a class which makes use of the timer event
Here is a example of how to create a default animations:
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local aAnimation = mainFrame:addAnimation("anim1")
````
This will create a default animation without anything in it
Here are all possible functions available for animations:
## add
adds a new function to your animation
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local testButton = mainFrame:addButton("myTestButton"):show()
local aAnimation = mainFrame:addAnimation("anim1"):add(function() testButton:setPosition(3,3) end):wait(1):add(function() testButton:setPosition(1,1,"r") end):wait(2):add(function() testButton:setPosition(1,1,"r") end)
aAnimation:play() -- this will set the button position to 3,3, waits 1 sec., sets it to 4,4, waits 2 sec. and then sets the position to 5,5
````
**args:** function<br>
**returns:** animation object<br>
## wait
sets a wait timer for the next function after the previous function got executed, no wait timer calls the next function immediatly
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local testButton = mainFrame:addButton("myTestButton"):show()
local aAnimation = mainFrame:addAnimation("anim1"):add(function() testButton:setPosition(3,3) end):wait(1):add(function() testButton:setPosition(1,1,"r") end):wait(2):add(function() testButton:setPosition(1,1,"r") end)
aAnimation:play() -- this will set the button position to 3,3, waits 1 sec., sets it to 4,4, waits 2 sec. and then sets the position to 5,5
````
**args:** timer - how long we should wait to call the next function<br>
**returns:** animation object<br>
## play
starts to play the animation
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local testButton = mainFrame:addButton("myTestButton"):show()
local aAnimation = mainFrame:addAnimation("anim1"):add(function() testButton:setBackground(colors.black) end):wait(1):add(function() testButton:setBackground(colors.gray) end):wait(1):add(function() testButton:setBackground(colors.lightGray) end)
aAnimation:play() -- changes the background color of that button from black to gray and then to lightGray
````
**args:** [endlessloop] - bool if it should loop forever - will change that to loopcount in the future<br>
**returns:** animation object<br>
## cancel
cancels the animation
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local testButton = mainFrame:addButton("myTestButton"):show()
local aAnimation = mainFrame:addAnimation("anim1"):add(function() testButton:setBackground(colors.black) end):wait(1):add(function() aAnimation:cancel() end):wait(1):add(function() testButton:setBackground(colors.lightGray) end)
aAnimation:play()
````
**args:** -<br>
**returns:** animation object<br>