SetRadarAreaFlashing: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
[[ | {{Needs_Checking|Does it return false if the radararea is set to flash but already is flashing (and vice versa)? [[User:Erorr404|Erorr404]]}} | ||
__NOTOC__ | __NOTOC__ | ||
Makes an existing radar area flash in transparency. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setRadarAreaFlashing ( | bool setRadarAreaFlashing ( radararea theRadararea, bool flash ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theRadararea:''' the radararea element. | ||
*'''flash:''' a bool indicating whether the radar area should flash (true to flash, false to not flash). | |||
*''' | |||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the radar area was successfuly set to flash, ''false'' if the radar area doesn't exist. | ||
==Example== | ==Example== | ||
This example | This example checks to see whether an existing radar area (''someArea'') is flashing, and forces it to flash if it isn't: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | flag = isRadarAreaFlashing ( someArea ) | ||
if ( flag ) then -- if the area is already flashing... | |||
-- | outputChatBox ( "The radar area is already flashing." ) | ||
else -- it it isn't... | |||
setRadarAreaFlashing ( someArea, true ) -- make the area flash | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Radar area_functions}} | ||
Revision as of 23:25, 10 September 2006
|
This article needs checking. |
Reason(s): Does it return false if the radararea is set to flash but already is flashing (and vice versa)? Erorr404 |
Makes an existing radar area flash in transparency.
Syntax
bool setRadarAreaFlashing ( radararea theRadararea, bool flash )
Required Arguments
- theRadararea: the radararea element.
- flash: a bool indicating whether the radar area should flash (true to flash, false to not flash).
Returns
Returns true if the radar area was successfuly set to flash, false if the radar area doesn't exist.
Example
This example checks to see whether an existing radar area (someArea) is flashing, and forces it to flash if it isn't:
flag = isRadarAreaFlashing ( someArea ) if ( flag ) then -- if the area is already flashing... outputChatBox ( "The radar area is already flashing." ) else -- it it isn't... setRadarAreaFlashing ( someArea, true ) -- make the area flash end
See Also
- createRadarArea
- getRadarAreaColor
- getRadarAreaSize
- isInsideRadarArea
- isRadarAreaFlashing
- setRadarAreaColor
- setRadarAreaFlashing
- setRadarAreaSize