CloneElement

From Multi Theft Auto: Wiki
Revision as of 11:21, 16 August 2006 by MrJax (talk | contribs)
Jump to navigation Jump to search

This function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned.

Syntax

element cloneElement ( element theElement, [ float xPos, float yPos, float zPos, bool cloneChildren ] )  

Required Arguments

  • theElement: The element that you wish to clone.

Optional Arguments

  • xPos: A floating point number representing the X coordinate on the map.
  • yPos: A floating point number representing the Y coordinate on the map.
  • zPos: A floating point number representing the Z coordinate on the map.
  • cloneChildren: A boolean value representing whether or not the element's children will be cloned.

Returns

Returns the handle of the new cloned element of the parent.

Example

This example clones the vehicle a player is in.

if ( command == "clone" ) then
  x, y, z = getElementPosition ( source ) -- get the position of the player
  clone = cloneElement ( getPlayerOccupiedVehicle ( source ), x + 5, y, z ) -- create a clone of the player's vehicle
end

See Also