createMarker | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

createMarker

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function creates a marker. A marker is a 3D model in the world that can highlight a particular point or area, often used to instruct players where to go to perform actions such as entering buildings.

Caution

When using type "arrow" markers, you may experience positioning issues. This is a known issue with how GTA creates these types of markers. It is recommended you keep the position at least 1 game unit above the ground to avoid issues.

Caution

"cylinder" marker type doesn't have the same size for collisions and visible textures. Note that the marker collisions are around 10-20% bigger than the visible texture.

OOP Syntax Help! I don't understand this!

Syntax 

marker createMarker ( float x, float y, float z, [ string theType = "checkpoint", float size = 4.0, int r = 0, int g = 0, int b = 255, int a = 255, bool ignoreAlphaLimits = false ] )
Required Arguments
  • x: A floating point number representing the X coordinate on the map.
  • y: A floating point number representing the Y coordinate on the map.
  • z: A floating point number representing the Z coordinate on the map.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • theType (default: "checkpoint"): The visual type of the marker to be created. Possible values: "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.
  • size (default: 4.0): The diameter of the marker to be created, in meters.
  • r (default: 0): An integer number representing the amount of red to use in the colouring of the marker (0 - 255).
  • g (default: 0): An integer number representing the amount of green to use in the colouring of the marker (0 - 255).
  • b (default: 255): An integer number representing the amount of blue to use in the colouring of the marker (0 - 255).
  • a (default: 255): An integer number representing the amount of alpha to use in the colouring of the marker (0 - 255 where 0 is transparent and 255 is opaque).
  • ignoreAlphaLimits (default: false): MISSING_PARAM_DESC

Returns

  • marker: value

Returns the marker element that was created, or false if the arguments are incorrect.

Code Examples

server

This example creates a marker next to the player when they type 'createmarker':

-- this function is called whenever someone types 'createmarker' in the chat:
function chatCreateMarker ( thePlayer, commandName )
   if ( thePlayer ) then
      local x, y, z = getElementPosition ( thePlayer ) -- get the player's position
      -- create a cylindrical marker next to the player:
      local theMarker = createMarker ( x + 2, y + 2, z, "cylinder", 1.5, 255, 255, 0, 170 )
      if isElement ( theMarker ) then -- check if the marker was created successfully
         outputChatBox ( "Marker created successfully", thePlayer, 0, 255, 0 )
      else
         outputChatBox ( "Failed to create marker", thePlayer, 255, 0, 0 )
      end
   end
end
addCommandHandler ( "createmarker", chatCreateMarker )

See Also

Marker Functions
Marker Events
Reference