Multi Theft Auto: Wiki - User contributions [en]

User:Pawcio

2022-10-24T08:17:39Z

Pawcio:

*'''Name:''' Pawel
*'''Gender:''' M
*'''Country:''' Poland
*'''Hobbies:''' Programming, virtual aviation.

User:Pawcio

2022-10-24T08:16:18Z

Pawcio:

{{border |
*'''Name:''' Pawel
*'''Gender:''' M
*'''Country:''' Poland
*'''Hobbies:''' Programming, virtual aviation.}}

Element tree

2022-10-24T08:12:49Z

Pawcio: Undo revision 75616 by Absolwent (talk)

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

Element

2022-10-24T08:12:40Z

Pawcio: Undo revision 75615 by Absolwent (talk)

An '''element''' is a generic class that can represent almost all in-game [[entity|entities]]. The built-in element types are:

{{Elements}}

Any other element type can be created as an abstract element, not referring to any game [[entity]]. For example, '''resource''' and '''map''' elements are created when resources and maps are loaded to group entities they create as their children.

Elements share common functions such as type and list retrieval, a destroy operation to remove both the element and the game entity it is linked to (except for some elements which can't be destroyed, for example client elements), [[element data]] storing and retrieval, and many more common operations.

All elements are stored internally in a [[Element tree|tree structure]], and as such every element except the '''root''' element has a parent element, that can be the '''root''' element, a '''resource''', '''map''' or another element. This is purely for declaring the scope of function calls.

==Related scripting functions==
===Client===
{{Client element functions}}
===Server===
{{Element functions}}
[[Category:Scripting Concepts]]

[[en:Element]]
[[ru:Element]]
[[es:Elemento]]
[[it:Elemento]]
[[hu:Element]]
[[pl:Element]]
[[pt-br:Elemento]]

MTA Classes

2022-10-24T08:12:23Z

Pawcio: Undo revision 75614 by Absolwent (talk)

In order to perform operations on MTA objects via scripting, pointers to internal classes are exported to scripts as Lua userdata. Each of these classes has a number of exported scripting functions associated with them.

Elements that have a physical representation in the game are also known as [[entity|Entities]].

The complete list of classes to be found in scripts follows:

* [[account|Account]]
* [[acl|ACL]]
* [[aclgroup|ACL group]]
* [[Ban]]
* [[element|Element]]
<ul>{{Elements}}</ul>
* [[resource|Resource]]
* [[textdisplay|Text display]]
* [[textitem|Text item]]
* [[timer|Timer]]
* [[xmlnode|XML node]]
* [[connection|Connection]]
[[Category:Scripting Concepts]]

[[hu:MTA Classes]]
[[es:Clases MTA]]
[[it:Classi di MTA]]
[[ru:Классы MTA]]

Useful Functions

2022-10-24T08:12:11Z

Pawcio: Undo revision 75613 by Absolwent (talk)

<pageclass class="#228B22"></pageclass>
{{MessageBox|
bordercolorhex = 000000 |
bordertype = dotted |
bgcolorhex = EFEFEF |
image = File:Package-x-generic.png |
title = Don't forget to check out the [[Useful Classes]] |
subtext = ''That page lists user-made classes that are not included by default in MTA. '' |
}}
{{Adding_Pages_to_Categories_and_Templates}}

This page lists user-made Lua functions that are not included by default in MTA. Its purpose is to quickly provide some useful functions for scripters, so they do not waste time recreating them when needed.
__TOC__

{{Useful_Functions}}

[[HU:Useful Functions]]
[[ES:Funciones Útiles]]
[[ru:Полезные функции]]
[[de:Nützliche_Funktionen]]
[[PL:Użyteczne Funkcje]]
[[Ar:وظائف مفيدة]]

Shared Scripting Functions

2022-10-24T08:12:00Z

Pawcio: Undo revision 75612 by Absolwent (talk)

<pageclass class="both"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''shared''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

For more functions, check the [[Useful_Functions|useful functions page]].
__TOC__

==Element functions==
{{Shared_element_functions}}

==Ped functions==
{{Shared_ped_functions}}

==Player functions==
{{Shared_player_functions}}

==Weapon functions==
{{Shared_weapon_functions}}

==Sound functions==
{{Shared_sound_functions}}

==Blip functions==
{{Shared_blip_functions}}

==Camera functions==
{{Shared_camera_functions}}

==Clothes and body functions==
{{Shared_clothes_and_body_functions}}

==Collision shape functions==
{{Shared_collision_shape_functions}}

==Cursor functions==
{{Shared_cursor_functions}}

==Event functions==
{{Shared_event_functions}}

==Explosion functions==
{{Shared_explosion_functions}}

==File functions==
{{Shared_file_functions}}

==Input functions==
{{Shared_input_functions}}

==Marker functions==
{{Shared_marker_functions}}

==Matrix functions==
{{Shared_matrix_functions}}

==Object functions==
{{Shared_object_functions}}

==Output functions==
{{Shared_output_functions}}

==Pickup functions==
{{Shared_pickup_functions}}

==Projectile functions==
{{Shared_projectile_functions}}

==Radar functions==
{{Shared_radar_functions}}

==Resource functions==
{{Shared_resource_functions}}

==Server functions==
{{Shared_server_functions}}

==Utility functions==
{{Shared_utility_functions}}

==UTF8 Library==
{{Shared_utf8_functions}}

==Vehicle functions==
{{Shared_vehicle_functions}}

==Water functions==
{{Shared_water_functions}}

==World functions==
{{Shared_world_functions}}

==XML functions==
{{Shared_xml_functions}}

[[ru:Shared Scripting Functions]]

Server Scripting Events

2022-10-24T08:11:44Z

Pawcio: Undo revision 75611 by Absolwent (talk)

<pageclass class="server"></pageclass>
This page lists all '''server-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a event, create an issue in [https://github.com/multitheftauto/mtasa-blue/issues our GitHub repository.]

'''Client-side scripting events can be found here: [[Client Scripting Events]]

==Account events==
{{Account_events}}

==Client events==
{{Client_events}}

==Colshape events==
{{Colshape_events}}

==Element events==
{{Element_events}}

==Marker events==
{{Marker_events}}

==Pickup events==
{{Pickup_events}}

==Player events==
{{Player_events}}

==Ped events==
{{Ped_events}}

==Resource events==
{{Resource_events}}

==Server events==
{{Server_events}}

==Vehicle events==
{{Vehicle_events}}

==Weapon events==
{{Weapon_events}}

[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]
[[ar:Server Scripting Events]]

Server Scripting Functions

2022-10-24T08:11:32Z

Pawcio: Undo revision 75610 by Absolwent (talk)

<pageclass class="server"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function, create an issue in [https://github.com/multitheftauto/mtasa-blue/issues our GitHub repository.]

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.

For more functions, check the [[Useful_Functions|useful functions page]].

'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''
__TOC__

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera_functions}}

==Clothes and body functions==
{{Clothes_and_body_functions}}

==Collision shape functions==
{{Collision_shape_functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element_functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker_functions}}

==Matrix functions==
{{Shared_matrix_functions}}

==Module functions==
{{Module_functions}}

==Object functions==
{{Object_functions}}

==Output functions==
{{Output_functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup_functions}}

==Player functions==
{{Player_functions}}

==Projectile functions==
{{Projectile_functions}}

==Radar area functions==
{{Radar_area_functions}}

==Resource functions==
{{Resource_functions}}

==Server functions==
{{Server_functions}}

==Settings registry functions==
{{Settings_registry_functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team_functions}}

==Text functions==
{{Text_functions}}

==Utility functions==
{{Utility_functions}}

==UTF8 Library==
{{UTF8_functions}}

==Vehicle functions==
{{Vehicle_functions}}

==Water functions==
{{Water_functions}}

==Weapon functions==
{{Weapon_functions}}

==World functions==
{{World_functions}}

==XML functions==
{{XML_functions}}

[[en:Server Scripting Functions]]
[[ru:Server Scripting Functions]]
[[hu:Server Scripting Functions]]
[[de:Server-Seitige Scripting Funktionen]]
[[es:Funciones_del_Server]]
[[pl:Server Scripting Functions]]
[[pt-br:Funções de Scripting do Servidor]]
[[tr:Server Scripting Functions]]
[[ar:Server Scripting Functions]]
[[zh-cn:Server Scripting Functions]]

Client Scripting Events

2022-10-24T08:11:07Z

Pawcio: Undo revision 75609 by Absolwent (talk)

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a event, create an issue in [https://github.com/multitheftauto/mtasa-blue/issues our GitHub repository.]

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Browser events==
{{CEF_events}}

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==Input events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[hu:Client Scripting Events]]
[[pl:Client Scripting Events]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]
[[fr:Client Scripting Events]]
[[tr:Client Taraflı Eventler]]
[[ar:Client Scripting Events]]

Client Scripting Functions

2022-10-24T08:10:54Z

Pawcio: Undo revision 75608 by Absolwent (talk)

<pageclass class="client"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''client-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function, create an issue in [https://github.com/multitheftauto/mtasa-blue/issues our GitHub repository.]

For more functions, check the [[Useful_Functions|useful functions page]].
__TOC__

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Browser functions==
{{CEF_functions}}

==Camera functions==
{{Client_camera_functions}}

==Clothes and body functions==
{{Client_Clothes_and_body_functions}}

==Collision shape functions==
{{Client_collision_shape_functions}}

==Cursor functions==
{{Client_cursor_functions}}

==Drawing functions==
{{Drawing_functions}}

==Effects functions==
{{Client_Effects_functions}}

==Element functions==
{{Client_element_functions}}

==Engine functions==
{{Engine_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==File functions==
{{Client file functions}}

==Fire functions==
{{Client_fire_functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Client_input_functions}}

==Light functions==
{{Client_light_functions}}

==Marker functions==
{{Client_marker_functions}}

==Matrix functions==
{{Shared_matrix_functions}}

==Object functions==
{{Client_object_functions}}

==Output functions==
{{Client_output_functions}}

==Ped functions==
{{Client_ped_functions}}

==Pickup functions==
{{Client_pickup_functions}}

==Player functions==
{{Client_player_functions}}

==Projectile functions==
{{Client_projectile_functions}}

==Radar area functions==
{{Client_radar-area_functions}}

==Resource functions==
{{Client_resource_functions}}

==Searchlight functions==
{{Client_searchlight_functions}}

==SVG functions==
{{SVG_functions}}

==Team functions==
{{Client_team_functions}}

==Utility functions==
{{Client_utility_functions}}

==UTF8 Library==
{{UTF8 functions}}

==Vehicle functions==
{{Client_vehicle_functions}}

==Water functions==
{{Client_water_functions}}

==Weapon functions==
{{Client_weapon_functions}}

==Weapon creation functions==

{{Client_weapon_creation_functions}}

==World functions==
{{Client_world_functions}}

==XML functions==
{{Client_XML_functions}}

[[hu:Kliens oldali függvények]]
[[ar:Client Scripting Functions]]
[[pl:Funkcje po stronie klienta]]
[[it:Funzioni Client-side]]
[[ru:Client Scripting Functions]]
[[es:Funciones del cliente]]
[[de:Clientseitige_Funktionen]]
[[tr:Client Taraflı Fonksiyonlar]]
[[pt-br:Funções de Scripting do Cliente]]
[[zh-cn:客户端脚本函数]]

User:Pawcio

2022-07-13T14:11:47Z

Pawcio:

*'''Name:''' Pawel
*'''Gender:''' M
*'''Country:''' Poland
*'''Hobbies:''' Programming, virtual aviation.

User:Pawcio

2022-07-13T14:11:25Z

Pawcio:

*'''Name:''' Pawel
*'''Gender:''' M
*'''Country:''' Poland
*'''Zainteresowania:''' Programming, virtual aviation.

Useful Functions

2022-07-13T14:09:19Z

Pawcio: Undo revision 75262 by Borsuczek123 (talk)

Server Scripting Events

2022-07-13T14:08:33Z

Pawcio: Undo revision 75261 by Borsuczek123 (talk)

Server Scripting Functions

2022-07-13T14:07:43Z

Pawcio: Undo revision 75260 by Borsuczek123 (talk)

Client Scripting Events

2022-07-13T14:07:17Z

Pawcio: Undo revision 75258 by Borsuczek123 (talk)

Shared Scripting Functions

2022-07-13T14:02:29Z

Pawcio: Undo revision 75265 by Borsuczek123 (talk)

Pawcio:

[[Category:Useful_functions]]

__NOTOC__
{{Useful_Function}}
This function returns an element that has [[SetElementData|element data]].

==Syntax==
<syntaxhighlight lang="lua">
element getElementUsingData ( string key, var value [, string type] )
</syntaxhighlight>

==Required arguments==
* '''key''': The key that has an element.
* '''value''': The value that an element has.

==Returns==
Returns element that contains the element data with the given key and value.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getElementUsingData(key, value, type)
type = type or "player"

local returnedElement = false

for indexTable, elementTable in ipairs(getElementsByType(type)) do
local elementData = getElementData(elementTable, pKey)
if elementData == pValue then
returnedElement = elementTable
return returnedElement
end
end
end
</syntaxhighlight>
</section>
'''Author:''' Pawcio#4564

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("get", function(player, command, key, value, type)
if key and value then
outputChatBox(getElementUsingData(key, value, type))
end
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

GetElementUsingData

2021-04-22T01:31:41Z

Pawcio: Created page with "__NOTOC__ {{Useful_Function}} This function returns an element that has element data. ==Syntax== <syntaxhighlight lang="lua"> element getElementUsingData (..."

__NOTOC__
{{Useful_Function}}
This function returns an element that has [[SetElementData|element data]].

==Syntax==
<syntaxhighlight lang="lua">
element getElementUsingData ( string key, var value [, string type] )
</syntaxhighlight>

==Required arguments==
* '''key''': The key that has an element.
* '''value''': The value that an element has.

==Returns==
Returns element that contains the element data with the given key and value.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getElementUsingData(key, value, type)
type = type or "player"

local returnedElement = false

for indexTable, elementTable in ipairs(getElementsByType(type)) do
local elementData = getElementData(elementTable, pKey)
if elementData == pValue then
returnedElement = elementTable
return returnedElement
end
end
end
</syntaxhighlight>
</section>
'''Author:''' Pawcio#4564

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("get", function(player, command, key, value, type)
if key and value then
outputChatBox(getElementUsingData(key, value, type))
end
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}