AttachElementToElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 30: Line 30:
==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentance -->
This example does...
This function adds a tank on top of a player (for extra defense).
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
addCommandHandler( "hat", "tankHat" )
blabhalbalhb --abababa
function tankHat( source )
--This line does this...
local x, y, z = getElementPosition( source ) --Getting
mooo
local tank = createVehicle( 432, x, y, z + 5 )
attachElementToElement( tank, source, 0, 0, 5 )
</syntaxhighlight>
</syntaxhighlight>


Revision as of 11:39, 19 April 2007

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 ) --Getting
local tank = createVehicle( 432, x, y, z + 5 )
attachElementToElement( tank, source, 0, 0, 5 )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AttachElementToElement?oldid=8053"