View source for Fade.lua

[[Category:LunaLua helper libraries]]
[https://github.com/Wohlhabend-Networks/LunaDLL/blob/master/LuaScriptsLibExt/fade.lua Download Latest Version]

fade.lua is a small library for creating colored fading effects and colored overlays.

== Installation ==

Copy the fade.lua file in the LuaScriptsLib folder.


== How to use ==

To enable the fade library for a specific level, add this line to ''lunadll.lua'':
<syntaxhighlight lang="lua">
local fade = API.load("fade");
</syntaxhighlight>
This will load the Fade API.

== Examples ==

=== Simple Fade Effect === 
<syntaxhighlight lang="lua">
local fade = API.load("fade");

local myCustomFade = fade()
myCustomFade:setStart(255, 255, 255, 255)
myCustomFade:setEnd(255, 255, 255, 0)
myCustomFade:setTransitionTime(65*4)

function onStart()
    myCustomFade:start()
end

</syntaxhighlight>
This will create a fade effect which starts from full white to full opacity.
If you want to, you can also use hex-values instead:
<syntaxhighlight lang="lua">
myCustomFade:setStart(0xFFFFFFFF)
myCustomFade:setEnd(0xFFFFFF00)
</syntaxhighlight>

=== Simple Color Overlay ===
<syntaxhighlight lang="lua">
local fade = API.load("fade");

local myCustomOverlay = fade()
myCustomOverlay:setStart(0, 0, 255, 100)
myCustomOverlay:setEnd(0, 0, 255, 100)

function onStart()
    myCustomOverlay:start()
end
</syntaxhighlight>
This will create a blue overlay over the level.


== Documentation ==

{{API table|Fade API||2=

{{API table/row|<nowiki>myFade = fade()</nowiki>|{{type|Fade.lua|Fade object}}|Sets the memory of the given type.|odd}}

}}


{{API table|Fade object||2=

{{API table/row|[[FadeObj:setStart]]({{type|int}} red, {{type|int}} green, {{type|int}} blue, {{type|int}} alpha)|{{type|nil}}|Sets the transition start color. (0-255)|odd}}

{{API table/row|[[FadeObj:setStart]]({{type|int}} rgba)|{{type|nil}}|Sets the transition start color. (0 - 0xFFFFFFFF)}}

{{API table/row|[[FadeObj:setEnd]]({{type|int}} red, {{type|int}} green, {{type|int}} blue, {{type|int}} alpha)|{{type|nil}}|Sets the transition end color. (0-255)|odd}}

{{API table/row|[[FadeObj:setEnd]]({{type|int}} rgba)|{{type|nil}}|Sets the transition end color. (0 - 0xFFFFFFFF)}}

{{API table/row|[[FadeObj:setTransitionTime]]({{type|int}} transitionTime)|{{type|nil}}|Sets the time how long the animation should take from the start color to the end color. The transition time equals the framerate of SMBX <nowiki>(65 = 1 second)</nowiki>|odd}}

{{API table/row|[[FadeObj:reset]]()|{{type|nil}}|Resets the current transition color to the start transition color}}

{{API table/row|[[FadeObj:start]]()|{{type|nil}}|Resets and starts the transition animation.|odd}}

{{API table/row|[[FadeObj:pause]]()|{{type|nil}}|Pauses the transition animation. The current transition animation frame will be still displayed.}}

{{API table/row|[[FadeObj:continue]]()|{{type|nil}}|Resumes the transition animation.|odd}}

{{API table/row|[[FadeObj:stop]]()|{{type|nil}}|Pauses the transtion animation. The current transtion animtion frame will NOT be displayed.}}

{{API table/row|[[FadeObj:isFinished]]()|{{type|boolean}}|Returns true, if the animation finshed.|odd}}

{{API table/row|[[FadeObj.x]]|{{type|number}}|The x position of the fade animation. (Default 0)}}

{{API table/row|[[FadeObj.y]]|{{type|number}}|The y position of the fade animation. (Default 0)|odd}}

{{API table/row|[[FadeObj.width]]|{{type|number}}|The width of the fade animation. (Default 800)}}

{{API table/row|[[FadeObj.height]]|{{type|number}}|The height of the fade animation. (Default 600)|odd}}

}}