GetMarkerIcon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function returns the icon | This function returns the icon name for a marker. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">string getMarkerIcon ( marker theMarker )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 10: | Line 10: | ||
===Returns=== | ===Returns=== | ||
Returns ''false'' if the marker passed is invalid or a string containing one of the following: | Returns ''false'' if the marker passed is invalid or a string containing one of the following: | ||
* ''' | * '''"none"''': No icon | ||
* ''' | * '''"arrow"''': Arrow icon | ||
* ''' | * '''"finish"''': Finish (end-race) icon | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua">marker = createMarker ( 1000, 1000, 1000, "checkpoint", 255, 0, 0 ) | <syntaxhighlight lang="lua">marker = createMarker ( 1000, 1000,1000, "checkpoint", 255, 0, 0 ) | ||
icon = getMarkerIcon ( marker ) | icon = getMarkerIcon (marker) | ||
outputChatBox ( "marker | outputChatBox ( "The default marker icon is " .. icon ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Marker functions}} | {{Marker functions}} | ||
Revision as of 10:53, 24 September 2006
This function returns the icon name for a marker.
Syntax
string getMarkerIcon ( marker theMarker )
Required Arguments
- theMarker: A marker element referencing the specified marker.
Returns
Returns false if the marker passed is invalid or a string containing one of the following:
- "none": No icon
- "arrow": Arrow icon
- "finish": Finish (end-race) icon
Example
marker = createMarker ( 1000, 1000,1000, "checkpoint", 255, 0, 0 ) icon = getMarkerIcon (marker) outputChatBox ( "The default marker icon is " .. icon )
See Also
- createMarker
- getMarkerColor
- getMarkerCount
- getMarkerIcon
- getMarkerSize
- getMarkerTarget
- getMarkerType
- setMarkerColor
- setMarkerIcon
- setMarkerSize
- setMarkerTarget
- setMarkerType
- isElementWithinMarker