GetMarkerType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(edit example)
mNo edit summary
Line 21: Line 21:
     -- we create the marker.
     -- we create the marker.
     theMarker = createMarker ( ... )
     theMarker = createMarker ( ... )
-- if the marker was created.
    -- if the marker was created.
     if isElement ( theMarker ) then
     if isElement ( theMarker ) then
-- then get its type.
        -- then get its type.
         local markerType = getMarkerType ( theMarker )
         local markerType = getMarkerType ( theMarker )
-- and output it.
        -- and output it.
         return outputChatBox ( "It's a " .. markerType .. " marker!" )
         return outputChatBox ( "It's a " .. markerType .. " marker!" )
     end
     end

Revision as of 13:31, 10 October 2023

This function returns a marker's type.

Syntax

string getMarkerType ( marker theMarker )

OOP Syntax Help! I don't understand this!

Method: Marker:getMarkerType(...)
Variable: .markerType
Counterpart: setMarkerType


Required Arguments

  • theMarker: A marker element referencing the specified marker.

Returns

  • Returns 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.

If an invalid marker is specified, false is returned.

Example

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

function createMarkerAndOutputType ( ... )
    -- we create the marker.
    theMarker = createMarker ( ... )
    -- if the marker was created.
    if isElement ( theMarker ) then
        -- then get its type.
        local markerType = getMarkerType ( theMarker )
        -- and output it.
        return outputChatBox ( "It's a " .. markerType .. " marker!" )
    end
end

-- Create a marker and show its type in chat.
createMarkerAndOutputType(0, 0, 2, "cylinder", 2)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetMarkerType?oldid=78156"