demoted headings
({{framexmlfunc|FrameXML/UIParent.lua}}) |
(demoted headings) |
||
| Line 4: | Line 4: | ||
UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime) | UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime) | ||
=Parameters= | == Parameters == | ||
==Arguments== | === Arguments === | ||
:frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime | :frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime | ||
| Line 15: | Line 15: | ||
:;flashInHoldTime: Number - number of seconds to hold the fully hidden state. | :;flashInHoldTime: Number - number of seconds to hold the fully hidden state. | ||
:;flashOutHoldTime : Number - number of seconds to hold the fully visible state. | :;flashOutHoldTime : Number - number of seconds to hold the fully visible state. | ||
==Returns== | === Returns === | ||
This function does not return any values. | This function does not return any values. | ||
= Example = | == Example == | ||
UIFrameFlash(UIParent, 1, 2, 15, true, 12, 0) | UIFrameFlash(UIParent, 1, 2, 15, true, 12, 0) | ||
==Result== | === Result === | ||
The UIParent frame and all its children are at first hidden. The UIParent then fades in (1 second), fades out (2 seconds), stays hidden for 12 seconds, and fades in again, remaining shown this time. | The UIParent frame and all its children are at first hidden. The UIParent then fades in (1 second), fades out (2 seconds), stays hidden for 12 seconds, and fades in again, remaining shown this time. | ||
=Details= | == Details == | ||
Several important things to note when using UIFrameFlash: | Several important things to note when using UIFrameFlash: | ||
* Flash cycle starts at hidden. If you call UIFrameFlash on an already visible frame, it'll be hidden. | * Flash cycle starts at hidden. If you call UIFrameFlash on an already visible frame, it'll be hidden. | ||