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__
{{Server client function}}
This function sets the size of a blip's icon.
This function sets the size of a blip's icon.


Line 10: Line 11:


===Returns===
===Returns===
Returns an ''true'' if the blip's size was set sucessfully. Returns ''false'' if the [[element]] passed was not a [[blip]] or if the icon size passed was invalid.
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==  
==Example==  
Line 17: Line 18:
-- Retrieve a table containing all the blips that exist
-- Retrieve a table containing all the blips that exist
blips = getElementsByType ( "blip" )
blips = getElementsByType ( "blip" )
-- Loop through the list, storing the blip from the table in the variable blipValue
-- Loop through the list
for blipKey, blipValue in blips do
for blipKey, blipValue in blips do
-- Retrieve the blip's size into the variable 'blipSize'
-- Retrieve the blip's size into the variable 'blipSize'
Line 23: Line 24:
-- If the blip's size wasn't 2 (the default size) already
-- If the blip's size wasn't 2 (the default size) already
if ( blipSize ~= 2 ) then
if ( blipSize ~= 2 ) then
-- Set the blip's icon to the default
-- Set the size to the default
setBlipSize ( blipValue, 2 )
setBlipSize ( blipValue, 2 )
end
end

Revision as of 12:56, 16 August 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 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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetBlipSize?oldid=10491"