SetMarkerSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(16 intermediate revisions by 11 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function sets the size of the specified marker. The function returns false if it fails.
This function sets the size of the specified marker.
 
Setting negative value will "flip" the marker, do nothing or make it invisible:
* '''cylinder''' or '''arrow''': upside down
* '''ring''': inside out
* '''checkpoint''': disappear
* '''corona''': bigger


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setMarkerSize ( marker marker, float size )</syntaxhighlight>
<syntaxhighlight lang="lua">
bool setMarkerSize ( marker theMarker, float size )
</syntaxhighlight>
{{OOP||[[Marker]]:setSize|size|getMarkerSize}}
===Required Arguments===
*'''theMarker:''' The [[marker]] that you wish to set the size of.
*'''size:''' A float representing new size of the marker.
 
===Returns===
Returns ''true'' if successful, ''false'' if failed.


===Required Arguments===
==Example 1==
*'''marker''': The [[marker]] that you wish to retrieve the size of.
This example creates a cylinder marker at the position 0, 0, 2 and sets its size to ''2.5''.
*'''size''': The new size of the marker.
<syntaxhighlight lang="lua">
local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 )
setMarkerSize ( newMarker, 2.5 )
</syntaxhighlight>


==Example==
==Example 2==
<syntaxhighlight lang="lua">newmarker = createMarker ( 1, 1000, 1000, 1000, 1,0,0 )
This example creates a cylinder marker at the position 0, 0, 2 and plus its size by ''1'' by using 'getMarkerSize'.
setMarkerSize ( newmarker, 2.5)</syntaxhighlight>
<syntaxhighlight lang="lua">
local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 )
setMarkerSize ( newMarker, getMarkerSize( newMarker ) + 1 )
</syntaxhighlight>


==See Also==
==See Also==
{{Marker}}
===Client===
{{Client marker functions}}
===Server===
{{Marker functions}}

Latest revision as of 13:17, 10 October 2023

This function sets the size of the specified marker.

Setting negative value will "flip" the marker, do nothing or make it invisible:

  • cylinder or arrow: upside down
  • ring: inside out
  • checkpoint: disappear
  • corona: bigger

Syntax

bool setMarkerSize ( marker theMarker, float size )

OOP Syntax Help! I don't understand this!

Method: Marker:setSize(...)
Variable: .size
Counterpart: getMarkerSize


Required Arguments

  • theMarker: The marker that you wish to set the size of.
  • size: A float representing new size of the marker.

Returns

Returns true if successful, false if failed.

Example 1

This example creates a cylinder marker at the position 0, 0, 2 and sets its size to 2.5. 

local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 )
setMarkerSize ( newMarker, 2.5 )

Example 2

This example creates a cylinder marker at the position 0, 0, 2 and plus its size by 1 by using 'getMarkerSize'. 

local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 )
setMarkerSize ( newMarker, getMarkerSize( newMarker ) + 1 )

See Also

Client

Shared


Server

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/SetMarkerSize?oldid=78153"