CreateElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Cleanup, added Template:Needs Checking: createElement doesn't check for hardcoded types, syntax should be obsoleted)
m (Добавление языков)
 
(9 intermediate revisions by 8 users not shown)
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}}
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.
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==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element createElement ( string elementID, string elementType )
element createElement ( string elementType, [ string elementID = nil ] )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Element]]}}


===Required Arguments===
===Required Arguments===
*'''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.
*'''elementType:''' The type of element being created.


===Returns===
===Returns===
Line 20: Line 24:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
blueTeamFlag = createElement( "blue", "flag" )
blueTeamFlag = createElement( "flag", "blue" )
</syntaxhighlight>
</syntaxhighlight>


Line 30: Line 34:
==See Also==  
==See Also==  
{{Element functions}}
{{Element functions}}
[[en:createElement]]
[[ru:createElement]]

Latest revision as of 19:52, 15 April 2021

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 ] )

OOP Syntax Help! I don't understand this!

Method: Element(...)


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