SetMarkerSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (10 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
This function sets the size of the specified marker. | 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== | ||
| Line 6: | Line 13: | ||
bool setMarkerSize ( marker theMarker, float size ) | bool setMarkerSize ( marker theMarker, float size ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Marker]]:setSize|size|getMarkerSize}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theMarker:''' The [[marker]] that you wish to set the size of. | *'''theMarker:''' The [[marker]] that you wish to set the size of. | ||
*'''size:''' | *'''size:''' A float representing new size of the marker. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if successful, ''false'' if failed. | Returns ''true'' if successful, ''false'' if failed. | ||
==Example== | ==Example 1== | ||
This example creates a marker at the position | This example creates a cylinder marker at the position 0, 0, 2 and sets its size to ''2.5''. | ||
<syntaxhighlight lang="lua"> | |||
local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 ) | |||
setMarkerSize ( newMarker, 2.5 ) | |||
</syntaxhighlight> | |||
==Example 2== | |||
This example creates a cylinder marker at the position 0, 0, 2 and plus its size by ''1'' by using 'getMarkerSize'. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local newMarker = createMarker ( 0, 0, 2, "cylinder", 1 ) | |||
setMarkerSize ( | setMarkerSize ( newMarker, getMarkerSize( newMarker ) + 1 ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
===Client=== | |||
{{Client marker functions}} | |||
===Server=== | |||
{{Marker functions}} | {{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
- createMarker
- getMarkerColor
- getMarkerCount
- getMarkerIcon
- getMarkerSize
- getMarkerTarget
- getMarkerType
- setMarkerColor
- setMarkerIcon
- setMarkerSize
- setMarkerTarget
- setMarkerType
- isElementWithinMarker
Server
Shared
- createMarker
- getMarkerColor
- getMarkerCount
- getMarkerIcon
- getMarkerSize
- getMarkerTarget
- getMarkerType
- setMarkerColor
- setMarkerIcon
- setMarkerSize
- setMarkerTarget
- setMarkerType
- isElementWithinMarker