CloneElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element cloneElement ( element theElement, [ float xPos, float yPos, float zPos, bool cloneChildren=false ] )   
element cloneElement ( element theElement, [ float xOffset, float yOffset, float zOffset, bool cloneChildren=false ] )   
</syntaxhighlight>  
</syntaxhighlight>  


Line 11: Line 11:


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


Line 24: Line 24:
if ( command == "clone" ) then
if ( command == "clone" ) then
   x, y, z = getElementPosition ( source ) -- get the position of the player
   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
   clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of the player's vehicle
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 14:55, 16 August 2006

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 xOffset, float yOffset, float zOffset, bool cloneChildren=false ] )

Required Arguments

  • theElement: The element that you wish to clone.

Optional Arguments

  • xPos: A floating point number representing the offset from the cloned element's X coordinate on the map.
  • yPos: A floating point number representing the offset from the cloned element's Y coordinate on the map.
  • zPos: A floating point number representing the offset from the cloned element's 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 ), 5, 0, 0 ) -- create a clone of the player's vehicle
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/CloneElement?oldid=4395"