AttachElementToElement

From Multi Theft Auto: Wiki
Revision as of 11:41, 19 April 2007 by Black Dragon (talk | contribs)
Jump to navigation Jump to search
Dialog-information.png This article needs checking.

Reason(s): What kinds of elements can be attached together? --jbeta

This function attaches one element to another, so that the second one follows the first whenever it moves.

Syntax

bool attachElementToElement ( element theElement, element theAttachToElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ] )

Required Arguments

  • theElement: The element to be attached.
  • theAttachToElement: The element to attach the first to.

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.

  • xPosOffset: The x offset, if you want the elements to be a certain distance from one another (default 0).
  • yPosOffset: The y offset (default 0).
  • zPosOffset: The z offset (default 0).
  • xRotOffset: The x offset (default 0).
  • yRotOffset: The y offset (default 0).
  • zRotOffset: The z offset (default 0).

Returns

Returns true if the attaching process was successful, false otherwise.

Example

This function adds a tank on top of a player (for extra defense).

addCommandHandler( "hat", "tankHat" )
function tankHat( source )
local x, y, z = getElementPosition( source ) --Get the players position
local tank = createVehicle( 432, x, y, z + 5 ) --Create a tank
attachElementToElement( tank, source, 0, 0, 5 ) --Attach the tank to the player.
end

See Also