SetBlipSize: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
m (fix oop) |
||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setBlipSize ( blip theBlip, int iconSize )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setBlipSize ( blip theBlip, int iconSize )</syntaxhighlight> | ||
{{OOP| | {{OOP||[[blip]]:setSize|size|getBlipSize|}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBlip:''' The blip you wish to get the size of. | *'''theBlip:''' The blip you wish to get the size of. |
Revision as of 17:30, 5 January 2016
This function sets the size of a blip's icon.
Syntax
bool setBlipSize ( blip theBlip, int iconSize )
OOP Syntax Help! I don't understand this!
- Method: blip:setSize(...)
- Variable: .size
- Counterpart: getBlipSize
Required Arguments
- theBlip: The blip you wish to get the size of.
- iconSize: The size you wish the icon to be. 2 is the default value.
Returns
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.
Example
This example will reset the size of all blips to the default.
-- Retrieve a table containing all the blips that exist blips = getElementsByType ( "blip" ) -- Loop through the list for blipKey, blipValue in ipairs(blips) do -- Retrieve the blip's size into the variable 'blipSize' 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
See Also
- createBlip
- createBlipAttachedTo
- getBlipColor
- getBlipIcon
- getBlipOrdering
- getBlipSize
- getBlipVisibleDistance
- setBlipColor
- setBlipIcon
- setBlipOrdering
- setBlipSize
- setBlipVisibleDistance