Sol.animation.Resize

From Runes of Magic Wiki - The Runes of Magic

Jump to: navigation, search
Sol.animation.Resize = function(addonName, frame, sizeToWidth, sizeToHeight, fps, time, sizeChildren, onUpdateFnName)


Animates a resize of a frame.

Note: This uses Sol.timers.ScheduleTimer. Please see the notes for that
function as they pertain to this one, as well.

Parameters:
+ addonName      - Your addon's name
+ frame          - Frame to fade
+ sizeToWidth    - The width to gradually change toward (>= 0). Defaults to 0
+ sizeToHeight   - The height to gradually change toward (>= 0). Defaults to 0
+ fps            - How many frames per second to use for the animation
                   Defaults to Sol.constants.DEFAULT_FPS
+ time           - How much time to take for the animation
                   Defaults to Sol.constants.DEFAULT_ANIMATION_TIME
+ sizeChildren   - If true, will attempt to resize all named children of frame
                   Will not work if frame width or height is <= 0
+ onUpdateFnName - The name of the OnUpdate handler to use (optional)
                   Defaults to <addonName>_OnUpdate
                   
Returns:
+ true if the animation was setup successfully; else false

Post:
+ The frame's size (and optionally, its named children) will gradually change 
until it gets to the specified value
Personal tools