CreateElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Fixed argument order)
No edit summary
Line 12: Line 12:


===Returns===
===Returns===
Returns ''true'' if the element was successfully created. Returns ''false'' if the arguments are wrong or if the type is not allowed. Unallowed types include hard-coded MTA elements (such as "vehicle") and the type "dummy".
Returns the element if it was successfully created. Returns ''false'' if the arguments are wrong or if the type is not allowed. Unallowed types include hard-coded MTA elements (such as "vehicle") and the type "dummy".


==Example==
==Example==

Revision as of 09:59, 4 March 2007

This function is used to create dummy elements in the element table, but do not have a counterpart within the San Andreas world. A common use for this function is for creating group or team elements.

Syntax

element createElement ( string name, string type )

Required Arguments

  • name: The ID of the element being created.
  • type: The type of element being created. This value will be returned if getElementType is used on it.

Returns

Returns the element if it was successfully created. Returns false if the arguments are wrong or if the type is not allowed. Unallowed types include hard-coded MTA elements (such as "vehicle") and the type "dummy".

Example

This example creates a squad element called 'Alpha', which will appear just off root on the element table:

alphahandle = createElement( "Alpha", "squad" )

See Also