SetMarkerIcon: Difference between revisions

Revision as of 12:08, 10 October 2023

This function allows changing the icon of a checkpoint marker.

bool setMarkerIcon ( marker theMarker, string icon )

OOP Syntax Help! I don't understand this!

Method: Marker:setIcon(...)

Variable: .icon

Counterpart: getMarkerIcon

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)

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')

@@ Line 4: / Line 4: @@
 ==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}}
 ===Required Arguments===
 * '''theMarker:''' The [[marker]] to change the visual style of
@@ Line 12: / Line 15: @@
 **'''"arrow"''': Arrow icon
 **'''"finish"''': Finish icon (at end of race)
-<!-- This example is wrong, the marker is not created if you check with 'isElement(theMarker)' -->
 ==Example==
 This example creates a finish marker as you'd expect for the end of a race.
 <syntaxhighlight lang="lua">
-theMarker = createMarker ( 1000, 1000, 1000, 0, 255, 0, 0 )
+local marker = createMarker(4,4,4 'checkpoint', 10, 255,0,0)
-setMarkerIcon ( theMarker, "finish" )
+setMarkerIcon(marker, 'finish')
 </syntaxhighlight>
 ==See Also==
 {{Marker functions}}