IsRadarAreaFlashing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Added OOP pair)
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Server client function}}
__NOTOC__
This function allows detection of whether a radar area is flashing or not.
This function allows detection of whether a radar area is flashing or not.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isRadarAreaFlashing ( radararea radararea )               
bool isRadarAreaFlashing ( radararea theRadararea )               
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[radararea]]:isFlashing|flashing|setRadarAreaFlashing}}


===Required Arguments===  
===Required Arguments===  
*'''radararea:''' The radar area you wish to check the state of flashing
*'''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 now.
Returns ''true'' if the radar area is flashing, ''false'' if it is not or if it doesn't exist.


==Example==  
==Example==  
This example checks whether the radar area 'glenpark' is flashing, and announces it if it is.
This example checks whether the radar area in the variable ''glenpark'' is flashing, and announces it if it is.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if isRadarAreaFlashing ( glenpark ) == true --if glen park is flashing it
function checkArea(sourcePlayer)
    outputChatBox ( "Glen Park is under attack!!!" ) -- announce it
    if ( isRadarAreaFlashing ( glenpark ) ) then          -- if the radar area in the variable glenpark is flashing
        outputChatBox ( "Glen Park is under attack!!!" ) -- announce it
    end
end
end
addCommandHandler("checkArea", checkArea)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Radar area functions}}
{{Radar area functions}}

Latest revision as of 17:38, 26 November 2014

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

Syntax

bool isRadarAreaFlashing ( radararea theRadararea )               

OOP Syntax Help! I don't understand this!

Method: radararea:isFlashing(...)
Variable: .flashing
Counterpart: setRadarAreaFlashing


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.

function checkArea(sourcePlayer)
    if ( isRadarAreaFlashing ( glenpark ) ) then          -- if the radar area in the variable glenpark is flashing
        outputChatBox ( "Glen Park is under attack!!!" )  -- announce it
    end
end
addCommandHandler("checkArea", checkArea)

See Also