Element tree - Revision history

Pawcio: Undo revision 75616 by Absolwent (talk)

2022-10-24T08:12:49Z

Undo revision 75616 by Absolwent (talk)

← Older revision		Revision as of 08:12, 24 October 2022
Line 1:		Line 1:
	~~hacked~~ by ~~Absolwent Absolwent~~#~~8366~~		[[File:Tre.png\|frame\|Element tree]]
			MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

			If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

			All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

			==Tree elements==
			* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
			<syntaxhighlight lang="lua">
			getRootElement()
			</syntaxhighlight>
			* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
			<syntaxhighlight lang="lua">
			getResourceRootElement()
			</syntaxhighlight>
			* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
			** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

			==Example==
			This in an example of a serverside tree dumped to XML from a running server.
			''Please note that it is shortened on some places for the sake of overview.''
			<syntaxhighlight lang="xml">
			<root>
			<console/>
			<player dontRespawn="false"/>
			<player dontRespawn="false" lastSpawnarea=""/>
			<resource id="resourcebrowser"/>
			<resource id="ajax"/>
			<resource id="resourcemanager"/>
			<resource id="spawnmanager"/>
			<resource id="mapmanager"/>
			<resource id="runcode"/>
			<resource id="fr">
			<map id="dynamic">
			<vehicle/>
			</map>
			</resource>
			<resource id="elementbrowser"/>
			<resource id="assault">
			<map id="dynamic">
			<team/>
			<team/>
			<blip/>
			<marker/>
			<colshape/>
			<blip/>
			<blip/>
			</map>
			</resource>
			<resource id="as-farm">
			<map id="dynamic"/>
			<map id="as-farm.map">
			<spawngroup req="" type="attacker">
			<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
			</spawngroup>
			<objective id="first" type="checkpoint" description="Breach into the farm" ... />
			<pickup type="weapon" ... />
			</map>
			</resource>
			</root>
			</syntaxhighlight>
			===Explanation===
			This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

			Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

			The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

			==Practical application==
			Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.

			===Setting data for elements===
			If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).

			So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.
			<syntaxhighlight lang="lua">
			setMarkerSize ( root, 2.5 )
			</syntaxhighlight>

			The same can be done on any element, it is not restricted to the root element.

			===Map manager===
			The [[#Example\|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource\|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

			Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

			==Element browser==
			You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

			[[Category:Scripting Concepts]]

			[[hu:Element tree]]
			[[es:Árbol de elementos]]
			[[ru:Element tree]]
			[[pl:Element tree]]
			[[pt-br:Árvore de elementos]]

Absolwent: Replaced content with "hacked by Absolwent Absolwent#8366"

2022-10-24T08:05:15Z

Replaced content with "hacked by Absolwent Absolwent#8366"

← Older revision		Revision as of 08:05, 24 October 2022
Line 1:		Line 1:
	~~[[File:Tre.png\|frame\|Element tree]]~~		hacked by Absolwent Absolwent#8366
	MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by ~~scripts.~~

	If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

	All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

	~~==Tree elements==~~
	* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
	~~<syntaxhighlight lang="lua">~~
	~~getRootElement()~~
	~~</syntaxhighlight>~~
	* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
	~~<syntaxhighlight lang="lua">~~
	~~getResourceRootElement()~~
	~~</syntaxhighlight>~~
	* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
	** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

	~~==Example==~~
	~~This in an example of a serverside tree dumped to XML from a running server.~~
	~~''Please note that it is shortened on some places for the sake of overview.''~~
	~~<syntaxhighlight lang="xml">~~
	~~<root>~~
	~~<console/>~~
	~~<player dontRespawn="false"/>~~
	~~<player dontRespawn="false" lastSpawnarea=""/>~~
	~~<resource id="resourcebrowser"/>~~
	~~<resource id="ajax"/>~~
	~~<resource id="resourcemanager"/>~~
	~~<resource id="spawnmanager"/>~~
	~~<resource id="mapmanager"/>~~
	~~<resource id="runcode"/>~~
	~~<resource id="fr">~~
	~~<map id="dynamic">~~
	~~<vehicle/>~~
	~~</map>~~
	~~</resource>~~
	~~<resource id="elementbrowser"/>~~
	~~<resource id="assault">~~
	~~<map id="dynamic">~~
	~~<team/>~~
	~~<team/>~~
	~~<blip/>~~
	~~<marker/>~~
	~~<colshape/>~~
	~~<blip/>~~
	~~<blip/>~~
	~~</map>~~
	~~</resource>~~
	~~<resource id="as-farm">~~
	~~<map id="dynamic"/>~~
	~~<map id="as-farm.map">~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />~~
	~~</spawngroup>~~
	~~<objective id="first" type="checkpoint" description="Breach into the farm" ... />~~
	~~<pickup type="weapon" ... />~~
	~~</map>~~
	~~</resource>~~
	~~</root>~~
	~~</syntaxhighlight>~~
	~~===Explanation===~~
	This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

	Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

	The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

	~~==Practical application==~~
	~~Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.~~

	~~===Setting data for elements===~~
	~~If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).~~

	~~So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.~~
	~~<syntaxhighlight lang="lua">~~
	~~setMarkerSize ( root, 2.5 )~~
	~~</syntaxhighlight>~~

	~~The same can be done on any element, it is not restricted to the root element.~~

	~~===Map manager===~~
	~~The [[~~#Example\|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource\|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

	Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

	~~==Element browser==~~
	You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

	~~[[Category:Scripting Concepts]]~~

	~~[[hu:Element tree]]~~
	~~[[es:Árbol de elementos]]~~
	~~[[ru:Element tree]]~~
	~~[[pl:Element tree]]~~
	~~[[pt-br:Árvore de elementos]]~~

XLive: Undo revision 75264 by Borsuczek123 (talk)

2022-07-13T14:08:44Z

Undo revision 75264 by Borsuczek123 (talk)

← Older revision		Revision as of 14:08, 13 July 2022
Line 1:		Line 1:
	~~New wiki dicord~~: ~~discord~~.~~gg/a4u8XBfDpu~~		[[File:Tre.png\|frame\|Element tree]]
			MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

	~~El ernesto skorupino~~		If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

			All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

			==Tree elements==
			* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
			<syntaxhighlight lang="lua">
			getRootElement()
			</syntaxhighlight>
			* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
			<syntaxhighlight lang="lua">
			getResourceRootElement()
			</syntaxhighlight>
			* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
			** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

			==Example==
			This in an example of a serverside tree dumped to XML from a running server.
			''Please note that it is shortened on some places for the sake of overview.''
			<syntaxhighlight lang="xml">
			<root>
			<console/>
			<player dontRespawn="false"/>
			<player dontRespawn="false" lastSpawnarea=""/>
			<resource id="resourcebrowser"/>
			<resource id="ajax"/>
			<resource id="resourcemanager"/>
			<resource id="spawnmanager"/>
			<resource id="mapmanager"/>
			<resource id="runcode"/>
			<resource id="fr">
			<map id="dynamic">
			<vehicle/>
			</map>
			</resource>
			<resource id="elementbrowser"/>
			<resource id="assault">
			<map id="dynamic">
			<team/>
			<team/>
			<blip/>
			<marker/>
			<colshape/>
			<blip/>
			<blip/>
			</map>
			</resource>
			<resource id="as-farm">
			<map id="dynamic"/>
			<map id="as-farm.map">
			<spawngroup req="" type="attacker">
			<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
			</spawngroup>
			<spawngroup req="" type="attacker">
			<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
			</spawngroup>
			<objective id="first" type="checkpoint" description="Breach into the farm" ... />
			<pickup type="weapon" ... />
			</map>
			</resource>
			</root>
			</syntaxhighlight>
			===Explanation===
			This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

			Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

			The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

			==Practical application==
			Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.

			===Setting data for elements===
			If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).

			So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.
			<syntaxhighlight lang="lua">
			setMarkerSize ( root, 2.5 )
			</syntaxhighlight>

			The same can be done on any element, it is not restricted to the root element.

			===Map manager===
			The [[#Example\|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource\|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

			Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

			==Element browser==
			You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

			[[Category:Scripting Concepts]]

			[[hu:Element tree]]
			[[es:Árbol de elementos]]
			[[ru:Element tree]]
			[[pl:Element tree]]
			[[pt-br:Árvore de elementos]]

Borsuczek123: Replaced content with "New wiki dicord: discord.gg/a4u8XBfDpu El ernesto skorupino"

2022-07-13T13:33:53Z

Replaced content with "New wiki dicord: discord.gg/a4u8XBfDpu El ernesto skorupino"

← Older revision		Revision as of 13:33, 13 July 2022
Line 1:		Line 1:
	~~[[File~~:~~Tre.png\|frame\|Element tree]]~~		New wiki dicord: discord.gg/a4u8XBfDpu
	MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

	If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.		El ernesto skorupino

	All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

	~~==Tree elements==~~
	* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
	~~<syntaxhighlight lang="lua">~~
	~~getRootElement()~~
	~~</syntaxhighlight>~~
	* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
	~~<syntaxhighlight lang="lua">~~
	~~getResourceRootElement()~~
	~~</syntaxhighlight>~~
	* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
	** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

	~~==Example==~~
	~~This in an example of a serverside tree dumped to XML from a running server.~~
	~~''Please note that it is shortened on some places for the sake of overview.''~~
	~~<syntaxhighlight lang="xml">~~
	~~<root>~~
	~~<console/>~~
	~~<player dontRespawn="false"/>~~
	~~<player dontRespawn="false" lastSpawnarea=""/>~~
	~~<resource id="resourcebrowser"/>~~
	~~<resource id="ajax"/>~~
	~~<resource id="resourcemanager"/>~~
	~~<resource id="spawnmanager"/>~~
	~~<resource id="mapmanager"/>~~
	~~<resource id="runcode"/>~~
	~~<resource id="fr">~~
	~~<map id="dynamic">~~
	~~<vehicle/>~~
	~~</map>~~
	~~</resource>~~
	~~<resource id="elementbrowser"/>~~
	~~<resource id="assault">~~
	~~<map id="dynamic">~~
	~~<team/>~~
	~~<team/>~~
	~~<blip/>~~
	~~<marker/>~~
	~~<colshape/>~~
	~~<blip/>~~
	~~<blip/>~~
	~~</map>~~
	~~</resource>~~
	~~<resource id="as-farm">~~
	~~<map id="dynamic"/>~~
	~~<map id="as-farm.map">~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />~~
	~~</spawngroup>~~
	~~<spawngroup req="" type="attacker">~~
	~~<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />~~
	~~</spawngroup>~~
	~~<objective id="first" type="checkpoint" description="Breach into the farm" ... />~~
	~~<pickup type="weapon" ... />~~
	~~</map>~~
	~~</resource>~~
	~~</root>~~
	~~</syntaxhighlight>~~
	~~===Explanation===~~
	This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

	Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

	The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

	~~==Practical application==~~
	~~Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.~~

	~~===Setting data for elements===~~
	~~If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).~~

	~~So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.~~
	~~<syntaxhighlight lang="lua">~~
	~~setMarkerSize ( root, 2.5 )~~
	~~</syntaxhighlight>~~

	~~The same can be done on any element, it is not restricted to the root element.~~

	~~===Map manager===~~
	The [[#Example\|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource\|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

	Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

	~~==Element browser==~~
	You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

	~~[[Category:Scripting Concepts]]~~

	~~[[hu:Element tree]]~~
	~~[[es:Árbol de elementos]]~~
	~~[[ru:Element tree]]~~
	~~[[pl:Element tree]]~~
	~~[[pt-br:Árvore de elementos]]~~

Vampire: Fixed a typo in Practical application and added a new page to translate this

2022-01-31T17:17:09Z

Fixed a typo in Practical application and added a new page to translate this

← Older revision		Revision as of 17:17, 31 January 2022
Line 77:		Line 77:
	The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].		The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

	==~~Pratical~~ application==		==Practical application==
	Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.		Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.

Line 104:		Line 104:
	[[ru:Element tree]]		[[ru:Element tree]]
	[[pl:Element tree]]		[[pl:Element tree]]
			[[pt-br:Árvore de elementos]]

BotGrzesieKK: adding pl/element tree

2021-08-21T10:53:25Z

adding pl/element tree

← Older revision		Revision as of 10:53, 21 August 2021
Line 103:		Line 103:
	[[es:Árbol de elementos]]		[[es:Árbol de elementos]]
	[[ru:Element tree]]		[[ru:Element tree]]
			[[pl:Element tree]]

XLive at 07:57, 4 November 2020

2020-11-04T07:57:38Z

← Older revision		Revision as of 07:57, 4 November 2020
Line 85:		Line 85:
	So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.		So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setMarkerSize ( ~~getRootElement()~~, 2.5 )		setMarkerSize ( root, 2.5 )
	</syntaxhighlight>		</syntaxhighlight>

Haxardous at 23:13, 10 April 2020

2020-04-10T23:13:29Z

← Older revision		Revision as of 23:13, 10 April 2020
Line 2:		Line 2:
	MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.		MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

	If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it ~~like~~ a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.		If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

	All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.		All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.
Line 73:		Line 73:
	This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.		This tree consists of a number of resource root elements, the [[Element/Console\|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

	Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker and 1 colshape as child elements. These are the elements that are created by the script, for example the marker, the colshape and one of the blips are probably used for the objective.		Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

	The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates ~~automactically~~ after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].		The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

	==Pratical application==		==Pratical application==
	Elements can have as many children as they like. This does not directly affect the map in any way, but it comes ~~in to~~ its own when combined with the scripting system.		Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.

	===Setting data for elements===		===Setting data for elements===

Surge at 09:07, 24 October 2018

2018-10-24T09:07:55Z

← Older revision		Revision as of 09:07, 24 October 2018
Line 97:		Line 97:
	==Element browser==		==Element browser==
	You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).		You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

	[[Category:Scripting Concepts]]		[[Category:Scripting Concepts]]

			[[hu:Element tree]]
	[[es:Árbol de elementos]]		[[es:Árbol de elementos]]
	[[ru:Element tree]]		[[ru:Element tree]]

Thisdp: Undo revision 59085 by Lizzalka (talk)

2018-09-09T06:13:09Z

Undo revision 59085 by Lizzalka (talk)

Show changes