AttachElementToElement: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
JonChappell (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function attaches one element to another, so that the second one follows the first whenever it moves. | |||
==Syntax== | ==Syntax== | ||
| Line 11: | 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 | ||
*'''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) | ||
*''' | *'''yOffset:''' The y offset (default 0) | ||
*'''zOffset:''' The z offset (default 0) | |||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ''true'' if | Returns ''true'' if the attaching process was successful, ''false'' otherwise. | ||
==Example== | ==Example== | ||
Revision as of 00:58, 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
Template:FunctionArea functions -- leave this unless you complete the function