GetMarkerType: Difference between revisions

"checkpoint": Checkpoint
"ring": Ring (doughnut-shaped)
"cylinder": Cylinder
"arrow": Animated arrow pointing down
"corona": Glowing area

Revision as of 15:07, 14 August 2006

This function returns an type for a marker.

string getMarkerType ( marker theMarker)

Returns false if the marker passed is invalid or a string containing one of the following:

marker = createMarker ( 1000, 1000,1000, 0, 255, 0, 0 )
gettype = getMarkerType (marker)
outputChatBox ( "Its a " .. gettype .. " marker!" )

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+This function returns an type for a marker.
-This function returns an ID number that corresponds to a particular type of marker.
 ==Syntax==
-<syntaxhighlight lang="lua">int getMarkerType ( marker marker)</syntaxhighlight>
+<syntaxhighlight lang="lua">string getMarkerType ( marker theMarker)</syntaxhighlight>
 ===Required Arguments===
-* '''marker''': A [[marker]] class referencing the specified marker.
+* '''theMarker''': A [[marker]] element referencing the specified marker.
-==Return Values==
+===Returns===
+Returns ''false'' if the marker passed is invalid or a string containing one of the following:
 * '''"checkpoint"''': Checkpoint
 * '''"ring"''': Ring (doughnut-shaped)
 * '''"cylinder"''': Cylinder
 * '''"arrow"''': Animated arrow pointing down
+* '''"corona"''': Glowing area
 ==Example==
 <syntaxhighlight lang="lua">marker = createMarker ( 1000, 1000,1000, 0, 255, 0, 0 )
 gettype = getMarkerType (marker)
-	if (gettype == 0)
+outputChatBox ( "Its a " .. gettype .. " marker!" )
-	      outputChatBox ("Checkpoint marker.")
+</syntaxhighlight>
-	else
-	      outputChatBox ("Corona marker.")
-	end</syntaxhighlight>
 ==See Also==
 {{Marker functions}}