From 9a9adbfc541915410cea857dd7378319d7c812cb Mon Sep 17 00:00:00 2001
From: Robert Jelic <36573031+NoryiE@users.noreply.github.com>
Date: Sat, 2 Apr 2022 18:00:44 +0200
Subject: [PATCH] Updated Animation (markdown)

---
 Animation.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

diff --git a/Animation.md b/Animation.md
index 6d3f665..be3ce2d 100644
--- a/Animation.md
+++ b/Animation.md
@@ -1 +1,62 @@
-WIP
\ No newline at end of file
+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>
\ No newline at end of file