AttachElementToElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 10: Line 10:
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theElement:''' The element to be attached
*'''theElement:''' The element to be attached.
*'''theAttachToElement:''' The element to attach the first to
*'''theAttachToElement:''' The element to attach the first to.


<!-- Only include this section below if there are optional arguments -->
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''xOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0)
*'''xOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0).
*'''yOffset:''' The y offset (default 0)
*'''yOffset:''' The y offset (default 0).
*'''zOffset:''' The z offset (default 0)
*'''zOffset:''' The z offset (default 0).


===Returns===
===Returns===
Line 37: Line 37:
==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{FunctionArea_functions}}
{{Element_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function
[[Category:Incomplete]] <!-- leave this unless you complete the function -->

Revision as of 00:59, 14 December 2006

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 xOffset, float yOffset, float zOffset ] )

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.

  • xOffset: The x offset, if you want the elements to be a certain distance from one another (default 0).
  • yOffset: The y offset (default 0).
  • zOffset: The z offset (default 0).

Returns

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

Example

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

See Also