WoW:API UIFrameFlash - Revision history

Move page script: Move page script moved page API UIFrameFlash to WoW:API UIFrameFlash without leaving a redirect

2023-08-15T04:47:41Z

Move page script moved page API UIFrameFlash to API UIFrameFlash without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Spiel2001: UIFrameFlashRemoveFrame has been renamed to UIFrameFlashStop

2011-02-03T00:16:04Z

UIFrameFlashRemoveFrame has been renamed to UIFrameFlashStop

← Older revision		Revision as of 00:16, 3 February 2011
Line 29:		Line 29:
	* Flashing works by modifying the frame's alpha value (:SetAlpha). All of the frame's children fade with their parent frame.		* Flashing works by modifying the frame's alpha value (:SetAlpha). All of the frame's children fade with their parent frame.
	* You can not flash the WorldFrame (fails silently).		* You can not flash the WorldFrame (fails silently).
	* If you try to flash an already flashing frame, the function fails silently. You may use [[API UIFrameIsFading\|UIFrameIsFading (frame)]] to detect if a frame is already flashing, and [[API ~~UIFrameFlashRemoveFrame~~\|UIFrameFlashRemoveFrame (frame)]] to stop the flashing cycle prematurely (make sure to set the desired alpha value manually afterwards).		* If you try to flash an already flashing frame, the function fails silently. You may use [[API UIFrameIsFading\|UIFrameIsFading (frame)]] to detect if a frame is already flashing, and [[API UIFrameFlashStop\|UIFrameFlashRemoveFrame (frame)]] to stop the flashing cycle prematurely (make sure to set the desired alpha value manually afterwards).
	* Once flashDuration expires, the frame's alpha is bluntly set to either 1 or 0 (depending on showWhenDone). Make sure to set a flashDuration value to coincide with the end of a fade in (if you want the frame to remain visible) or fade out (if not). Otherwise, things will look awkward.		* Once flashDuration expires, the frame's alpha is bluntly set to either 1 or 0 (depending on showWhenDone). Make sure to set a flashDuration value to coincide with the end of a fade in (if you want the frame to remain visible) or fade out (if not). Otherwise, things will look awkward.
	* The frame MUST have a name, otherwise one of the internal functions causes an error.		* The frame MUST have a name, otherwise one of the internal functions causes an error.

WoWWiki>Sinus Pi: name required

2010-05-26T08:11:56Z

name required

← Older revision		Revision as of 08:11, 26 May 2010
Line 31:		Line 31:
	* If you try to flash an already flashing frame, the function fails silently. You may use [[API UIFrameIsFading\|UIFrameIsFading (frame)]] to detect if a frame is already flashing, and [[API UIFrameFlashRemoveFrame\|UIFrameFlashRemoveFrame (frame)]] to stop the flashing cycle prematurely (make sure to set the desired alpha value manually afterwards).		* If you try to flash an already flashing frame, the function fails silently. You may use [[API UIFrameIsFading\|UIFrameIsFading (frame)]] to detect if a frame is already flashing, and [[API UIFrameFlashRemoveFrame\|UIFrameFlashRemoveFrame (frame)]] to stop the flashing cycle prematurely (make sure to set the desired alpha value manually afterwards).
	* Once flashDuration expires, the frame's alpha is bluntly set to either 1 or 0 (depending on showWhenDone). Make sure to set a flashDuration value to coincide with the end of a fade in (if you want the frame to remain visible) or fade out (if not). Otherwise, things will look awkward.		* Once flashDuration expires, the frame's alpha is bluntly set to either 1 or 0 (depending on showWhenDone). Make sure to set a flashDuration value to coincide with the end of a fade in (if you want the frame to remain visible) or fade out (if not). Otherwise, things will look awkward.
			* The frame MUST have a name, otherwise one of the internal functions causes an error.

WoWWiki>Charibot: catfix, Replaced: {{framexml →
{{framexml

2008-07-15T00:45:18Z

catfix, Replaced: {{framexml → <br>{{framexml

← Older revision		Revision as of 00:45, 15 July 2008
Line 1:		Line 1:
	{{framexmlfunc\|FrameXML/UIParent.lua}}		<br>{{framexmlfunc\|FrameXML/UIParent.lua}}
	Flashes a frame by fading it in/out and showing/hiding it at the end.		Flashes a frame by fading it in/out and showing/hiding it at the end.

WoWWiki>Hobinbot: demoted headings

2007-01-07T04:31:14Z

demoted headings

← Older revision		Revision as of 04:31, 7 January 2007
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.

WoWWiki>Mikk: {{framexmlfunc|FrameXML/UIParent.lua}}

2006-09-05T14:12:07Z

← Older revision		Revision as of 14:12, 5 September 2006
Line 1:		Line 1:
	{{~~framexml~~}}		{{framexmlfunc\|FrameXML/UIParent.lua}}
	Flashes a frame by fading it in/out and showing/hiding it at the end.		Flashes a frame by fading it in/out and showing/hiding it at the end.

WoWWiki>Starlightblunder: {{framexml}} -> top

2006-06-18T21:19:05Z

{{framexml}} -> top

@@ Line 1: / Line 1: @@
 {{framexml}}
-{{stub/api}}
+ UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime)
-UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime)
+=Parameters=

WoWWiki>Mikk: {{framexml}}, mark stub

2006-06-11T13:29:30Z

{{framexml}}, mark stub

← Older revision		Revision as of 13:29, 11 June 2006
Line 1:		Line 1:
			{{framexml}}

			{{stub/api}}

	UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime)		UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime)

WoWWiki>WoWWiki-Oxman at 21:41, 18 February 2006

2006-02-18T21:41:04Z

New page

UIFrameFlash(frame, fadeInTime, fadeOutTime, flashDuration, showWhenDone, flashInHoldTime, flashOutHoldTime)