Pair: isRadarAreaFlashing

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function makes an existing radar area flash in transparency.

OOP Syntax Help! I don't understand this!

• Method:radararea:setFlashing(...)
• Variable: .flashing

Syntax

bool setRadarAreaFlashing ( radararea theRadarArea, bool flash )

Required Arguments

• theRadarArea: the radararea element we want to change flashing state of.
• flash: a bool indicating whether the radar area should flash ( true to flash, false to not flash).

Returns

• bool: value

Returns true if the new flash state was successfully set, false if the radar area doesn't exist or invalid arguments were passed.

Code Examples

Example 1 Example 2

shared

Example 1:This example checks to see whether an existing radar area (someArea) is flashing, and forces it to flash if it isn't:

local isFlashing = isRadarAreaFlashing ( someArea )
if isFlashing then                                           -- if the area is already flashing...
    outputChatBox ( "The radar area is already flashing." )
else                                                         -- if it isn't...
    setRadarAreaFlashing ( someArea, true )                  -- make the area flash
end

shared

Example 2:This example creates a radar area for theKing of the Hillscript, and a colsquare. When the player enters the radar area flashes, it stops flashing when a player leaves.

-- create our hill area for our gamemode
local hillArea = createColSquare ( -2171.0678710938, 678.17950439453, 0, 15, 15 )
local hillRadar = createRadarArea ( -2183.5678710938, 705.67950439453, 40, -40, 0, 255, 0, 175 )

-- add hill_Enter as a handler for when a player enters the hill area
function hill_Enter ( thePlayer, matchingDimension )
    -- announce to everyone that the player entered the hill
    outputChatBox( getPlayerName(thePlayer) .. " entered the zone!", root, 255, 255, 109 )
    setRadarAreaFlashing ( hillRadar, true )
end
addEventHandler ( "onColShapeHit", hillArea, hill_Enter )

-- add hill_Enter as a handler for when a player leaves the hill area
function hill_Exit ( thePlayer, matchingDimension )
    -- check if the player is not dead
    if isPlayerDead ( thePlayer ) ~= true then
        -- if he was alive, announce to everyone that the player has left the hill
        outputChatBox ( getPlayerName(thePlayer) .. " left the zone!", root, 255, 255, 109 )
        setRadarAreaFlashing ( hillRadar, false )
    end
end
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )

See Also

Radar Area Functions

• createRadarArea
• getRadarAreaColor
• getRadarAreaSize
• isInsideRadarArea
• isRadarAreaFlashing
• setRadarAreaColor
• setRadarAreaFlashing
• setRadarAreaSize

Reference

• Scripting Functions