GetBlipSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added OOP syntax)
m (Fixed positioning of oop)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">int getBlipSize ( blip theBlip )</syntaxhighlight>  
<syntaxhighlight lang="lua">int getBlipSize ( blip theBlip )</syntaxhighlight>  
{{OOP||getSize|size|setBlipSize}}


===Required Arguments===  
===Required Arguments===  
*'''theBlip:''' The blip you wish to get the size of.
*'''theBlip:''' The blip you wish to get the size of.
{{OOP||getSize|size|setBlipSize}}


===Returns===
===Returns===

Revision as of 01:59, 26 June 2014

This function gets the size of a blip.

Syntax

int getBlipSize ( blip theBlip )

OOP Syntax Help! I don't understand this!

Method: getSize(...)
Variable: .size
Counterpart: setBlipSize


Required Arguments

  • theBlip: The blip you wish to get the size of.

Returns

Returns an int indicating the size of the blip. The default value is 2.

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, storing the blip from the table in the variable blipValue
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 blip's size to the default
		setBlipSize ( blipValue, 2 )
	end
end

See Also