GetElementByID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
m (fix oop syntax |)
Line 8: Line 8:
element getElementByID ( string id [, int index = 0 ] )   
element getElementByID ( string id [, int index = 0 ] )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getByID||}}
{{OOP|This function is a static function underneath the Element class.|[[element]]:getByID||}}


===Required Arguments===  
===Required Arguments===  

Revision as of 03:30, 1 January 2015

This function returns an element from the specified ID. If more than one element with the same ID exists, only the first one in the order it appears in the XML tree will be returned by this function.

[[{{{image}}}|link=|]] Note: The ID in this context is the value of the 'id' data item of the element (the id=".." attribute in the .map file), NOT the model ID, weapon ID or similiar.

Syntax

element getElementByID ( string id [, int index = 0 ] )

OOP Syntax Help! I don't understand this!

Note: This function is a static function underneath the Element class.
Method: element:getByID(...)


Required Arguments

  • id: The ID of the element as it appears in the XML file or as set by setElementID.

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.

  • index: If there are two or more elements of the same ID it will return the element with the specified index starting at 0.

Returns

Returns the element with the given ID, or false if no such element exists.

Example

Assuming we have this in the .map file: 

<vehicle id="vipVehicle" posX="10" posY="10" posZ="4" model="602" />

Then this example would retrieve the element and output the vehicle name. 

function showVipVehicle()
	local vipVehicle = getElementByID("vipVehicle")
	outputChatBox("Vip Vehicle is a: "..getVehicleName(vipVehicle))
end
addCommandHandler("vipVehicle",showVipVehicle)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementByID?oldid=43628"