SetBlipSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Needs_Checking|This function doesnt work as specified.  Instead it is a clone of setBlipIcon. --[[User:Talidan2|Talidan2]] 11:07, 29 August 2007 (CDT)}}
{{Server client function}}
{{Server client function}}
This function sets the size of a blip's icon.
This function sets the size of a blip's icon.

Revision as of 17:27, 30 November 2007

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

Syntax

bool setBlipSize ( blip theBlip, int iconSize )

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