CreateMarker: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 6: Line 6:


==Syntax==
==Syntax==
  [[marker]] [[createMarker]] ( int id, float x, float y, float z, float r, float g, float b )
  [[marker]] [[createMarker]] ( x, y, z [, type, r, g, b ] )


===Required Arguments===
===Required Arguments===
* '''id''': The id number of the marker being created.
* '''x''': A floating point number representing the X coordinate on the map.
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y 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.
* '''z''': A floating point number representing the Z coordinate on the map.
* '''r''': A floating point number representing the amount of red to use in the colouring of the marker.
* '''type''': The visual type of the marker to be created. (0 = checkpoint, 1 = corona, ... TODO)
* '''g''': A floating point number representing the amount of green to use in the colouring of the marker.
* '''r''': An integer number representing the amount of red to use in the colouring of the marker.
* '''b''': A floating point number representing the amount of blue to use in the colouring of the marker.
* '''g''': An integer number representing the amount of green to use in the colouring of the marker.
* '''b''': An integer number representing the amount of blue to use in the colouring of the marker.


==Example==
==Example==

Revision as of 11:27, 30 March 2006


Dialog-information.png This article needs checking.

Reason(s): Should R,G,B be an optional argument?

Description

This function creates a marker and returns a handle to the created marker. If it fails, it will return false.

Syntax

marker createMarker ( x, y, z [, type, r, g, b ] )

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.
  • type: The visual type of the marker to be created. (0 = checkpoint, 1 = corona, ... TODO)
  • r: An integer number representing the amount of red to use in the colouring of the marker.
  • g: An integer number representing the amount of green to use in the colouring of the marker.
  • b: An integer number representing the amount of blue to use in the colouring of the marker.

Example

function onPlayerChat ( player, chat )
  if ( strtok ( chat, 1, 32 ) == "!createmarker" ) then
    x, y, z = getPlayerPosition ( player )
    createMarker ( 1, x + 5, y, z, 1,0,0 )
    playerPM ( player, "You got a red marker" )
  end
end