SetMarkerIcon: Difference between revisions
Jump to navigation
Jump to search
(hi mta staff, add note) |
m (Removed note, fixed example) |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setMarkerIcon ( marker theMarker, string icon )</syntaxhighlight> | <syntaxhighlight lang="lua"> | ||
bool setMarkerIcon ( marker theMarker, string icon ) | |||
</syntaxhighlight> | |||
{{OOP||[[Marker]]:setIcon|icon|getMarkerIcon}} | {{OOP||[[Marker]]:setIcon|icon|getMarkerIcon}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
* '''theMarker:''' The [[marker]] to change the visual style of | * '''theMarker:''' The [[marker]] to change the visual style of | ||
| Line 12: | Line 15: | ||
**'''"arrow"''': Arrow icon | **'''"arrow"''': Arrow icon | ||
**'''"finish"''': Finish icon (at end of race) | **'''"finish"''': Finish icon (at end of race) | ||
==Example== | ==Example== | ||
This example creates a finish marker as you'd expect for the end of a race. | This example creates a finish marker as you'd expect for the end of a race. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local marker = createMarker(4,4,4 'checkpoint', 10, 255,0,0) | |||
setMarkerIcon ( | setMarkerIcon(marker, 'finish') | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Marker functions}} | {{Marker functions}} | ||
Revision as of 12:08, 10 October 2023
This function allows changing the icon of a checkpoint marker.
Syntax
bool setMarkerIcon ( marker theMarker, string icon )
OOP Syntax Help! I don't understand this!
- Method: Marker:setIcon(...)
- Variable: .icon
- Counterpart: getMarkerIcon
Required Arguments
- theMarker: The marker to change the visual style of
- icon: A string referring to the type of icon, acceptable values are:
- "none": No icon
- "arrow": Arrow icon
- "finish": Finish icon (at end of race)
Example
This example creates a finish marker as you'd expect for the end of a race.
local marker = createMarker(4,4,4 'checkpoint', 10, 255,0,0) setMarkerIcon(marker, 'finish')
See Also
- createMarker
- getMarkerColor
- getMarkerCount
- getMarkerIcon
- getMarkerSize
- getMarkerTarget
- getMarkerType
- setMarkerColor
- setMarkerIcon
- setMarkerSize
- setMarkerTarget
- setMarkerType
- isElementWithinMarker