CloneElement: Difference between revisions

Latest revision as of 22:29, 6 September 2024

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.

Players are not the only elements that cannot be cloned. This list also includes remoteclients, and console elements.

The cloned element will be placed on the element tree as a child of the same parent as the cloned element.

Syntax

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

OOP Syntax Help! I don't understand this!

Method: element:clone(...)

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

Note: if 'cloneChildren' is true, the position floats will be offsets from the cloned element's position.

Returns

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

Example

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 )

@@ Line 1: / Line 1: @@
 __NOTOC__
-[[Category:Incomplete]]
+{{Server function}}
-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.
+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.
-Players are not the only elements that cannot be cloned. This list also includes remoteclinets, and console elements.
+Players are not the only elements that cannot be cloned. This list also includes remoteclients, and console elements.
-The cloned element will be placed on the element tree as a child of the same parent as the cloned element.
+The cloned element will be placed on the [[element tree]] as a child of the same parent as the cloned element.
 ==Syntax==
 <syntaxhighlight lang="lua">
-element cloneElement ( element theElement, [ float xOffset = 0, float yOffset = 0, float zOffset = 0, bool cloneChildren = false ] )
+element cloneElement ( element theElement, [ float xPos = 0, float yPos = 0, float zPos = 0, bool cloneChildren = false ] )
 </syntaxhighlight>
+{{OOP||[[element]]:clone||}}
 ===Required Arguments===
@@ Line 17: / Line 18: @@
 ===Optional Arguments===
 {{OptionalArg}}
-* '''xOffset''': A floating point number representing the offset from the cloned element's X coordinate on the map.
+* '''xPos''': A floating point number representing the X coordinate on the map.
-* '''yOffset''': A floating point number representing the offset from the cloned element's Y coordinate on the map.
+* '''yPos''': A floating point number representing the Y coordinate on the map.
-* '''zOffset''': A floating point number representing the offset from the cloned element's Z 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.
+'''Note: if 'cloneChildren' is true, the position floats will be offsets from the cloned element's position.'''
 ===Returns===
-Returns the handle of the new cloned element of the parent.
+Returns the handle of the new cloned element of the parent, ''false'' if invalid arguments were passed.
 ==Example==
-This example clones the vehicle a player is in.
+This example clones the vehicle a player is in.  This allows carrying over of the current state of the vehicle, including mods, for example.
 <syntaxhighlight lang="lua">
-if ( command == "clone" ) then
+function cloneVehicle ( thePlayer, commandName )
-  x, y, z = getElementPosition ( source ) -- get the position of the player
+	local occupiedVehicle = getPedOccupiedVehicle ( thePlayer ) -- get the player's vehicle
-  clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of 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 )
 </syntaxhighlight>
 ==See Also==
-{{Element functions}}
+{{Element_functions|server}}