GetRadarAreaColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Added OOP syntax) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server client function}} | ||
This function can be used to retrieve the current color of a [[radararea|radar area]]. | This function can be used to retrieve the current color of a [[radararea|radar area]]. | ||
Line 6: | Line 6: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int, int, int, int getRadarAreaColor ( radararea theRadararea ) | int, int, int, int getRadarAreaColor ( radararea theRadararea ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[radararea]]:getColor}} | |||
===Required Arguments=== | ===Required Arguments=== |
Latest revision as of 17:35, 26 November 2014
This function can be used to retrieve the current color of a radar area.
Syntax
int, int, int, int getRadarAreaColor ( radararea theRadararea )
OOP Syntax Help! I don't understand this!
- Method: radararea:getColor(...)
Required Arguments
- theRadararea: The radar area you wish to retrieve the colour of.
Returns
Returns four integers in RGBA format (red, green, blue, alpha), with a maximum value of 255 for each. Alpha decides transparency where 255 is opaque and 0 is transparent. Returns false if the radararea is invalid.
Example
This example checks the color of a radararea defined as 'area' and announces if it is Ballas or Grove Street territory.
local r,g,b,a = getRadarAreaColor ( area ) -- get the color of 'area' and store it in 'r', 'g', 'b' and 'a' if r == 0 and g == 255 and b == 0 then -- if the radar area is fully green outputChatBox ( "This is Grove Street turf!" ) -- announce it as grove street area elseif r == 255 and g == 0 and b == 255 then -- if it is purple however outputChatBox ( "This is Ballas turf!" ) -- announce it as ballas area end
See Also
- createRadarArea
- getRadarAreaColor
- getRadarAreaSize
- isInsideRadarArea
- isRadarAreaFlashing
- setRadarAreaColor
- setRadarAreaFlashing
- setRadarAreaSize