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

cloneElement

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 clones (creates an exact copy of) an already existing element. The root node, and player elements, cannot be cloned. If a player element is a child of an element that is cloned, it will be skipped, along with the elements that exist as a child to the player element.

OOP Syntax Help! I don't understand this!

Syntax 

element cloneElement ( element theElement, [ float xPos = 0, float yPos = 0, float zPos = 0, bool cloneChildren = false ] )
Required Arguments
  • theElement: The element that you wish to clone.
Optional Arguments

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

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

Returns

  • element: value

Returns the handle of the new cloned element of the parent, false if invalid arguments were passed.

Code Examples

shared

This example clones the vehicle a player is in. This allows carrying over of the current state of the vehicle, including mods, for example.

function cloneVehicle ( thePlayer, commandName )
  local occupiedVehicle = getPedOccupiedVehicle ( thePlayer ) -- get the player's vehicle
  if occupiedVehicle then -- If the player is actually in a vehicle
    local x, y, z = getElementPosition ( occupiedVehicle )   -- get the vehicle's position
    local clone = cloneElement ( occupiedVehicle, x+5, y, z ) -- create a clone of the vehicle near it
  else
    outputChatBox ( "You can't clone a vehicle if you're not in a vehicle", thePlayer, 255, 0, 0 )
  end
end
addCommandHandler ( "clone", cloneVehicle )

See Also

Element Functions
Element Events
Reference