SetMarkerType

2007-07-22T18:17:02Z

Slush: /* Example */

__NOTOC__
This function changes a marker's type.

==Syntax==
server:
<syntaxhighlight lang="lua">bool setMarkerType ( marker theMarker, string markerType )</syntaxhighlight>
client:
<syntaxhighlight lang="lua">marker setMarkerType ( marker theMarker, string markerType )</syntaxhighlight>

===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.
* '''markerType''': A string denoting the marker type. Valid values are:
{{Marker types}}

==Returns==
Returns ''true'' if the marker type was changed, ''false'' if it wasn't or marker values were invalid.

==Example==
This function changes all existing markers' type to the specified one (server side).
<syntaxhighlight lang="lua">
function changeAllMarkersType ( newMarkerType )
-- we store a table with all markers
local allMarkers = getElementsByType( "marker" )
-- for each marker in it,
for index, aMarker in ipairs(allMarkers) do
-- set its type to the one passed to this function
setMarkerType( aMarker, newMarkerType )
end
end
</syntaxhighlight>

==See Also==
{{Marker functions}}

Multi Theft Auto: Wiki - User contributions [en]

SetMarkerType