CreateMarker

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.

There are various limits that govern the maximum number of each type that can be visible at once. These are:

• Coronas: 32
• Checkpoints, Rings, Cylinders and Arrows combined: 32

You are able to create as many markers as you wish (memory and element limit permitting), but the player will only be able to see the nearest ones up to the limit.

Syntax

Click to collapse [-]

Server

addCommandHandler("marker",
function marker( source, commandName)
local x, y, z = getElementPosition ( source )
marker = createMarker ( x, y, z, "cylinder", 2, 255, 0, 0 )
end 
addCommandHandler ( "marker", marker )

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. For more information on optional arguments, see optional arguments.

• theType: 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: The diameter of the marker to be created, in meters.
• r: An integer number representing the amount of red to use in the colouring of the marker (0 - 255).
• g: An integer number representing the amount of green to use in the colouring of the marker (0 - 255).
• b: An integer number representing the amount of blue to use in the colouring of the marker (0 - 255).
• a: 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).
• visibleTo: Every element that is a child of this element can see the marker. See visibility.

Click to collapse [-]

Client

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 ] )

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. For more information on optional arguments, see optional arguments.

• theType: 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: The diameter of the marker to be created, in meters.
• r: An integer number representing the amount of red to use in the colouring of the marker (0 - 255).
• g: An integer number representing the amount of green to use in the colouring of the marker (0 - 255).
• b: An integer number representing the amount of blue to use in the colouring of the marker (0 - 255).
• a: 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).

Returns

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

Example

Click to collapse [-]

Example 1

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

-- this function is called whenever someone types 'createmarker' in the console:
function consoleCreateMarker ( 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 ( theMarker ) then -- check if the marker was created successfully
         outputConsole ( "Marker created successfully", thePlayer )
      else
         outputConsole ( "Failed to create marker", thePlayer )
      end
   end
end
addCommandHandler ( "createmarker", consoleCreateMarker )

Click to collapse [-]

Example 2

Create a marker at the coordinates 0, 0, 20:

createMarker ( 0, 0, 20 )

See Also

• createMarker
• getMarkerColor
• getMarkerCount
• getMarkerIcon
• getMarkerSize
• getMarkerTarget
ADDED/UPDATED IN VERSION 1.6.0 r22620:
getMarkerTargetArrowProperties
• getMarkerType
• setMarkerColor
• setMarkerIcon
• setMarkerSize
• setMarkerTarget
ADDED/UPDATED IN VERSION 1.6.0 r22620:
setMarkerTargetArrowProperties
• setMarkerType
• isElementWithinMarker