Pair: getBlipSize

This function sets the size of a blip's icon.

OOP Syntax Help! I don't understand this!

• Method: blip:setSize(...)
• Variable: .size

Syntax

bool setBlipSize ( blip theBlip, int size )

Required Arguments

• theBlip: The blip you wish to set the size of.
• size: The size you wish the icon to be. 2 is the default value. 25 is the maximum value. Value gets clamped between 0 and 25.

Returns

• bool: result

Returns an true if the blip's size was set successfully. Returns false if the element passed was not a blip or if the icon size passed was invalid.

Code Examples

Example 1 Example 2 (OOP)

shared

This example will reset the size of all blips to the default.

-- Retrieve a table containing all the blips that exist
local blips = getElementsByType ( "blip" )
-- Loop through the list
for blipKey, blipValue in ipairs(blips) do
  -- Retrieve the blip's size into the variable 'blipSize'
  local blipSize = getBlipSize ( blipValue )
  -- If the blip's size wasn't 2 (the default size) already
  if ( blipSize ~= 2 ) then
    -- Set the size to the default
    setBlipSize ( blipValue, 2 )
  end
end

shared

OOP Required

This example will reset the size of all blips to the default.

-- Retrieve a table containing all the blips that exist
local blips = Element.getAllByType ( "blip" )
-- Loop through the list
for blipKey, blipValue in ipairs(blips) do
  -- Retrieve the blip's size into the variable 'blipSize'
  local blipSize = blipValue.size
  -- If the blip's size wasn't 2 (the default size) already
  if ( blipSize ~= 2 ) then
    -- Set the size to the default
    blipValue.size = 2
  end
end

See Also

Blip Functions

• createBlip
• createBlipAttachedTo
• getBlipIcon
• getBlipColor
• getBlipOrdering
• getBlipSize
• getBlipVisibleDistance
• setBlipColor
• setBlipOrdering
• setBlipIcon
• setBlipSize
• setBlipVisibleDistance

Reference

• Scripting Functions