IsInsideRadarArea

This function checks if a 2D position is inside a radar area or not.

	Warning: Before 1.5.5 r11746, this function does not always work correctly if dimensions of the radararea (sizeX or sizeY) are negative numbers.

Syntax

bool isInsideRadarArea ( radararea theArea, float posX, float posY )

OOP Syntax Help! I don't understand this!

Method: radararea:isInside(...)

Required Arguments

• theArea: The radar area you're checking the position against.
• posX: The X coordinate of the position you're checking.
• posY: The Y coordinate of the position you're checking.

Returns

Returns true if the position is inside the radar area, false if it isn't or if any parameters are invalid.

Example

This function checks if an element is within a radar area.

function isElementInsideRadarArea ( theElement, theArea )
	-- get the x, y coordinates from getElementPosition (z gets silently discarded)
	local posX, posY = getElementPosition( theElement )
	-- call isInsideRadarArea with those coordinates and return its result
	return isInsideRadarArea ( theArea, posX, posY )
end

Issues

Issue ID	Description
#9699	[Fixed in 1.5.5-r11746] isInsideRadarArea returns always false, when sizeX or sizeY of radarArea is negative

See Also

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