IsRadarAreaFlashing: Difference between revisions

Revision as of 18:40, 13 August 2006

This function allows detection of whether a radar area is flashing or not.

bool isRadarAreaFlashing ( radararea radararea )

Returns true if the operation was successful, false otherwise.

This example checks whether the radar area 'glenpark' is flashing, and announces it if it is.

if isRadarAreaFlashing ( glenpark ) == true --if glen park is flashing it
    outputChatBox ( "Glen Park is under attack!!!" ) -- anounce it
end

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
 __NOTOC__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function allows detection of whether a radar area is flashing or not.
 ==Syntax==
@@ Line 10: / Line 8: @@
 ===Required Arguments===
-*'''argumentName:''' description
+*'''radararea:''' The radar area you wish to check the state of flashing
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns ''true'' if the operation was successful, ''false'' otherwise.
 ==Example==
-This example does...
+This example checks whether the radar area 'glenpark' is flashing, and announces it if it is.
 <syntaxhighlight lang="lua">
---This line does...
+if isRadarAreaFlashing ( glenpark ) == true --if glen park is flashing it
-blabhalbalhb --abababa
+    outputChatBox ( "Glen Park is under attack!!!" ) -- anounce it
---This line does this...
+end
-mooo
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Radar area functions}}