GetMarkerType

From Multi Theft Auto: Wiki
Revision as of 12:55, 22 April 2007 by Jbeta (talk | contribs) (replaced the example)
Jump to navigation Jump to search

This function returns a marker's type.

Syntax

string getMarkerType ( marker theMarker )

Required Arguments

  • theMarker: A marker element referencing the specified marker.

Returns

Returns false if the marker passed is invalid, or one of the following strings:

    • "checkpoint": A race checkpoint. These are very tall, but not infinite, light pillars. Checkpoints snap to ground and become invisible after going over a certain Z height.
    • "ring": Doughnut shaped ring, normally used for aircraft.
    • "cylinder": Small glowing ground ring. These are the glow markers you walk into to activate missions or events in single player.
    • "arrow": Arrow pointing down. These are the arrows on the doors you can enter in single player, except MTA's are not animated by default.
    • "corona": A glowing ball of light.

Example

This function creates a default marker at a given position and outputs its type.

function createMarkerAndOutputType ( x, y, z )
	-- we create the marker
	local theMarker = createMarker ( x, y, z )
	-- then get its type,
	local markerType = getMarkerType (marker)
	-- output it,
	outputChatBox ( "It's a " .. markerType .. " marker!" )
	-- and return the created marker element where this function was called
	return theMarker
end

See Also