CreateElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Example: minor fix)
No edit summary
Line 7: Line 7:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element createElement ( string elementType, [ string elementID ] )
element createElement ( string elementType, [ string elementID = nil ] )
</syntaxhighlight>
</syntaxhighlight>


Revision as of 07:19, 6 June 2012

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.

Elements created using this function are placed in the element tree with their parent as the 'dynamic' map element.

Syntax

element createElement ( string elementType, [ string elementID = nil ] )

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( "flag", "blue" )

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


Retrieved from "https://wiki.multitheftauto.com/wiki/CreateElement?oldid=31339"