SetMarkerIcon: Difference between revisions

Latest revision as of 15:44, 4 July 2024

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. Only 5 arrows can be visible at the same time.
- "finish": Finish icon (at end of race)

This example creates a finish marker as you'd expect for the end of a race.

local newMarker = createMarker ( 0, 0, 2, "checkpoint", 1, 255, 0, 0) 
setMarkerIcon ( newMarker, "finish" )

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+{{Server client function}}
-This function sets the icon type for a marker.
+This function allows changing the icon of a checkpoint marker.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setMarkerIcon ( marker marker, int icon )</syntaxhighlight>
+<syntaxhighlight lang="lua">
+bool setMarkerIcon ( marker theMarker, string icon )
+</syntaxhighlight>
+{{OOP||[[Marker]]:setIcon|icon|getMarkerIcon}}
 ===Required Arguments===
-* '''marker''': A [[marker]] class referencing the specified marker.
+* '''theMarker:''' The [[marker]] to change the visual style of
-* '''icon''': An integer (whole number) referring to the icon of marker (see below).
+* '''icon:''' A string referring to the type of icon, acceptable values are:
+**'''"none"''': No icon
-==Acceptable icon values==
+**'''"arrow"''': Arrow icon. Only 5 arrows can be visible at the same time.
-* '''0''': No icon
+**'''"finish"''': Finish icon (at end of race)
-* '''1''': Arrow icon
-* '''2''': Finish icon
 ==Example==
-<syntaxhighlight lang="lua">marker = createMarker ( 1000, 1000, 1000, "checkpoint", 255, 0, 0 )
+This example creates a finish marker as you'd expect for the end of a race.
-setMarkerIcon ( marker, 1 )</syntaxhighlight>
+<syntaxhighlight lang="lua">
+local newMarker = createMarker ( 0, 0, 2, "checkpoint", 1, 255, 0, 0)
+setMarkerIcon ( newMarker, "finish" )
+</syntaxhighlight>
 ==See Also==
 {{Marker functions}}