IsRadarAreaFlashing: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool isRadarAreaFlashing ( radararea | bool isRadarAreaFlashing ( radararea theRadararea ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theRadararea:''' The radar area you wish to check the state of flashing | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the radar area is flashing, ''false'' if it is not. | Returns ''true'' if the radar area is flashing, ''false'' if it is not or if it doesn't exist. | ||
==Example== | ==Example== | ||
Revision as of 22:52, 10 September 2006
This function allows detection of whether a radar area is flashing or not.
Syntax
bool isRadarAreaFlashing ( radararea theRadararea )
Required Arguments
- theRadararea: The radar area you wish to check the state of flashing
Returns
Returns true if the radar area is flashing, false if it is not or if it doesn't exist.
Example
This example checks whether the radar area in the variable glenpark is flashing, and announces it if it is.
if ( isRadarAreaFlashing ( glenpark ) == true ) then -- if the radar area in the variable glenpark is flashing
outputChatBox ( "Glen Park is under attack!!!" ) -- announce it
end
See Also
- createRadarArea
- getRadarAreaColor
- getRadarAreaSize
- isInsideRadarArea
- isRadarAreaFlashing
- setRadarAreaColor
- setRadarAreaFlashing
- setRadarAreaSize