CreateElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Needs Checking|createElement doesn't actually restrict element types. You can create any abstract element with a hardcoded type - I'm not really sure if this is a bug or a feature.<br>Also, the ID element should be optional and go after the type. --[[User:Jbeta|jbeta]] 12:26, 25 September 2007 (CDT)}}
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
Line 6: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element createElement ( string elementType, string elementID )
element createElement ( string elementType, [ string elementID ] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''elementType:''' The type of element being created.
*'''elementType:''' The type of element being created.
===Optional Arguments===
*'''elementID:''' The ID of the element being created.
*'''elementID:''' The ID of the element being created.



Revision as of 15:26, 18 October 2007

This function is used to create a new dummy element in the element tree which do not necessarily represent an entity within the San Andreas world. A common use for this function is for creating custom elements, such as a Flag or a Base.

Syntax

element createElement ( string elementType, [ string elementID ] )

Required Arguments

  • elementType: The type of element being created.

Optional Arguments

  • elementID: The ID of the element being created.

Returns

Returns the element if it was successfully created. Returns false if the arguments are wrong.

Example

This example creates a "flag" element, named "blue", which will be at the resource's dynamic map.

blueTeamFlag = createElement( "blue", "flag" )

Except for it being placed in a different map root, that line will have the same effect as having this in a .map file:

<flag id="blue" />

See Also