setRadarAreaSize

Client-side

Server-side

Shared

Manual Review Required

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

This function changes the size of an existing radar area.

OOP Syntax Help! I don't understand this!

Method: radararea:setSize(...)

Syntax

bool setRadarAreaSize ( radararea theRadararea, float x, float y )

Required Arguments

theRadararea: the radararea element whose size is to be changed.
x: the x length of the radar area.
y: the y length of the radar area.

Returns

bool: value

Returns true if the size was set successfully, false if invalid arguments are passed.

Code Examples

shared

Example 1:This example decreases the size of a team's radar area whenever a player from that team dies:

-- assume that team elements exist and that each player belongs to one of them
-- assume that radararea elements exist and that each is a child of one of the teams
function playerWasted ( killer, killerweapon, bodypart )
    local victimteam = getPlayerTeam ( source )                 -- get the team of the victim
    local killerteam = getPlayerTeam ( killer )                 -- get the team of the killer
    if ( killer and killerteam ~= victimteam ) then             -- if there is a killer and he is from an opposing team
        local victimarea = getElementChild ( victimteam, 0 )    -- get the radararea belonging to the victim's team
        local x, y = getRadarAreaSize ( victimarea )            -- get the size of the radar area
        x = x - 5
        y = y - 5
        setRadarAreaSize ( victimarea, x, y )                   -- set a new (smaller) size for the victim's radar area
    end
end
addEventHandler ( "onPlayerWasted", root, playerWasted )