GetElementParent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
Line 7: Line 7:
element getElementParent ( element theElement )   
element getElementParent ( element theElement )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getParent|parent|}}


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

Revision as of 16:21, 16 August 2014

This function is used to determine the parent of an element.

Syntax

element getElementParent ( element theElement )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:getParent(...)
Variable: .parent


Required Arguments

  • theElement: The child of the parent element you want returned.

Returns

This returns the parent as an element. It returns false if theElement is invalid, or is the root node.

Example

Click to collapse [-]
Server

Consider the following map file: 

<spawngroup id="red">
   <spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>
   <spawnpoint id="spawnpoint_1" posX="2508.060546875" posY="2780.3647460938" posZ="10.8203125" rot="270" skin="285"/>
</spawngroup>
<spawngroup id="blue">
   <spawnpoint id="spawnpoint_5" posX="2733.4184570313" posY="2753.1276855469" posZ="10.8203125" rot="90" skin="124"/>
   <spawnpoint id="spawnpoint_6" posX="2733.5258789063" posY="2748.1110839844" posZ="10.8203125" rot="90" skin="125"/>
</spawngroup>

This function determines a spawnpoint's parent element, and announces its ID: 

function spawnpointUse ( thePlayer )             -- this function gets called whenever a spawnpoint is used
   theSpawnGroup = getElementParent ( source )   -- get the spawnpoint's parent element
   -- announce the parent's ID and the player who spawned there:
   outputChatBox ( getPlayerName ( thePlayer ) .. " spawned at team " .. getElementID ( theSpawnGroup ) .. "'s spawnpoint." )
   -- Example output: "Joe spawned at team blue's spawnpoint."
end
addEventHandler ( "onSpawnpointUse", getRootElement(), spawnpointUse )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementParent?oldid=41455"