GetMarkerIcon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
This function returns the icon name for a marker.
This function returns the icon name for a marker.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">string getMarkerIcon ( marker theMarker )</syntaxhighlight>
<syntaxhighlight lang="lua">string getMarkerIcon ( marker theMarker )</syntaxhighlight>
 
{{OOP||[[Marker]]:getIcon|icon|setMarkerIcon}}
===Required Arguments===
===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.
* '''theMarker''': A [[marker]] element referencing the specified marker.
Line 15: Line 16:


==Example==
==Example==
<syntaxhighlight lang="lua">marker = createMarker ( 1000, 1000,1000, "checkpoint", 255, 0, 0 )
<syntaxhighlight lang="lua">
icon = getMarkerIcon (marker)
newmarker = createMarker ( 1000, 1000,1000, "checkpoint", 255, 0, 0 )
icon = getMarkerIcon ( newmarker )
outputChatBox ( "The default marker icon is " .. icon )
outputChatBox ( "The default marker icon is " .. icon )
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 01:50, 13 December 2014

This function returns the icon name for a marker.

Syntax

string getMarkerIcon ( marker theMarker )

OOP Syntax Help! I don't understand this!

Method: Marker:getIcon(...)
Variable: .icon
Counterpart: setMarkerIcon


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

newmarker = createMarker ( 1000, 1000,1000, "checkpoint", 255, 0, 0 )
icon = getMarkerIcon ( newmarker )
outputChatBox ( "The default marker icon is " .. icon )

See Also