Multi Theft Auto: Wiki - User contributions [en]

Resource:Admin

2024-04-20T23:03:27Z

Haxardous:

{{Resource page}}
A quick tutorial on how to get admin rights and install admin resource.

To add an account in '''MTA {{padleft:|3|{{Current Version|full}}}}''' use the following command in the server

<syntaxhighlight lang="lua">
addaccount <username> <password>
</syntaxhighlight>

{{Note|Server should not be running when you are editing the acl file below}}

Then you open the '''acl.xml''' file located in the same folder and add yourself as an object to the Admin group by using the 'user.*' syntax, where * would be your account name.

<syntaxhighlight lang="xml"> 
<group name="Admin">
<acl name="Moderator" />
<acl name="SuperModerator" />
<acl name="Admin" />
<acl name="RPC" />
<object name="user.lil_Toady" />
<object name="resource.admin" />
</group>
</syntaxhighlight>

Now open your '''mtaserver.conf''' file and scroll to the bottom, make sure the admin resource is added to the ones that start with the server (note: protected="1" means that it can not be stopped).

<syntaxhighlight lang="conf"> <resource src="admin" startup="1" protected="0"> 
<resource src="helpmanager" startup="1" protected="0">
<resource src="mapcycler" startup="1" protected="0">
<resource src="mapmanager" startup="1" protected="0">
</syntaxhighlight>

Now that you're done with server files, you can finally start it. Connect to the server itself and login with your account details: use 'login [username] <password>'. If it tells you to press 'p' you have done everything right, congratulations! If not, do this from the very beginning.

==Resource commands==
Here are the commands from this resource. You need specific privileges to use most of them.

====admin====
Opens/Closes admin panel GUI.
*'''Permission needed:''' general.adminpanel
*'''Syntax:''' admin

====ban====
Bans the specified player and disconnects him from the server.
*'''Permission needed:''' command.ban
*'''Syntax:''' ban <playerName> <[reason]> <[period]> <[serial]>
**playerName: The name of the player you wish to ban.
**reason: Optional. The reason to ban the player. This will be shown to everyone on chatbox and also to the banned player.
**period: Optional. The seconds to keep the player banned. After this period, the player will be automatically unbanned. If not specified, this is 0 by default and the player will be banned permanently.
**serial: Optional. This can be any value. If specified, the player will be banned by serial. Otherwise the player will be banned by IP.

====blendweather====
Changes gradually the weather to the specified.
*'''Permission needed:''' command.blendweather
*'''Syntax:''' blendweather <weatherID>
**weatherID: The weather ID to gradually change to.

====blowvehicle====
Blows up the specified player's vehicle, killing its occupants and causing damage to nearest players and vehicles.
*'''Permission needed:''' command.blowvehicle
*'''Syntax:''' blowvehicle <playerName>
**playerName: The name of the player you wish to blow up the vehicle of.

====createteam====
Creates a new team that shows on TAB Score Table.
*'''Permission needed:''' command.createteam
*'''Syntax:''' createteam <teamName> <[red]> <[green]> <[blue]>
**teamName: The name of the team you wish to create.
**red: Optional. An integer representing the red color value. If not specified, it is 255 by default.
**green: Optional. An integer representing the green color value. If not specified, it is 255 by default.
**blue: Optional. An integer representing the blue color value. If not specified, it is 255 by default.

====destroyteam====
Deletes the specified team.
*'''Permission needed:''' command.destroyteam
*'''Syntax:''' destroyteam <teamName>
**teamName: The name of the team you wish to delete.

====destroyvehicle====
Deletes the vehicle from the specified player. The player must be inside a vehicle.
*'''Permission needed:''' command.destroyvehicle
*'''Syntax:''' destroyvehicle <playerName>
**playerName: The name of the player you wish to delete the vehicle of.

====freeze====
Freezes/unfreezes the specified player. If the player is inside a vehicle, the vehicle is frozen instead of the player. Also, if the player or the player's vehicle is already frozen, this command will unfrozen it.
*'''Permission needed:''' command.freeze
*'''Syntax:''' freeze <playerName>
**playerName: The name of the player you wish to freeze/unfreeze.

====givevehicle====
Creates a vehicle with the specified ID at the player position and teleports the player into the driver' seat. If the player is already in a vehicle, this command will change the vehicle model instead.
*'''Permission needed:''' command.givevehicle
*'''Syntax:''' givevehicle <playerName> <vehicleID>
**playerName: The name of the player you wish to give a vehicle.
**vehicleID: The model ID of the vehicle you wish to give to the player.

====giveweapon====
Gives a weapon with the specified ID to the specified player. If the player already has the specified weapon, the ammo is increased by the amount specified.
*'''Permission needed:''' command.giveweapon
*'''Syntax:''' giveweapon <playerName> <weaponID> <[ammo]>
**playerName: The name of the player you wish to give a weapon.
**vehicleID: The weapon ID of the weapon you wish to give to the player.
**ammo: Optional. The ammo you wish to give with the weapon. If not specified, it is 30 by default.

====jetpack====
Gives/removes a jetpack to the specified player.
*'''Permission needed:''' command.jetpack
*'''Syntax:''' jetpack <playerName>
**playerName: The name of the player you wish to give/remove a jetpack.

====kick====
Kicks the specified player from the server.
*'''Permission needed:''' command.kick
*'''Syntax:''' kick <playerName> <[reason]>
**playerName: The name of the player you wish to kick from the server.
**reason: Optional. The reason to kick the player. This will be shown to the kicked player after the kick.

====mute====
Mutes the specified player by the specified period or until the player disconnects with the specified reason. If the player is already muted, this command will unmute the player.
*'''Permission needed:''' command.mute
*'''Syntax:''' mute <playerName> <[reason]> <[period]>
**playerName: The name of the player you wish to mute.
**reason: Optional. The reason to mute the player. This will be shown to everyone on chatbox.
**period: Optional. The seconds the player will stay muted. After this period, the player will be automatically unmuted. If not specified, the player will be muted until disconnects or manually unmuted by someone.

====register====
Adds a new account with the username and password.
*'''No permission needed.'''
*'''Syntax:''' register <[username]> <password>
**username: Optional. The name of the account you wish to add, if not specified, it is the player's name.
**password: This is the password used to access the account. Minimum length is 4 characters and maximum length is 30 characters.

====setarmour====
Sets the specified player's armour health.
*'''Permission needed:''' command.setarmour
*'''Syntax:''' setarmour <playerName> <value>
**playerName: The name of the player you wish to set armour.
**value: The new armour's health. Accepts values from 0 to 100.

====setcolor====
Sets the specified player's vehicle colors.
*'''Permission needed:''' command.setcolor
*'''Syntax:''' setcolor <playerName> <[color1]> <[color2]> <[color3]> <[color4]>
**playerName: The name of the player you wish to set vehicle's colors. The player must be in a vehicle.
**color1: Optional. An hexadecimal code of the vehicle's color 1. If not specified, it is #000000 by default.
**color2: Optional. An hexadecimal code of the vehicle's color 2. If not specified, it is #000000 by default.
**color3: Optional. An hexadecimal code of the vehicle's color 3. If not specified, it is #000000 by default. ''Note: Only three GTA SA vehicles are using this color: Camper, Cement Truck, Squalo.''
**color4: Optional. An hexadecimal code of the vehicle's color 4. If not specified, it is #000000 by default. ''Note: Actually there's no vehicles on GTA SA using this color.''
{{warning|This command needs corrections. Nowadays, all colors are mandatory.}}

====setdimension====
Sets the specified player's dimension.
*'''Permission needed:''' command.setdimension
*'''Syntax:''' setdimension <playerName> <value>
**playerName: The name of the player you wish to set dimension.
**value: The new dimension. Accepts values from 0 to 65535.

====setgame====
Sets the server's game type. This will be visible in the server browser.
*'''Permission needed:''' command.setgame
*'''Syntax:''' setgame <gameType>
**gameType: The name of the game type.

====setgamespeed====
Sets the server's game speed.
*'''Permission needed:''' command.setgamespeed
*'''Syntax:''' setgamespeed <gameSpeed>
**gameSpeed: The speed of the game. Normal speed is 1. Accepts values from 0 to 10. ''Note: Actually only values from 0.001 to 4 make difference.''

====setgravity====
Sets the server's game gravity.
*'''Permission needed:''' command.setgravity
*'''Syntax:''' setgravity <gravity>
**gravity: The gravity of the game. Normal gravity is 0.008. ''Note: Higher gravity also increase fall damage.''

====sethealth====
Sets the specified player's health.
*'''Permission needed:''' command.sethealth
*'''Syntax:''' sethealth <playerName> <value>
**playerName: The name of the player you wish to set health.
**value: The new health. Accepts values from 0 to 200. ''Note: To use health higher than 100, the player must set health stats. Otherwise maximum health is 100.''

====setinterior====
Sets the specified player's interior. Only interiors from interiors.xml can be used.
*'''Permission needed:''' command.setinterior
*'''Syntax:''' setinterior <playerName> <interiorName>
**playerName: The name of the player you wish to change interior.
**interiorName: The interior name. The names are at the "id" attribute. ''Note: Interior names are in capital letters.''

====setmap====
Sets the server's map name. This will be visible in the server browser.
*'''Permission needed:''' command.setmap
*'''Syntax:''' setmap <mapName>
**mapName: The name of the map.

====setpaintjob====
Sets the specified player's vehicle paintjob.
*'''Permission needed:''' command.setpaintjob
*'''Syntax:''' setpaintjob <playerName> <paintjobID>
**playerName: The name of the player you wish to set vehicle's paintjob. The player must be in a vehicle.
**paintjobID: The paintjob ID. Accepts values from 0 to 3. Using 3 will remove the paintjob.

====setpassword====
Sets the server's password. Players will need to provide the server password to join the server.
*'''Permission needed:''' command.setpassword
*'''Syntax:''' setpassword <password>
**password: The password of the server. If not specified, it will remove the password.

====setskin====
Sets the specified player' skin.
*'''Permission needed:''' command.setskin
*'''Syntax:''' setskin <playerName> <skinID>
**playerName: The name of the player you wish to change skin.
**skinID: The new skin ID. Accepts values from 0 to 312. ''Note: The following IDs are not working: 3 4 5 6 8 42 65 74 86 119 149 208 273 289.''

====setstat====
Sets the specified player' stat.
*'''Permission needed:''' command.setstat
*'''Syntax:''' setstat <playerName> <statID> <value>
**playerName: The name of the player you wish to change the stat.
**statID: The stat ID. Accepts values from 0 to 230 (with exceptions). ''Note: See all stat IDs [[SetPedStat|here]].''
**value: The new value to the stat. Accepts values from 0 to 1000.

====setteam====
Sets the specified player' team.
*'''Permission needed:''' command.setteam
*'''Syntax:''' setteam <playerName> <teamName>
**playerName: The name of the player you wish to set the team.
**teamName: The team name.

====settime====
Sets the server time.
*'''Permission needed:''' command.settime
*'''Syntax:''' settime <hour> <minute>
**hour: The clock hour. Accepts 0-23.
**minute: The clock minute. Accepts 0-59.

====setweather====
Sets the server weather.
*'''Permission needed:''' command.setweather
*'''Syntax:''' setweather <weatherID>
**weatherID: The weatherID. Accepts from 0 to 255. ''Note: Standard weathers are from 0 to 19. Other weathers are used for effects only.''

====setwelcome====
Sets the server welcome message.
*'''Permission needed:''' command.setwelcome
*'''Syntax:''' setwelcome <message>
**message: The welcome message. ''Note: You can't use spaces with this command because there's only one parameter.''

====shout====
Sends a message at the specified player' screen. Useful for warn the player.
*'''Permission needed:''' command.shout
*'''Syntax:''' shout <playerName> <message>
**playerName: The name of the player who you wish to shout at.
**message: The shout message. ''Note: You can't use spaces with this command because there's only one parameter.''

====slap====
Slaps the specified player with the specified damage. Useful for punish the player. The player is also pulled up.
*'''Permission needed:''' command.slap
*'''Syntax:''' slap <playerName> <damage>
**playerName: The name of the player who you wish to slap.
**damage: An integer representing the slap damage. If you use 0, the player will just be pulled up.

====unregister====
Removes an account with the specified username. This will also delete the account data.
*'''Permission needed:''' function.removeAccount
*'''Syntax:''' unregister <username>
**username: The name of the account you wish to delete. The account can't be on other ACL Groups than "Everyone".

====repair====
Repairs the specified player's vehicle.
*'''Permission needed:''' command.repair
*'''Syntax:''' repair <playerName>
**playerName: The name of the player who you wish to repair the vehicle.

[[hu:Resource:Admin]]
[[it:Resource:Admin]]
[[ru:Resource:Admin]]

SetVehicleDirtLevel

2023-11-02T21:36:25Z

Haxardous:

__NOTOC__
{{Server client function}}
{{Disabled|This function doesn't work actually. See the bugtracker for updates and more information.}}
This function sets the dirt level on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDirtLevel ( vehicle theVehicle, int dirtLevel )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that you want to set the dirt level from
*'''dirtLevel:''' (0.0 = fully clean, 15.0 = maximum dirt visible.)

===Returns===
Returns ''true'' if the dirt level was set on the vehicle, ''false'' if the dirt level was not set or if invalid arguments are specified.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{Vehicle functions}}

Resource:Performancebrowser

2022-05-13T18:20:24Z

Haxardous: /* Category - Server info */

{{Resource page}}
=Introduction=

A performance browser is used to monitor the performance of resources on the server. Specifically, it shows how much CPU time and memory each resource is consuming. It is helpful in finding out which resources are slow, and which ones are leaking memory.

=Web access=
To allow access to the performance browser web interface, add an ACL which includes rights to ''''resource.performancebrowser.http'''' and ''''resource.ajax.http''''. The server default ACL now comes with a '''"DevGroup"''' and '''"DevACL"''' specifically for this purpose. If your servers ACL does not have them, here is the acl.xml extract:
<syntaxhighlight lang="lua">
<group name="DevGroup">
<acl name="DevACL"/>
</group>
<acl name="DevACL">
<right name="resource.performancebrowser.http" access="true"></right>
<right name="resource.ajax.http" access="true"></right>
</acl>
</syntaxhighlight>

Then all you have to do is add users to the '''"DevGroup"''' and use this URL in a browser: '''<nowiki>http://SERVER_IP:HTTP_PORT/performancebrowser/</nowiki>'''
On localhost it would look something like this: '''<nowiki>http://localhost:22005/performancebrowser/</nowiki>'''. So, turns out the '''default HTTP port is 22005.'''

=In game access=
There is also an in-game version of the performance browser called ''''ipb'''' which is now part of the official server resources. If you don't have it, it can be found in the latest resources zip: http://mirror.mtasa.com/mtasa/resources/

To access the IPB, log in to an account with access to admin permissions then use the command '''/ipb'''.

<br/><hr/>

=Category - Event Packet usage=
Select '''Event Packet usage''' from the '''Category''' drop down to view details about [[triggerClientEvent]] and outgoing [[setElementData]] packet usage.

=====The main columns are:=====
* '''Type''' - How the packets are created. This can be one or more of:
** ''ElementData'' - Caused by server side [[setElementData]]
** ''ElementData(Relay)'' - Caused by client side [[setElementData]]
** ''Event '' - Caused by server side [[triggerClientEvent]]
* '''Name''' - The name used in the script
* '''pkt/sec''' - The number of messages per second generated.
=====The '5 sec' columns are:=====
* '''pkts''' - The number of messages generated in the last 5 seconds

<br/><hr/>
=Category - Server info=
Select '''Server info''' from the '''Category''' drop-down to view summary info for the server.

===Logic/Sync/Raknet/DB thread CPU %===
Shows the % of total available CPU used by various server threads:
* '''Logic thread''' - is the one that does the Lua scripts, etc.
* '''Sync thread''' - makes sure the sync looks nice and smooth, even when the logic thread is maxed out.
* '''Raknet thread''' - handles the sending and receiving network packets to/from the connected clients.
* '''DB thread''' - is for database stuff.
The total % available for MTA depends on the number of CPU cores available. If MTA has access to 4 CPU cores, then the max CPU available is 400%, (although each individual thread cannot go above 100%). If a '''Sys:''' amount is shown, this is an additional % used by the system (O/S) for doing its job.
*Example:
**Logic thread CPU: %30 (Sys:4%)
**Sync thread CPU: %20
**Raknet thread CPU: %42 (Sys:14%)
**DB thread CPU: %0
*Total CPU % consumed is 30+4 + 20 + 42+14 = 110%, and if that is on a 4 core machine, then divide by 4 to get overall usage. 110/4 = 27.5%

<br/><hr/>

=Category - Lua timings=

Select '''Lua timings''' from the '''Category''' drop down to view timing information for each resource:

[[File:Perfbrow-lua-time.png]]

By default, there are three blocks of columns, each one representing a different sample period. In the picture below, block A represents samples taken in the last 5 seconds, block B represents samples taken in the last 60 seconds, and block C represents samples taken in the last 300 seconds.

[[File:Perfbrow-lua-time-abc.png]]

The columns in each block are:
* '''name''' - Name of the resource
* '''cpu''' - Amount of CPU time taken (in percent)
* '''time''' - Amount of CPU time taken (in seconds)
* '''calls''' - The number of times the function was called
* '''avg''' - The average time spent in the function
* '''max''' - The maximum time spent in the function

''Note: To keep the display as clear as possible, anything that has taken less than 0.01% of CPU time is not be displayed.''

===Options===
Use the '''d''' option to display the timings for specific events and functions in the resource. If a function name cannot be determined, it will display the @ sign followed by the file name and line number the function starts. You can then locate that function by looking in the source file.

Use the '''5''', '''60''', '''300''' and '''3600''' options to select what sample periods to show. For example, the option string '''5,60,300,3600''' will show all 4 sample periods. (If no sample periods are chosen, the default of '''5,60,300''' is used.)

[[File:Perfbrow-lua-time-d-admin.png]]

Use the '''Filter''' setting to view a smaller range of resources.

<br/><hr/>
=Category - Lua memory=

Select '''Lua memory''' from the '''Category''' drop down to view memory consumption of each Lua resource:

[[File:Perfbrow-lua-mem.png]]

The columns are:
* '''name''' - Name of the resource
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the resource is using now
* '''max''' - The most memory the resource has ever used
* '''XMLFiles''' - The number of open XML files
* '''refs''' - The number of callback functions
* '''Timers''' - The number of active Timers
* '''Elements''' - The number of Elements
* '''TextDisplays''' - The number of Text Displays
* '''TextItems''' - The number of Text Items

===Options===
Use the '''a''' option to show more accurate memory usage. ''Note: This calls the Lua garbage collector before each refresh, which could slightly reduce server performance.''

Use the '''Filter''' setting to view a smaller range of resources:

[[File:Perfbrow-lua-mem-race.png]]

<br/><hr/>
=Category - Lib memory=

Select '''Lib memory''' from the '''Category''' drop down to view memory consumption of the appropriate library (.dll or .so)<br>
''Note: This information is only available if the library has been compiled with WITH_ALLOC_TRACKING set to 1''

[[File:Perfbrow-lib-mem.png]]

The columns are:
* '''name''' - Name of the library
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the library is using now
* '''max''' - The most memory the library has ever used

===Options===
Use the '''i''' option to show more information:

[[File:Perfbrow-lib-mem-i.png]]

[[ru:Resource:Performancebrowser]]

Resource:Performancebrowser

2022-05-13T18:19:19Z

Haxardous: /* Introduction */

{{Resource page}}
=Introduction=

A performance browser is used to monitor the performance of resources on the server. Specifically, it shows how much CPU time and memory each resource is consuming. It is helpful in finding out which resources are slow, and which ones are leaking memory.

=Web access=
To allow access to the performance browser web interface, add an ACL which includes rights to ''''resource.performancebrowser.http'''' and ''''resource.ajax.http''''. The server default ACL now comes with a '''"DevGroup"''' and '''"DevACL"''' specifically for this purpose. If your servers ACL does not have them, here is the acl.xml extract:
<syntaxhighlight lang="lua">
<group name="DevGroup">
<acl name="DevACL"/>
</group>
<acl name="DevACL">
<right name="resource.performancebrowser.http" access="true"></right>
<right name="resource.ajax.http" access="true"></right>
</acl>
</syntaxhighlight>

Then all you have to do is add users to the '''"DevGroup"''' and use this URL in a browser: '''<nowiki>http://SERVER_IP:HTTP_PORT/performancebrowser/</nowiki>'''
On localhost it would look something like this: '''<nowiki>http://localhost:22005/performancebrowser/</nowiki>'''. So, turns out the '''default HTTP port is 22005.'''

=In game access=
There is also an in-game version of the performance browser called ''''ipb'''' which is now part of the official server resources. If you don't have it, it can be found in the latest resources zip: http://mirror.mtasa.com/mtasa/resources/

To access the IPB, log in to an account with access to admin permissions then use the command '''/ipb'''.

<br/><hr/>

=Category - Event Packet usage=
Select '''Event Packet usage''' from the '''Category''' drop down to view details about [[triggerClientEvent]] and outgoing [[setElementData]] packet usage.

=====The main columns are:=====
* '''Type''' - How the packets are created. This can be one or more of:
** ''ElementData'' - Caused by server side [[setElementData]]
** ''ElementData(Relay)'' - Caused by client side [[setElementData]]
** ''Event '' - Caused by server side [[triggerClientEvent]]
* '''Name''' - The name used in the script
* '''pkt/sec''' - The number of messages per second generated.
=====The '5 sec' columns are:=====
* '''pkts''' - The number of messages generated in the last 5 seconds

<br/><hr/>
=Category - Server info=
Select '''Server info''' from the '''Category''' drop down to view summary info for the server.

===Logic/Sync/Raknet/DB thread CPU %===
Shows the % of total available CPU used by various server threads:
* '''Logic thread''' - is the one that does the Lua scripts etc.
* '''Sync thread''' - makes sure the sync looks nice and smooth, even when the logic thread is maxed out.
* '''Raknet thread''' - handles the sending and receiving of networks packets to/from the connected clients.
* '''DB thread''' - is for database stuff.
The total % available for MTA depends on the number of CPU cores available. If MTA has access to 4 CPU cores, then the max CPU available in total is 400%, (although each individual thread cannot go above 100%). If a '''Sys:''' amount is shown, this is additional % used by the system (O/S) for doing it's job.
*Example:
**Logic thread CPU: %30 (Sys:4%)
**Sync thread CPU: %20
**Raknet thread CPU: %42 (Sys:14%)
**DB thread CPU: %0
*Total CPU % consumed is 30+4 + 20 + 42+14 = 110%, and if that is on a 4 core machine, then divide by 4 to get overall usage. 110/4 = 27.5%

<br/><hr/>
=Category - Lua timings=

Select '''Lua timings''' from the '''Category''' drop down to view timing information for each resource:

[[File:Perfbrow-lua-time.png]]

By default, there are three blocks of columns, each one representing a different sample period. In the picture below, block A represents samples taken in the last 5 seconds, block B represents samples taken in the last 60 seconds, and block C represents samples taken in the last 300 seconds.

[[File:Perfbrow-lua-time-abc.png]]

The columns in each block are:
* '''name''' - Name of the resource
* '''cpu''' - Amount of CPU time taken (in percent)
* '''time''' - Amount of CPU time taken (in seconds)
* '''calls''' - The number of times the function was called
* '''avg''' - The average time spent in the function
* '''max''' - The maximum time spent in the function

''Note: To keep the display as clear as possible, anything that has taken less than 0.01% of CPU time is not be displayed.''

===Options===
Use the '''d''' option to display the timings for specific events and functions in the resource. If a function name cannot be determined, it will display the @ sign followed by the file name and line number the function starts. You can then locate that function by looking in the source file.

Use the '''5''', '''60''', '''300''' and '''3600''' options to select what sample periods to show. For example, the option string '''5,60,300,3600''' will show all 4 sample periods. (If no sample periods are chosen, the default of '''5,60,300''' is used.)

[[File:Perfbrow-lua-time-d-admin.png]]

Use the '''Filter''' setting to view a smaller range of resources.

<br/><hr/>
=Category - Lua memory=

Select '''Lua memory''' from the '''Category''' drop down to view memory consumption of each Lua resource:

[[File:Perfbrow-lua-mem.png]]

The columns are:
* '''name''' - Name of the resource
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the resource is using now
* '''max''' - The most memory the resource has ever used
* '''XMLFiles''' - The number of open XML files
* '''refs''' - The number of callback functions
* '''Timers''' - The number of active Timers
* '''Elements''' - The number of Elements
* '''TextDisplays''' - The number of Text Displays
* '''TextItems''' - The number of Text Items

===Options===
Use the '''a''' option to show more accurate memory usage. ''Note: This calls the Lua garbage collector before each refresh, which could slightly reduce server performance.''

Use the '''Filter''' setting to view a smaller range of resources:

[[File:Perfbrow-lua-mem-race.png]]

<br/><hr/>
=Category - Lib memory=

Select '''Lib memory''' from the '''Category''' drop down to view memory consumption of the appropriate library (.dll or .so)<br>
''Note: This information is only available if the library has been compiled with WITH_ALLOC_TRACKING set to 1''

[[File:Perfbrow-lib-mem.png]]

The columns are:
* '''name''' - Name of the library
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the library is using now
* '''max''' - The most memory the library has ever used

===Options===
Use the '''i''' option to show more information:

[[File:Perfbrow-lib-mem-i.png]]

[[ru:Resource:Performancebrowser]]

Resource:Performancebrowser

2022-05-13T18:18:38Z

Haxardous: /* In game access */

{{Resource page}}
=Introduction=

Performance browser is used to monitor the performance of resources on the server. Specifically, it shows how much CPU time and memory each resource is consuming. It is useful for finding out which resources are slow, and which ones are leaking memory.

=Web access=
To allow access to the performance browser web interface, add an ACL which includes rights to ''''resource.performancebrowser.http'''' and ''''resource.ajax.http''''. The server default ACL now comes with a '''"DevGroup"''' and '''"DevACL"''' specifically for this purpose. If your servers ACL does not have them, here is the acl.xml extract:
<syntaxhighlight lang="lua">
<group name="DevGroup">
<acl name="DevACL"/>
</group>
<acl name="DevACL">
<right name="resource.performancebrowser.http" access="true"></right>
<right name="resource.ajax.http" access="true"></right>
</acl>
</syntaxhighlight>

Then all you have to do is add users to the '''"DevGroup"''' and use this URL in a browser: '''<nowiki>http://SERVER_IP:HTTP_PORT/performancebrowser/</nowiki>'''
On localhost it would look something like this: '''<nowiki>http://localhost:22005/performancebrowser/</nowiki>'''. So, turns out the '''default HTTP port is 22005.'''

=In game access=
There is also an in-game version of the performance browser called ''''ipb'''' which is now part of the official server resources. If you don't have it, it can be found in the latest resources zip: http://mirror.mtasa.com/mtasa/resources/

To access the IPB, log in to an account with access to admin permissions then use the command '''/ipb'''.

<br/><hr/>

=Category - Event Packet usage=
Select '''Event Packet usage''' from the '''Category''' drop down to view details about [[triggerClientEvent]] and outgoing [[setElementData]] packet usage.

=====The main columns are:=====
* '''Type''' - How the packets are created. This can be one or more of:
** ''ElementData'' - Caused by server side [[setElementData]]
** ''ElementData(Relay)'' - Caused by client side [[setElementData]]
** ''Event '' - Caused by server side [[triggerClientEvent]]
* '''Name''' - The name used in the script
* '''pkt/sec''' - The number of messages per second generated.
=====The '5 sec' columns are:=====
* '''pkts''' - The number of messages generated in the last 5 seconds

<br/><hr/>
=Category - Server info=
Select '''Server info''' from the '''Category''' drop down to view summary info for the server.

===Logic/Sync/Raknet/DB thread CPU %===
Shows the % of total available CPU used by various server threads:
* '''Logic thread''' - is the one that does the Lua scripts etc.
* '''Sync thread''' - makes sure the sync looks nice and smooth, even when the logic thread is maxed out.
* '''Raknet thread''' - handles the sending and receiving of networks packets to/from the connected clients.
* '''DB thread''' - is for database stuff.
The total % available for MTA depends on the number of CPU cores available. If MTA has access to 4 CPU cores, then the max CPU available in total is 400%, (although each individual thread cannot go above 100%). If a '''Sys:''' amount is shown, this is additional % used by the system (O/S) for doing it's job.
*Example:
**Logic thread CPU: %30 (Sys:4%)
**Sync thread CPU: %20
**Raknet thread CPU: %42 (Sys:14%)
**DB thread CPU: %0
*Total CPU % consumed is 30+4 + 20 + 42+14 = 110%, and if that is on a 4 core machine, then divide by 4 to get overall usage. 110/4 = 27.5%

<br/><hr/>
=Category - Lua timings=

Select '''Lua timings''' from the '''Category''' drop down to view timing information for each resource:

[[File:Perfbrow-lua-time.png]]

By default, there are three blocks of columns, each one representing a different sample period. In the picture below, block A represents samples taken in the last 5 seconds, block B represents samples taken in the last 60 seconds, and block C represents samples taken in the last 300 seconds.

[[File:Perfbrow-lua-time-abc.png]]

The columns in each block are:
* '''name''' - Name of the resource
* '''cpu''' - Amount of CPU time taken (in percent)
* '''time''' - Amount of CPU time taken (in seconds)
* '''calls''' - The number of times the function was called
* '''avg''' - The average time spent in the function
* '''max''' - The maximum time spent in the function

''Note: To keep the display as clear as possible, anything that has taken less than 0.01% of CPU time is not be displayed.''

===Options===
Use the '''d''' option to display the timings for specific events and functions in the resource. If a function name cannot be determined, it will display the @ sign followed by the file name and line number the function starts. You can then locate that function by looking in the source file.

Use the '''5''', '''60''', '''300''' and '''3600''' options to select what sample periods to show. For example, the option string '''5,60,300,3600''' will show all 4 sample periods. (If no sample periods are chosen, the default of '''5,60,300''' is used.)

[[File:Perfbrow-lua-time-d-admin.png]]

Use the '''Filter''' setting to view a smaller range of resources.

<br/><hr/>
=Category - Lua memory=

Select '''Lua memory''' from the '''Category''' drop down to view memory consumption of each Lua resource:

[[File:Perfbrow-lua-mem.png]]

The columns are:
* '''name''' - Name of the resource
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the resource is using now
* '''max''' - The most memory the resource has ever used
* '''XMLFiles''' - The number of open XML files
* '''refs''' - The number of callback functions
* '''Timers''' - The number of active Timers
* '''Elements''' - The number of Elements
* '''TextDisplays''' - The number of Text Displays
* '''TextItems''' - The number of Text Items

===Options===
Use the '''a''' option to show more accurate memory usage. ''Note: This calls the Lua garbage collector before each refresh, which could slightly reduce server performance.''

Use the '''Filter''' setting to view a smaller range of resources:

[[File:Perfbrow-lua-mem-race.png]]

<br/><hr/>
=Category - Lib memory=

Select '''Lib memory''' from the '''Category''' drop down to view memory consumption of the appropriate library (.dll or .so)<br>
''Note: This information is only available if the library has been compiled with WITH_ALLOC_TRACKING set to 1''

[[File:Perfbrow-lib-mem.png]]

The columns are:
* '''name''' - Name of the library
* '''change''' - The change in memory use since the last refresh
* '''current''' - The amount of memory the library is using now
* '''max''' - The most memory the library has ever used

===Options===
Use the '''i''' option to show more information:

[[File:Perfbrow-lib-mem-i.png]]

[[ru:Resource:Performancebrowser]]

Up-to-date

2021-03-05T14:16:49Z

Haxardous: updated services pack 1 (dead link)

If you have Multi Theft Auto:San Andreas issues you should always make sure that everything is up-to-date.

== MTA:San Andreas ==
Multi Theft Auto itself should be up-to-date with the latest version either by updating in game or by downloading the latest version from the [http://www.mtasa.com Multi Theft Auto] website.

== Drivers ==
It is always wise to install the latest drivers for your hardware, this improves stability and/or performance for both your hardware and software.

=== Graphics Drivers ===

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA (Chrome9)
|http://www.viaarena.com/Drivers.aspx
|}

=== Chipset ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA
|http://www.viaarena.com/Drivers.aspx
|}

=== Audio Drivers ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Creative
|https://support.creative.com/Products/Products.aspx?catid=1
|-
|Realtek
|https://www.realtek.com/downloads/
|}

If your manufacturer is not listed above, you should check the support website from the manufacturer that assembled your system or your motherboard manufacturer. (Common listed below)

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ Motherboard Manufacturers
|-
!Manufacturer
!Link
|-
|Asrock
|https://www.asrock.com/support/download.asp
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Biostar
|https://www.biostar.com.tw/app/en/support/download.php
|-
|EVGA
|https://www.evga.com/support/download/default.aspx
|-
|Gigabyte
|https://www.gigabyte.us/support-downloads/support-downloads.aspx
|-
|Intel
|https://downloadcenter.intel.com/default.aspx?lang=eng
|-
|MSI
|https://msi.com/service/download/
|-
|Zotac
|https://www.zotac.com/index.php?option=com_docman&Itemid=100032
|-
|}

== Operating System ==
Make sure your system is up to date with Windows Update.

== Additional Software ==
Additional software required for Multi Theft Auto.

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Name
!Link
|-
|Microsoft Visual C++ 2008 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29 32bits] [http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=15336 64bits]
|-
|Microsoft Visual C++ 2008 SP1 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?id=5582&WT 32bits] [https://www.microsoft.com/en-us/download/details.aspx?id=26368 64bits]
|-
|DirectX 9.0c Web Installer/Updater
|[http://www.microsoft.com/download/en/details.aspx?id=35 32bits/64bits]
|}

== See also ==
* [[Known Issues - FAQ]]
* [[IRC Channel]]
* [http://bugs.mtasa.com Multi Theft Auto Bugtracker]

[[ru:Up-to-date]]

[[Category:Support]]

Up-to-date

2021-03-05T14:14:46Z

Haxardous: /* Audio Drivers */

If you have Multi Theft Auto:San Andreas issues you should always make sure that everything is up-to-date.

== MTA:San Andreas ==
Multi Theft Auto itself should be up-to-date with the latest version either by updating in game or by downloading the latest version from the [http://www.mtasa.com Multi Theft Auto] website.

== Drivers ==
It is always wise to install the latest drivers for your hardware, this improves stability and/or performance for both your hardware and software.

=== Graphics Drivers ===

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA (Chrome9)
|http://www.viaarena.com/Drivers.aspx
|}

=== Chipset ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA
|http://www.viaarena.com/Drivers.aspx
|}

=== Audio Drivers ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Creative
|https://support.creative.com/Products/Products.aspx?catid=1
|-
|Realtek
|https://www.realtek.com/downloads/
|}

If your manufacturer is not listed above, you should check the support website from the manufacturer that assembled your system or your motherboard manufacturer. (Common listed below)

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ Motherboard Manufacturers
|-
!Manufacturer
!Link
|-
|Asrock
|https://www.asrock.com/support/download.asp
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Biostar
|https://www.biostar.com.tw/app/en/support/download.php
|-
|EVGA
|https://www.evga.com/support/download/default.aspx
|-
|Gigabyte
|https://www.gigabyte.us/support-downloads/support-downloads.aspx
|-
|Intel
|https://downloadcenter.intel.com/default.aspx?lang=eng
|-
|MSI
|https://msi.com/service/download/
|-
|Zotac
|https://www.zotac.com/index.php?option=com_docman&Itemid=100032
|-
|}

== Operating System ==
Make sure your system is up to date with Windows Update.

== Additional Software ==
Additional software required for Multi Theft Auto.

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Name
!Link
|-
|Microsoft Visual C++ 2008 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29 32bits] [http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=15336 64bits]
|-
|Microsoft Visual C++ 2008 SP1 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?id=5582&WT 32bits] [http://www.microsoft.com/download/en/details.aspx?id=2092 64bits]
|-
|DirectX 9.0c Web Installer/Updater
|[http://www.microsoft.com/download/en/details.aspx?id=35 32bits/64bits]
|}

== See also ==
* [[Known Issues - FAQ]]
* [[IRC Channel]]
* [http://bugs.mtasa.com Multi Theft Auto Bugtracker]

[[ru:Up-to-date]]

[[Category:Support]]

Up-to-date

2021-03-05T14:12:41Z

Haxardous: /* Audio Drivers */

If you have Multi Theft Auto:San Andreas issues you should always make sure that everything is up-to-date.

== MTA:San Andreas ==
Multi Theft Auto itself should be up-to-date with the latest version either by updating in game or by downloading the latest version from the [http://www.mtasa.com Multi Theft Auto] website.

== Drivers ==
It is always wise to install the latest drivers for your hardware, this improves stability and/or performance for both your hardware and software.

=== Graphics Drivers ===

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA (Chrome9)
|http://www.viaarena.com/Drivers.aspx
|}

=== Chipset ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA
|http://www.viaarena.com/Drivers.aspx
|}

=== Audio Drivers ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Creative
|http://support.creative.com/Products/Products.aspx?catid=1
|-
|Realtek
|http://www.realtek.com/downloads/
|}

If your manufacturer is not listed above, you should check the support website from the manufacturer that assembled your system or your motherboard manufacturer. (Common listed below)

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ Motherboard Manufacturers
|-
!Manufacturer
!Link
|-
|Asrock
|http://www.asrock.com/support/download.asp
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Biostar
|http://www.biostar.com.tw/app/en/support/download.php
|-
|EVGA
|http://www.evga.com/support/download/default.aspx
|-
|Gigabyte
|http://www.gigabyte.us/support-downloads/support-downloads.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|MSI
|http://msi.com/service/download/
|-
|Zotac
|http://www.zotac.com/index.php?option=com_docman&Itemid=100032
|-
|}

== Operating System ==
Make sure your system is up to date with Windows Update.

== Additional Software ==
Additional software required for Multi Theft Auto.

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Name
!Link
|-
|Microsoft Visual C++ 2008 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29 32bits] [http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=15336 64bits]
|-
|Microsoft Visual C++ 2008 SP1 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?id=5582&WT 32bits] [http://www.microsoft.com/download/en/details.aspx?id=2092 64bits]
|-
|DirectX 9.0c Web Installer/Updater
|[http://www.microsoft.com/download/en/details.aspx?id=35 32bits/64bits]
|}

== See also ==
* [[Known Issues - FAQ]]
* [[IRC Channel]]
* [http://bugs.mtasa.com Multi Theft Auto Bugtracker]

[[ru:Up-to-date]]

[[Category:Support]]

Up-to-date

2021-03-05T14:12:03Z

Haxardous: /* Audio Drivers */

If you have Multi Theft Auto:San Andreas issues you should always make sure that everything is up-to-date.

== MTA:San Andreas ==
Multi Theft Auto itself should be up-to-date with the latest version either by updating in game or by downloading the latest version from the [http://www.mtasa.com Multi Theft Auto] website.

== Drivers ==
It is always wise to install the latest drivers for your hardware, this improves stability and/or performance for both your hardware and software.

=== Graphics Drivers ===

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA (Chrome9)
|http://www.viaarena.com/Drivers.aspx
|}

=== Chipset ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|AMD / ATI
|http://support.amd.com/us/Pages/AMDSupportHub.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|nVidia
|http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk
|-
|VIA
|http://www.viaarena.com/Drivers.aspx
|}

=== Audio Drivers ===
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Manufacturer
!Link
|-
|Asus
|https://www.asus.com/support/download-center
|-
|Creative
|http://support.creative.com/Products/Products.aspx?catid=1
|-
|Realtek
|http://www.realtek.com/downloads/
|}

If your manufacturer is not listed above, you should check the support website from the manufacturer that assembled your system or your motherboard manufacturer. (Common listed below)

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ Motherboard Manufacturers
|-
!Manufacturer
!Link
|-
|Asrock
|http://www.asrock.com/support/download.asp
|-
|Asus
|http://support.asus.com/ServiceHome.aspx?SLanguage=en
|-
|Biostar
|http://www.biostar.com.tw/app/en/support/download.php
|-
|EVGA
|http://www.evga.com/support/download/default.aspx
|-
|Gigabyte
|http://www.gigabyte.us/support-downloads/support-downloads.aspx
|-
|Intel
|http://downloadcenter.intel.com/default.aspx?lang=eng
|-
|MSI
|http://msi.com/service/download/
|-
|Zotac
|http://www.zotac.com/index.php?option=com_docman&Itemid=100032
|-
|}

== Operating System ==
Make sure your system is up to date with Windows Update.

== Additional Software ==
Additional software required for Multi Theft Auto.

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Name
!Link
|-
|Microsoft Visual C++ 2008 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29 32bits] [http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=15336 64bits]
|-
|Microsoft Visual C++ 2008 SP1 Redistributable
|[http://www.microsoft.com/download/en/details.aspx?id=5582&WT 32bits] [http://www.microsoft.com/download/en/details.aspx?id=2092 64bits]
|-
|DirectX 9.0c Web Installer/Updater
|[http://www.microsoft.com/download/en/details.aspx?id=35 32bits/64bits]
|}

== See also ==
* [[Known Issues - FAQ]]
* [[IRC Channel]]
* [http://bugs.mtasa.com Multi Theft Auto Bugtracker]

[[ru:Up-to-date]]

[[Category:Support]]

Where to buy GTASA

2021-03-05T14:00:24Z

Haxardous:

This page outlines some of the places Grand Theft Auto San Andreas can be bought and played with MTA:SA (sometimes with an automatic downgrade step).

'''Compatibility'''

Not all of the GTA versions listed below have been tested, but all should work correctly. If not, try reinstalling MTA. If that doesn't work, follow [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ these instructions]. If that still doesn't work, then please contact us on [https://forum.mtasa.com/forum/83-client/ on the forums], or join the [https://mtasa.com/discord MTA Discord #help-support channel].

{| class="wikitable" style="width: 900px; text-align: center; table-layout: fixed;"
|-
!Retailer
!Notes
!Works with MTA:SA?
|-
|[http://store.steampowered.com/app/12120/ Steam]
|Specialized Steam version of the game.
MTA installer will make this compatible for you (make sure to install the latest version of MTA '''after''' installing the Steam GTA version), but without modifying original game files.
|{{Yes}}
|-
|rowspan="2" |[http://www.amazon.com/Grand-Theft-Auto-Andreas-Download/dp/B006YVXGJQ Amazon]
|For the '''Standard''' edition of the game, if MTA is incompatible, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and follow the instructions, or try obtaining a GTA SA 1.00 No CD - any HOODLUM release will function correctly.
|{{Partial|Unconfirmed (Standard)}}
|-
| Steam version and disc copies of GTA:SA will work fine.
| {{Yes| Yes (Steam/Boxed DVD)}}
|-
|[https://www.gamersgate.com/DD-GTASAS-GN/grand-theft-auto-san-andreas GamersGate]
|rowspan=2|To our knowledge, these vendors are offering Steam versions of the game (make sure to verify), and therefore will function similarly to the first entry in this article (Retailer: Steam).
|rowspan="2" {{Yes}}
|-
|[https://www.greenmangaming.com/games/grand-theft-auto-san-andreas/ GreenManGaming]
|-
|[https://www.rockstarwarehouse.com/store/rsg/en_IE/pd/productID.5281755000 Rockstar Games Launcher]
|It is recommended to get GTA:SA straight from the [https://socialclub.rockstargames.com/rockstar-games-launcher Rockstar Games Launcher application] rather than the webshop page.
|{{Yes}}
|-
|[https://www.microsoft.com/en-us/p/grand-theft-auto-san-andreas/9wzdncrfj1zn Windows App Store]
|This is a mobile/Xbox "remastered" version of the game ported to PC. '''Will never work with MTA.'''
|{{No}}
|}

[[hu:Where to buy GTASA]]
[[es:Dónde comprar GTA: SA]]
[[pl:Where to buy GTASA]]
[[ru:Where to buy GTASA]]
[[uk:Where to buy GTASA]]
[[tr:GTA:SA Nerden Alınır]]
[[zh-cn:在那里可以购买GTASA]]
[[ro:Where to buy GTASA]]

Where to buy GTASA

2021-03-05T13:59:55Z

Haxardous:

This page outlines some of the places Grand Theft Auto San Andreas can be bought and played with MTA:SA (sometimes with an automatic downgrade step).

'''Compatibility'''

Not all of the GTA versions listed below have been tested, but all should work correctly. If not, try reinstalling MTA. If that doesn't work, follow [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ these instructions]. If that still doesn't work, then please contact us on [https://forum.mtasa.com/forum/83-client/ on the forums], or join the [https://mtasa.com/discord MTA Discord #help-support channel].

{| class="wikitable" style="width: 900px; text-align: center; table-layout: fixed;"
|-
!Retailer
!Notes
!Works with MTA:SA?
|-
|[http://store.steampowered.com/app/12120/ Steam]
|Specialized Steam version of the game.
MTA installer will make this compatible for you (make sure to install the latest version of MTA '''after''' installing the Steam GTA version), but without modifying original game files.
|{{Yes}}
|-
|rowspan="2" |[http://www.amazon.com/Grand-Theft-Auto-Andreas-Download/dp/B006YVXGJQ Amazon]
|For the '''Standard''' edition of the game, if MTA is incompatible, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and follow the instructions, or try obtaining a GTA SA 1.00 No CD - any HOODLUM release will function correctly.
|{{Partial|Unconfirmed (Standard)}}
|-
| Steam version and disc copies of GTA:SA will work fine
| {{Yes| Yes (Steam/Boxed DVD)}}
|-
|[https://www.gamersgate.com/DD-GTASAS-GN/grand-theft-auto-san-andreas GamersGate]
|rowspan=2|To our knowledge, these vendors are offering Steam versions of the game (make sure to verify), and therefore will function similarly to the first entry in this article (Retailer: Steam).
|rowspan="2" {{Yes}}
|-
|[https://www.greenmangaming.com/games/grand-theft-auto-san-andreas/ GreenManGaming]
|-
|[https://www.rockstarwarehouse.com/store/rsg/en_IE/pd/productID.5281755000 Rockstar Games Launcher]
|It is recommended to get GTA:SA straight from the [https://socialclub.rockstargames.com/rockstar-games-launcher Rockstar Games Launcher application] rather than the webshop page.
|{{Yes}}
|-
|[https://www.microsoft.com/en-us/p/grand-theft-auto-san-andreas/9wzdncrfj1zn Windows App Store]
|This is a mobile/Xbox "remastered" version of the game ported to PC. '''Will never work with MTA.'''
|{{No}}
|}

[[hu:Where to buy GTASA]]
[[es:Dónde comprar GTA: SA]]
[[pl:Where to buy GTASA]]
[[ru:Where to buy GTASA]]
[[uk:Where to buy GTASA]]
[[tr:GTA:SA Nerden Alınır]]
[[zh-cn:在那里可以购买GTASA]]
[[ro:Where to buy GTASA]]

FetchRemote

2020-07-25T18:34:10Z

Haxardous:

__NOTOC__
{{Server client function}}
This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

If you are using fetchRemote to connect to a PHP script, you can use ''file_get_contents("php://input")'' to read the '''postData''' sent from this function.
{{Note|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
{{ Warning| function won't trigger inside another fetchRemote function }}
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL, [ string queueName = "default" ], [ int connectionAttempts = 10, int connectTimeout = 10000 ], function callbackFunction, [ string postData = "", bool postIsBinary = false ], [ arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''error''''' - A number containing the error number or zero if there was no error. A list of possible error values are:
{{Error_codes_for_callRemote_and_fetchRemote}}
<div style="padding-left:19px;">
*'''''arguments...''''' - The arguments that were passed into fetchRemote
</div>

===Optional Arguments===
{{New items|4.0153|1.5.3-9.11270|
*'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
}}
*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 10 seconds. Therefore, the default setting of 10 connection attempts means it will be 100 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 20 seconds''
*'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out
*'''postData:''' A string specifying any data you want to send to the remote HTTP server.
*'''postIsBinary :''' A boolean specifying if the data is text, or binary.
*'''arguments:''' Any arguments you may want to pass to the callback.

{{New items|5.0154|1.5.4-9.11342|
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, table options ], callback callbackFunction[, table callbackArguments ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response
**'''''responseInfo''''' - A table containing:
***'''''success''''' - A boolean indicating if the request was successful.
***'''''statusCode''''' - An integer status/error code
***'''''headers''''' - A table containing the HTTP response headers
**'''''arguments...''''' - The arguments that were passed into fetchRemote

===Optional Arguments===
*'''options:''' A table containing any request options:
**'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
**'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''(Defaults to 10)''
**'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out. ''(Defaults to 10000)''
**'''postData:''' A string specifying any data you want to send to the remote HTTP server.
**'''postIsBinary :''' A boolean specifying if the data is text, or binary. ''(Defaults to false)''
**'''method:''' A string specifying the request method. ''(Defaults to GET or POST)''
**'''headers:''' A table containing HTTP request headers. ''e.g.{ Pragma="no-cache" }''
**'''maxRedirects:''' An integer limiting the number of HTTP redirections to automatically follow. ''(Defaults to 8)''
**'''username:''' A string specifying the username for protected pages.
**'''password:''' A string specifying the password for protected pages.
{{New items|5.0154|1.5.4-9.11413|
**'''formFields:''' A table containing form items to submit. (for POST method only) ''e.g.{ name="bob", email="bob@example.com" }''
}}
*'''arguments:''' A table containing arguments you may want to pass to the callback.
}}

===Returns===
{{New items|5.0154|1.5.7-9.20307|
Returns a '''''request''''' value which can be used with [[GetRemoteRequestInfo|getRemoteRequestInfo]] or [[AbortRemoteRequest|abortRemoteRequest]]
}}

==Example==
This example shows you how you can fetch an image from a web page, and transfer it to a particular client:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function startImageDownload( playerToReceive )
fetchRemote ( "http://www.example.com/image.jpg", myCallback, "", false, playerToReceive )
end

function myCallback( responseData, error, playerToReceive )
if error == 0 then
triggerClientEvent( playerToReceive, "onClientGotImage", resourceRoot, responseData )
end
end
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent( "onClientGotImage", true )
addEventHandler( "onClientGotImage", resourceRoot,
function( pixels )
if myTexture then
destroyElement( myTexture )
end
myTexture = dxCreateTexture( pixels )
end
)

addEventHandler("onClientRender", root,
function()
if myTexture then
local w,h = dxGetMaterialSize( myTexture )
dxDrawImage( 200, 100, w, h, myTexture )
end
end
)
</syntaxhighlight>
</section>
<br/>
{{New items|5.0154|1.5.4-9.11413|
Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/user_manual.html)
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
sendOptions = {
queueName = "My Mailgun queue",
connectionAttempts = 3,
connectTimeout = 5000,
formFields = {
from="Excited User <excited@samples.mailgun.org>",
to="devs@mailgun.net",
subject="Hello",
text="Testing some Mailgun awesomness!",
},
username="api",
password="key-3ax6xnjp29jd6fds4gc373sgvjxteol0",
}
fetchRemote( "https://api.mailgun.net/v3/samples.mailgun.org/messages", sendOptions, mailgunCompleteCallback )

function mailgunCompleteCallback(data, info)
outputDebugString( "mailgunComplete"
.. " success:" .. tostring(info.success)
.. " statusCode:" .. tostring(info.statusCode)
.. " data:" .. tostring(data)
)
end
</syntaxhighlight>
</section>

Changing post content on IPS forum.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local apiKey = "12345678123456781234567812345678" -- key from ips admin panel
local forumAddress = "https://yourForum.com"
function setPostContent(postID,content)
local sendOptions = {
queueName = "updatePost",
connectionAttempts = 1,
connectTimeout = 50,
formFields = {
post = content,
},
}
fetchRemote( forumAddress.."/api/forums/posts/"..postID.."?key="..apiKey, sendOptions, function()end)
end

setPostContent(1, "this is a first post on this forum")
</syntaxhighlight>
</section>
}}

==Requirements==
{{Requirements|1.3.0-9.03739|1.3.2|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04605|Added connectionAttempts argument}}
{{ChangelogItem|1.3.2|Added client side}}
{{ChangelogItem|1.5.3-9.11270|Added queueName argument}}
{{ChangelogItem|1.5.4-9.11342|Added alternative syntax}}
{{ChangelogItem|1.5.4-9.11413|Added formFields}}

==See Also==
{{Resource_functions}}

FetchRemote

2020-07-25T18:23:36Z

Haxardous: /* Syntax */

__NOTOC__
{{Server client function}}
This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

If you are using fetchRemote to connect to a PHP script, you can use ''file_get_contents("php://input")'' to read the '''postData''' sent from this function.
{{Note|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
{{ Warning| function won't trigger inside another fetchRemote function }}
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL, [ string queueName = "default" ], [ int connectionAttempts = 10, int connectTimeout = 10000 ], function callbackFunction, [ string postData = "" ], [ bool postIsBinary = false ], [ arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''error''''' - A number containing the error number or zero if there was no error. A list of possible error values are:
{{Error_codes_for_callRemote_and_fetchRemote}}
<div style="padding-left:19px;">
*'''''arguments...''''' - The arguments that were passed into fetchRemote
</div>

===Optional Arguments===
{{New items|4.0153|1.5.3-9.11270|
*'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
}}
*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 10 seconds. Therefore, the default setting of 10 connection attempts means it will be 100 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 20 seconds''
*'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out
*'''postData:''' A string specifying any data you want to send to the remote HTTP server.
*'''postIsBinary :''' A boolean specifying if the data is text, or binary.
*'''arguments:''' Any arguments you may want to pass to the callback.

{{New items|5.0154|1.5.4-9.11342|
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, table options ], callback callbackFunction[, table callbackArguments ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response
**'''''responseInfo''''' - A table containing:
***'''''success''''' - A boolean indicating if the request was successful.
***'''''statusCode''''' - An integer status/error code
***'''''headers''''' - A table containing the HTTP response headers
**'''''arguments...''''' - The arguments that were passed into fetchRemote

===Optional Arguments===
*'''options:''' A table containing any request options:
**'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
**'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''(Defaults to 10)''
**'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out. ''(Defaults to 10000)''
**'''postData:''' A string specifying any data you want to send to the remote HTTP server.
**'''postIsBinary :''' A boolean specifying if the data is text, or binary. ''(Defaults to false)''
**'''method:''' A string specifying the request method. ''(Defaults to GET or POST)''
**'''headers:''' A table containing HTTP request headers. ''e.g.{ Pragma="no-cache" }''
**'''maxRedirects:''' An integer limiting the number of HTTP redirections to automatically follow. ''(Defaults to 8)''
**'''username:''' A string specifying the username for protected pages.
**'''password:''' A string specifying the password for protected pages.
{{New items|5.0154|1.5.4-9.11413|
**'''formFields:''' A table containing form items to submit. (for POST method only) ''e.g.{ name="bob", email="bob@example.com" }''
}}
*'''arguments:''' A table containing arguments you may want to pass to the callback.
}}

===Returns===
{{New items|5.0154|1.5.7-9.20307|
Returns a '''''request''''' value which can be used with [[GetRemoteRequestInfo|getRemoteRequestInfo]] or [[AbortRemoteRequest|abortRemoteRequest]]
}}

==Example==
This example shows you how you can fetch an image from a web page, and transfer it to a particular client:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function startImageDownload( playerToReceive )
fetchRemote ( "http://www.example.com/image.jpg", myCallback, "", false, playerToReceive )
end

function myCallback( responseData, error, playerToReceive )
if error == 0 then
triggerClientEvent( playerToReceive, "onClientGotImage", resourceRoot, responseData )
end
end
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent( "onClientGotImage", true )
addEventHandler( "onClientGotImage", resourceRoot,
function( pixels )
if myTexture then
destroyElement( myTexture )
end
myTexture = dxCreateTexture( pixels )
end
)

addEventHandler("onClientRender", root,
function()
if myTexture then
local w,h = dxGetMaterialSize( myTexture )
dxDrawImage( 200, 100, w, h, myTexture )
end
end
)
</syntaxhighlight>
</section>
<br/>
{{New items|5.0154|1.5.4-9.11413|
Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/user_manual.html)
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
sendOptions = {
queueName = "My Mailgun queue",
connectionAttempts = 3,
connectTimeout = 5000,
formFields = {
from="Excited User <excited@samples.mailgun.org>",
to="devs@mailgun.net",
subject="Hello",
text="Testing some Mailgun awesomness!",
},
username="api",
password="key-3ax6xnjp29jd6fds4gc373sgvjxteol0",
}
fetchRemote( "https://api.mailgun.net/v3/samples.mailgun.org/messages", sendOptions, mailgunCompleteCallback )

function mailgunCompleteCallback(data, info)
outputDebugString( "mailgunComplete"
.. " success:" .. tostring(info.success)
.. " statusCode:" .. tostring(info.statusCode)
.. " data:" .. tostring(data)
)
end
</syntaxhighlight>
</section>

Changing post content on IPS forum.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local apiKey = "12345678123456781234567812345678" -- key from ips admin panel
local forumAddress = "https://yourForum.com"
function setPostContent(postID,content)
local sendOptions = {
queueName = "updatePost",
connectionAttempts = 1,
connectTimeout = 50,
formFields = {
post = content,
},
}
fetchRemote( forumAddress.."/api/forums/posts/"..postID.."?key="..apiKey, sendOptions, function()end)
end

setPostContent(1, "this is a first post on this forum")
</syntaxhighlight>
</section>
}}

==Requirements==
{{Requirements|1.3.0-9.03739|1.3.2|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04605|Added connectionAttempts argument}}
{{ChangelogItem|1.3.2|Added client side}}
{{ChangelogItem|1.5.3-9.11270|Added queueName argument}}
{{ChangelogItem|1.5.4-9.11342|Added alternative syntax}}
{{ChangelogItem|1.5.4-9.11413|Added formFields}}

==See Also==
{{Resource_functions}}

SaveMapData

2020-07-17T16:26:13Z

Haxardous: /* Syntax */

{{Server function}}
__NOTOC__
This converts a set of elements in the element tree into XML. This is a format that can then be loaded as a map file. Each element represents a single XML node.

==Syntax==
<syntaxhighlight lang="lua"> bool saveMapData ( xmlnode node, element baseElement [, bool childrenOnly = false ] )</syntaxhighlight>

===Required Arguments===
*'''node''': An existing node that should contain the contents of baseElement
*'''baseElement''': The first element to output to the XML tree. This element and all its children (and their children, etc) will be output.

===Optional Arguments===
{{OptionalArg}}
*'''childrenOnly''': Defines if you want to only save children of the specified element.

===Returns===

==Example==
Saving your resource's data to an [https://forum.mtasa.com/topic/126081-map-files map file] (untested)
<syntaxhighlight lang="lua">
local file = xmlCreateFile("saved.map", "map")
if file then
saveMapData ( file, getResourceRootElement(getThisResource()) )
xmlSaveFile ( file )
xmlUnloadFile ( file )
end
</syntaxhighlight>

==See Also==
{{Map functions}}

SaveMapData

2020-07-17T16:25:52Z

Haxardous: /* Example */

{{Server function}}
__NOTOC__
This converts a set of elements in the element tree into XML. This is a format that can then be loaded as a map file. Each element represents a single XML node.

==Syntax==
<syntaxhighlight lang="lua"> bool saveMapData ( xmlnode node, element baseElement [, bool childrenOnly = false ] )</syntaxhighlight>

===Required Arguments===
*'''node''': An existing node that should contain the contents of baseElement
*'''baseElement''': The first element to output to the xml tree. This element and all its children (and their children, etc) will be output.

===Optional Arguments===
{{OptionalArg}}
*'''childrenOnly''': Defines if you want to only save children of the specified element.

===Returns===

==Example==
Saving your resource's data to an [https://forum.mtasa.com/topic/126081-map-files map file] (untested)
<syntaxhighlight lang="lua">
local file = xmlCreateFile("saved.map", "map")
if file then
saveMapData ( file, getResourceRootElement(getThisResource()) )
xmlSaveFile ( file )
xmlUnloadFile ( file )
end
</syntaxhighlight>

==See Also==
{{Map functions}}

LoadMapData

2020-07-17T16:24:49Z

Haxardous: /* Example */

{{Server function}}
__NOTOC__
This function is intended to load data from a loaded XML file into the element tree. This could be used for loading an external map, or part of another map.

==Syntax==
<syntaxhighlight lang="lua">
element loadMapData ( xmlnode node, element parent )
</syntaxhighlight>

===Required Arguments===
*'''node:''' The node that you wish to load into the [[element tree]].
*'''parent:''' The node you wish to be the parent of the new map data.

===Returns===
Returns an [[element]] object that corresponds to the root of the new data added, i.e. an element that represents the ''node'' xmlnode passed to the function. Returns ''false'' if the arguments are invalid.

==Example==
This example is a function that you could use to load an arbitary [https://forum.mtasa.com/topic/126081-map-files map file] into the [[element tree]].
<syntaxhighlight lang="lua">
function loadMapFile ( filename )
node = getResourceConfig ( filename )
-- Check if the file was loaded ok
if ( node ) then
-- Load the loaded xml file into the element tree
loadMapData ( node, getRootElement() )
-- Unload the xml file again
xmlUnloadFile ( node )
end
end
</syntaxhighlight>

==See Also==
{{Map_functions}}

Introduction to Scripting the GUI

2020-07-04T12:21:32Z

Haxardous:

One important feature in MTA:SA is the ability to script customized GUI (Graphic User Interface). The GUI consists of windows, buttons, edit boxes, checkboxes... Almost every standard form components in graphical environments. They can be displayed while the user is in-game, and used for inputs and outputs in place of traditional commands.

[[Image:AdminGUI.png|thumb|Admin Console GUI]]

==A tutorial to make a login window==
In this tutorial, we'll make a simple login window, with two input boxes and a button. The window appears when the player joins the game, and once the button is clicked, the player is spawned. The tutorial will continue the gamemode we made in [[Scripting Introduction|Introduction to Scripting]] ''(If you have used the [[Scripting Introduction|Introduction to Scripting]], you will need to remove or comment the [[spawnPlayer]] line in the "joinHandler" function in your code, as we will be replacing it with a GUI alternative in this tutorial)''. We'll also take a look at client-side scripting.

===Draw the window===
All the GUI must be made client-side. It is also a good practice to keep all the client scripts in a separate folder.

Browse to /Your MTA Server/mods/deathmatch/resources/myserver/ directory, and create a folder named "client". Under /client/ directory, create a text file and name it "gui.lua".

In this file we will write a function that draws the window. To create a window we will use [[guiCreateWindow]]:
<syntaxhighlight lang="lua">
function createLoginWindow()
-- define the X and Y positions of the window
local X = 0.375
local Y = 0.375
-- define the width and height of the window
local Width = 0.25
local Height = 0.25
-- create the window and save its element value into the variable 'wdwLogin'
-- click on the function's name to read its documentation
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)
end
</syntaxhighlight>

===Relative and Absolute===
Note that the final argument passed to guiCreateWindow in the above example is ''true''. This indicates that the coordinates and dimensions of the window are '''relative''', meaning they are a ''percentage'' of the total screen size. This means that if the far left side of the screen is 0, and the far right is 1, an X position of 0.5 would represent the center point of the screen. Similarly, if the top of the screen is 0 and the bottom is 1, a Y position of 0.2 would be 20% of the way down the screen. The same principles apply to both Width and Height as well (with a Width value of 0.5 meaning the window will be half as wide as the screen).

The alternative to using relative values is using '''absolute''' (by passing ''false'' instead of true to guiCreateWindow). Absolute values are calculated as the total number of pixels from the top-left corner of the parent (if no GUI element parent is specified, the parent is the screen itself). If we assume a screen resolution of 1920x1200, the far left side of the screen being 0 pixels and the far-right being 1920 pixels, an X position of 960 will represent the center point of the screen. Similarly, if the top of the screen is 0 pixels and the bottom is 1200, a Y position of 20 would be 20 pixels down from the top of the screen. The same principles apply to both Width and Height as well (with a Width value of 50 meaning the window will be 50 pixels wide). ''You can use [[guiGetScreenSize]] and a little maths to calculate certain absolute positions.''

The differences between using relative and absolute values are quite simple; GUI created using absolute values will always remain exactly the same pixel size and position, while GUI created using relative values will always be a percentage of its parent's size.

Absolute is generally easier to maintain when editing code by hand, however, your choice of type depends on the situation you are using it for.

For the purposes of this introduction, we will be using relative values.

===Adding the components===
Next, we'll add the text labels (saying "username:" and "password:"), edit boxes (for entering your data), and a button to log in.

To create buttons we use [[guiCreateButton]] and to create edit boxes use [[guiCreateEdit]]:

'''Note that we are now writing more code for our existing 'createLoginWindow' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)

-- define new X and Y positions for the first label
X = 0.0825
Y = 0.2
-- define new Width and Height values for the first label
Width = 0.25
Height = 0.25
-- create the first label, note the final argument passed is 'wdwLogin' meaning the window
-- we created above is the parent of this label (so all the position and size values are now relative to the position of that window)
guiCreateLabel(X, Y, Width, Height, "Username", true, wdwLogin)
-- alter the Y value, so the second label is slightly below the first
Y = 0.5
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)

X = 0.415
Y = 0.2
Width = 0.5
Height = 0.15
edtUser = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
Y = 0.5
edtPass = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
-- set the maximum character length for the username and password fields to 50
guiEditSetMaxLength(edtUser, 50)
guiEditSetMaxLength(edtPass, 50)

X = 0.415
Y = 0.7
Width = 0.25
Height = 0.2
btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)

-- make the window invisible
guiSetVisible(wdwLogin, false)
end
</syntaxhighlight>
Note that every GUI component created is a child of the window, this is done by specifying the parent element (wdwLogin, in this case) when creating the component.

This is very useful because not only does it mean that all the components are attached to the window and will move with it, but also that any changes done to the parent window will be applied down the tree to these child components. For example, we can now hide all of the GUI we just created by simply hiding the window:
<syntaxhighlight lang="lua">
guiSetVisible(wdwLogin, false) --hides all the GUI we made so we can show them to the player at the appropriate moment.
</syntaxhighlight>

===Using the function we wrote===
The createLoginWindow function is now complete, but it won't do anything until we call it. It is recommended to create all GUI when the client resource starts, hide them, and show them to the player later when needed. Therefore, we'll write an event handler for "[[onClientResourceStart]]" to create the window:
<syntaxhighlight lang="lua">
-- attach the event handler to the root element of the resource
-- this means it will only trigger when its own resource is started
addEventHandler("onClientResourceStart", getResourceRootElement(),
function ()
createLoginWindow()
end
)
</syntaxhighlight>

As this is a login window, we now need to show the window when the player joins the game.
This can be done using the same event, "[[onClientResourceStart]]", so we can modify the above code to include showing the window:

'''Note that we are now writing more code for our existing 'onClientResourceStart' handler. This is not a new event handler and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(),
function ()
-- create the log in window and its components
createLoginWindow()

-- output a brief welcome message to the player
outputChatBox("Welcome to My MTA:SA Server, please log in.")

-- if the GUI was successfully created, then show the GUI to the player
if (wdwLogin ~= nil) then
guiSetVisible(wdwLogin, true)
else
-- if the GUI hasn't been properly created, tell the player
outputChatBox("An unexpected error has occurred and the login GUI has not been created.")
end

-- enable the player's cursor (so they can select and click on the components)
showCursor(true)
-- set the input focus onto the GUI, allowing players (for example) to press 'T' without the chatbox opening
guiSetInputEnabled(true)
end
)
</syntaxhighlight>

Note that we have a simple security check before making the window visible, so in the unlikely event that the window has not been created, meaning wdwLogin is not a valid element, we don't get an error and just inform the player what has happened.
In the next step, we will create the button functionality for the login button.

==Scripting the button==
Now that we have created our GUI and shown it to the player, we need to make it work.

===Detecting the click===
When the player clicks on any part of the GUI, the event "[[onClientGUIClick]]" will be triggered for the GUI component you clicked on. This allows us to easily detect any clicks on the GUI elements we want to use.
For example, we can attach the event to the btnLogin button to catch any clicks on it:
<syntaxhighlight lang="lua">
-- attach the event onClientGUIClick to btnLogin and set it to trigger the 'clientSubmitLogin' function
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>
'''Note the final argument passed is "false". This indicates that the event will only trigger directly on btnLogin, not if the event has propagated up or down the tree. Setting this to "true" while attaching to GUI elements will mean that clicking on any element in the same branch will trigger this event.'''

This line of code can now be added inside the createLoginWindow function. It is a common mistake to try and attach events to non-existent GUI elements, so make sure you always attach your events '''after''' the GUI element (in this case, the button) has been created:

'''Note that we are now writing more code for our existing 'createLoginWindow' function.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
-- create all our GUI elements
...

-- now add our onClientGUIClick event to the button we just created
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>

===Managing the click===
Now that we can detect when the player clicks on the button, we need to write code to manage what happens when they do.
In our [[onClientGUIClick]] event handle, we told it to call the function clientSubmitLogin whenever btnLogin is clicked.
Therefore, we can now use the function clientSubmitLogin to control what happens when the button is clicked:
<syntaxhighlight lang="lua">
-- create the function and define the 'button' and 'state' parameters
-- (these are passed automatically by onClientGUIClick)
function clientSubmitLogin(button,state)
-- if our login button was clicked with the left mouse button, and the state of the mouse button is up
if button == "left" and state == "up" then
-- move the input focus back onto the game (allowing players to move around, open the chatbox, etc)
guiSetInputEnabled(false)
-- hide the window and all the components
guiSetVisible(wdwLogin, false)
-- hide the mouse cursor
showCursor(false)
end
end
</syntaxhighlight>
Now, when the button is clicked, the window will be hidden and all controls will be returned to the player. Next, we will tell the server to allow the player to spawn.

===Triggering the server===
Triggering the server can be done using [[triggerServerEvent]]. This allows you to trigger a specified event on the server from the client. The same can be done in reverse using [[triggerClientEvent]].
Here, we use the [[triggerServerEvent]] function to call our own custom event on the server, named "submitLogin", which will then control the spawning of the player serverside.

'''Note that we are now writing more code for our existing 'clientSubmitLogin' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function clientSubmitLogin(button,state)
if button == "left" and state == "up" then
-- get the text entered in the 'username' field
local username = guiGetText(edtUser)
-- get the text entered in the 'password' field
local password = guiGetText(edtPass)

-- if the username and password both exist
if username and password then
-- trigger the server event 'submitLogin' and pass the username and password to it
triggerServerEvent("submitLogin", getRootElement(), username, password)

-- hide the gui, hide the cursor and return control to the player
guiSetInputEnabled(false)
guiSetVisible(wdwLogin, false)
showCursor(false)
else
-- otherwise, output a message to the player, do not trigger the server
-- and do not hide the gui
outputChatBox("Please enter a username and password.")
end
end
end
</syntaxhighlight>

===Creating the serverside event===
At this point we now have all the code needed on the client-side, so open up your serverside 'script.lua' file (from the [[Scripting Introduction|Introduction to Scripting]]) or another suitable serverside file to work with.

On the server-side, recall that we are spawning the player as soon as they log in.
So, first of all, we will need to define the custom event that we used before on the client. This can be done using [[addEvent]] and [[addEventHandler]].
<syntaxhighlight lang="lua">
-- create our loginHandler function, with a username and password parameters (passed from the client GUI)
function loginHandler(username,password)

end

-- define our custom event, and allow it to be triggered from the client ('true')
addEvent("submitLogin",true)
-- add an event handler so that when submitLogin is triggered, the function loginHandler is called
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>

===Logging in===
Now we have a function that is called through the custom event 'submitLogin', we can start to work on logging in and spawning the player, using our 'loginHandler' function:
<syntaxhighlight lang="lua">
function loginHandler(username,password)
-- check that the username and password are correct
if username == "user" and password == "apple" then
-- the player has successfully logged in, so spawn them
if (client) then
spawnPlayer(client, 1959.55, -1714.46, 10)
fadeCamera(client, true)
setCameraTarget(client, client)
outputChatBox("Welcome to My Server.", client)
end
else
-- if the username or password are not correct, output a message to the player
outputChatBox("Invalid username and password. Please re-connect and try again.",client)
end
end

addEvent("submitLogin",true)
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>
'''For the purposes of this tutorial, a very basic username and password system is shown. For a more comprehensive alternative, you can use the Account System or a MySQL database.'''

Also note the use of the variable "client", it's an internal variable used by MTA to identify the player who triggered the event.

Finally, do not forget to include the new gui.lua file in the meta.xml of the main resource, and label it as a client script:
<syntaxhighlight lang="xml">
<script src="client/gui.lua" type="client" />
</syntaxhighlight>

At this point, we now have a basic login window that checks the player's username and password when the login button is clicked. If they are correct, the player is automatically spawned.

For further help with GUI, see the [[:Category:GUI_Tutorials|GUI tutorials]].

[[Category:GUI_Tutorials]]
[[hu:Introduction to Scripting the GUI]]
[[it:Introduzione_allo_scripting_della_GUI]]
[[ru:Introduction to Scripting the GUI]]
[[es:Introducción a la Programación de GUI]]
[[zh-cn:脚本编写介绍 - 带有图形界面]]

Scripting Introduction

2020-07-04T12:19:39Z

Haxardous:

Resources are a key part of MTA. A resource is essentially a folder or zip file that contains a collection of files, plus a "meta" file that describes to the server how the resource should be loaded and what files it does contain. A resource can be seen as being partly equivalent to a program running in an operating system - it can be started and stopped, and multiple resources can run at once.

Everything that has to do with scripting happens in resources, what a resource does defines if it is a gamemode, a map, or anything else. MTA comes with resources that you can optionally use in your gamemodes, such as map limits to keep playings within a playing area or death-pickups to create weapon pickups.
{{tip|Your first step to begin Lua scripting should be using a Lua editor. This makes scripting much easier. We recommend [https://code.visualstudio.com/ Visual Studio Code], [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] or [https://www.sublimetext.com/ Sublime Text]}}

==Creating a working script==
We will first learn how to make a basic script that lets the player walk around in the city, step by step.
===Where are all the scripts?===
Let's take a look at the script's file structure. Go to your MTA Server folder, and follow the path below:

server/mods/deathmatch/resources/

You will see a lot of .zip files, which are the packaged sample scripts shipped with MTA. Each file is a "resource", and they will all be unzipped and loaded by the server when it starts. To create your own resource, simply make a folder with your preferred name. We'll use "myserver" for this tutorial.

Now you should be under this directory:

server/mods/deathmatch/resources/myserver/

===Identifying your resource===
In order to let the server know what's in the resource, a ''meta.xml'' file must be created to list the resource's content. It must be located in the resource's root directory, which is the "myserver" folder in our case. So create a text file and name it "meta.xml", and open it with notepad.

Enter the following codes in the ''meta.xml'' file:
<syntaxhighlight lang="xml">
<meta>
<info author="YourName" type="gamemode" name="My Server" description="My first MTA server" />
<script src="script.lua" type="server" />
</meta>
</syntaxhighlight>
In the ''<info />'' tag, there's a "type" field which indicates that the resource is a ''gamemode'' instead of a regular include or a ''map'', which will be explained later. A gamemode is what you need to make a stand-alone server.

The ''<script />'' tag indicates the script files contained in the resource, which we will create next.
===Creating a simple script===
Note that in the ''<script />'' tag above, the .lua file is not under another directory. Therefore we'll create the file in the same folder as meta.xml. Now you can copy and paste the following code into script.lua:
<syntaxhighlight lang="lua">
local spawnX, spawnY, spawnZ = 1959.55, -1714.46, 10
function joinHandler()
spawnPlayer(source, spawnX, spawnY, spawnZ)
fadeCamera(source, true)
setCameraTarget(source, source)
outputChatBox("Welcome to My Server", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>
The script will spawn you at the coordinate (x, y, z) specified above when you join the game. Note that the ''fadeCamera'' function must be used or the screen will be black. Also, in releases after DP2, you need to set the camera target (otherwise all the players will see is the blue sky).

The '''source''' variable indicates who triggered the event. Since a player has joined when the code is triggered, you use this variable to look which has joined. So it'll spawn that player instead of everyone or a random person.

If we have a closer look on [[addEventHandler]], you can see 3 things: 'onPlayerJoin', which indicates when it's triggered. getRootElement(), which shows by what/who it can be triggered. (getRootElement() is everything/everyone) And joinHandler, which indicates the function that has to be triggered after the event is triggered. Other details will be explained later in another example, now let's just run the server and try it out!

===Running the script===
To get the server started, simply run the executable under the server/ directory. A list of server stats will be shown first; note the port number, which you'll need when joining the game. Then the server loads all the resources under the mods/deathmatch/resources/ directory, and then "ready to accept connections!"

Before you connect to the server, you must run the gamemode. Type "start myserver" and press Enter. The server will start the gamemode you just created, and will also show any errors and warnings from this point on. Now you can start the MTA client, and "Quick Connect" using the IP address of your server and the port number you saw earlier. If all goes well, after a few seconds your character will be walking on the streets of Los Santos.

Next, we'll add a command to your script that players can use to spawn a vehicle beside their position. You may skip it and check out more advanced scripting with the [[Map manager|Map Manager]], which continues this tutorial. Another branch from this tutorial is [[Introduction to Scripting GUI]], you may follow it to see how the Graphical User Interface in MTA is drawn and scripted.

==Creating a simple command==
Let's go back to the content of the ''script.lua'' file. As mentioned above, we want to provide a command to create a vehicle beside your current position in the game. Firstly we need to create a function we want to call and a command handler that creates the command the player will be able to enter in the console.

<syntaxhighlight lang="lua">
-- create the function the command handler calls, with the arguments: thePlayer, command, vehicleModel
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- create a vehicle and stuff
end

-- create a command handler
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>
''Note: Function names are clickable in code examples on the wiki and linked to the functions' documentation.''

====About command handlers====
The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.

If you have already experienced in scripting, you will know that you call a function like this:
<syntaxhighlight lang="lua">
functionName(argument1, argument2, argument3, ..)
</syntaxhighlight>
<syntaxhighlight lang="lua">
functionName(thePlayer, commandName, argument3, ..)
</syntaxhighlight>
If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.

We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similar manner, internally.

For example someone types "createvehicle 468" in-game in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:
<syntaxhighlight lang="lua">
createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command
</syntaxhighlight>
As we can see, it provides several parameters: the player who called the command, the command he entered, and whatever text he had after that, in this case, "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).

''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''

====Writing the function====
In order to fill the function we created, we need to think about what we have to do:
* Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)
* Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)
* Spawn the vehicle
* Check if it has been spawned successfully, or output a message

In order to achieve our goals, we have to use several functions. To find the function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First, we need a function to get the player's position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns, and usually an example. The syntax shows us what arguments we can or have to submit.

For [[getElementPosition]], the syntax is:
<syntaxhighlight lang="lua">
float, float, float getElementPosition ( element theElement )
</syntaxhighlight>

The three ''float'' in front of the function name is the return type. In this case, it means the function returns three floating-point numbers. (x, y, and z) Within the parentheses, you can see what arguments you have to submit. In this case, only the element whose position you want to get, which is the player in our example.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- get the position and put it in the x,y,z variables
-- (local means, the variables only exist in the current scope, in this case, the function)
local x,y,z = getElementPosition(thePlayer)
end
</syntaxhighlight>

Next, we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
end
</syntaxhighlight>

Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.

We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
-- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
end
</syntaxhighlight>

Of course, this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.

Now we have our complete script:
<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
-- check if the return value was ''false''
if (createdVehicle == false) then
-- if so, output a message to the chatbox, but only to this player.
outputChatBox("Failed to create vehicle.",thePlayer)
end
end
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>

As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].

==What you need to know==
You already read some things about resources, command handlers, and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things while linking to related pages if possible.
===Clientside and Serverside scripts===
You may have already noticed these or similar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still, others are better off to be serverside or just don't work clientside.

Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script, for example, you would create an ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:
<syntaxhighlight lang="xml">
<script src="client.lua" type="client" />
</syntaxhighlight>
The ''type'' attribute defaults to 'server', so you only need to specify it for client-side scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].

===More complex resources===
The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:

====First example - A utility script====
<syntaxhighlight lang="xml">
/admin_commands
/meta.xml
/commands.lua
/client.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="admin commands" />
<script src="commands.lua" type="server" />
<script src="client.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server
* The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily

This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also won't interfere with the gameplay, unless an admin decides to take some action of course.

====Second example - A gamemode====
<syntaxhighlight lang="xml">
/counterstrike
/meta.xml
/counterstrike.lua
/buymenu.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike remake" type="gamemode" />
<script src="counterstrike.lua" type="server" />
<script src="buymenu.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''counterstrike.lua'' contains similar to the following features:
** Let players choose their team and spawn them
** Provide them with weapons, targets, and instructions (maybe read from a Map, see below)
** Define the game's rules, e.g. when does the round end, what happens when a player dies
** .. and maybe some more
* The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons

This example can be called a gamemode, since it not only interferes with the gameplay but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.

This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example of a map is stated in the next example.

====Third example - A Map====
<syntaxhighlight lang="xml">
/cs-airport
/meta.xml
/airport.map
/airport.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" />
<map src="airport.map" />
<script src="airport.lua" type="server" />
</meta>
</syntaxhighlight>

* The ''airport.map'' in an XML file that provides information about the map to the gamemode, these may include:
** Where the players should spawn, with what weapons, what teams there are
** What the targets are
** Weather, World Time, Timelimit
** Provide vehicles
* The ''airport.lua'' might contain map-specific features, that may include:
** Opening some door/make something explode when something specific happens
** Create or move some custom objects, or manipulate objects that are created through the .map file
** .. anything else map-specific you can think of

As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case, the gamemode from the above example.
What may come as a surprise is that there is also a script in the Map resource. Of course, this is not necessarily needed in a map but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.

The ''airport.map'' file might look similiar to this:
<syntaxhighlight lang="xml">
<map mode="deathmatch" version="1.0">
<terrorists>
<spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" />
</terrorists>
<counterterrorists>
<spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" />
</counterterrorists>

<bomb posX="23342.23" posY="" posZ="" />

<vehicle posX="" posY="" posZ="" model="602" />
<vehicle posX="" posY="" posZ="" model="603" />
</map>
</syntaxhighlight>

When a gamemode is started with a map, the map resources are automatically started by the map-manager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.

===Events===
[[Event|Events]] are the way MTA tells scripts about things that happen. For example, when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].

This example will output a message with the name of the player who died:
<syntaxhighlight lang="lua">
function playerDied(totalAmmo, killer, killerWeapon, bodypart)
outputChatBox(getPlayerName(source).." died!")
end
addEventHandler("onPlayerWasted",getRootElement(),playerDied)
</syntaxhighlight>

Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea of how ''source'' is used.

==Where to go from here==
You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials, and References that allow a deeper look into the topics you desire to learn about.
{{note|From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts. We also recommend you to use the [[predefined variables list]] to help you with certain tasks and make scripting easier and faster.}}
'''See also:'''
* [[OOP_Introduction|OOP Scripting Introduction]]
* [[Advanced Topics]]
* [[Script_security|Script security]]
* [[Scripting Introduction Urdu]]
[[hu:Bevezetés a scriptelésbe]]
[[es:Introducción a la Programación]]
[[it:Introduzione allo scripting]]
[[nl:Scripting_introductie]]
[[pt-br:Introdução ao Scripting]]
[[ru:Scripting Introduction]]
[[ar:مقدمه_في_البرمجه]]
[[zh-cn:脚本编写介绍]]
[[Category:Tutorials]]

Client on Linux Manual

2020-04-23T00:11:06Z

Haxardous:

{{Needs Checking|MTA: SA 1.5 and greater versions seem to have problems when launching under Wine.}}
{{Warning|This page is for Linux players '''ONLY''', for Windows go [[Client Manual|here]].|true}}
==Before you start==

First of all, please ensure your computer fits the requirements needed.
Read the [[Client_Manual|Client Manual]] page for further informations, or join us on [https://mtasa.com/discord Discord].

===Requirements===
The hardware requirements for Multi Theft Auto: San Andreas are the same as on Windows.
For software requirements, you need:
* Wine (get it on your package manager (synaptic, apt, pacman, yum, etc.); follow instructions [https://www.winehq.org/download/ubuntu here] if you're using Ubuntu
(as of MTA 1.4.1 Ubuntu's default Wine package seems to be incompatible with Visual C++, which is required to install MTA)
* Windows fonts installed:
** tahoma.ttf
** tahomabd.ttf
** verdana.ttf
Get them on the Internet, e.g. [http://fontonic.com/ fontonic.com]

Or get the zip archive with the 3 fonts {{WineFonts}}.

Install them in: <syntaxhighlight lang="lua">~/.wine/dosdevices/c:/windows/Fonts/</syntaxhighlight>
(~/ points to your user home folder on Linux, .wine is the default wineprefix)

==Installing the game==
Download the MTA installer from [http://www.mtasa.com mtasa.com], ensure you can launch it (chmod +x) then install it when you want.

==Running the game==
Once installed, double-clicking on the Multi Theft Auto.exe should work. If not, try in a terminal the following command: "wine Multi Theft Auto.exe" in the directory you installed Multi Theft Auto to.
If it doesn't work, check the contents of the file c:/Program_Files/Multi Theft Auto/MTA/CEGUI.log, which may contain useful information.

==Known issues==
===Specific issues===
* Impossible connection through the server browser [Fixed in the [http://bugs.mtasa.com/view.php?id=5084 5084 bug] ]

* MTA won't start on Ubuntu 12.04 LTS [Temporary fix is available [http://forum.mtasa.com/viewtopic.php?p=434011#p434011 here] ]

===Other issues===
* MTA isn't starting (even with fonts installed)
#Try to start MTA:SA in a virtual desktop
#:Go to WineConfig, choose the tab "Graphics" and select "Emulate a virtual desktop".<br>
#Try to delete your gta_sa.set file
#:which is located in the "GTA San Andreas User Files" folder, which can be found in your home directory.<br>'''(Remember to create a copy, if you're playing San Andreas in singleplayer)'''
#Try to delete your MTA config file
#:which is: "MTA San Andreas 1.3/MTA/coreconfig.xml"<br>'''(Also remember to create a copy, if you don't want to lose your edited MTA configuration)'''

* Crash when connecting
*:Sometimes the audio-server makes problems (could be related to PulseAudio), in this case, you've to go to WineConfig and choose the tab Audio, then deselect "ALSA" and select "EsoundD". Save the settings and restart MTA.
* Crash in basswma.dll module while streaming audio
*:Install Windows Media Player 10
*:
<syntaxhighlight lang="lua">
winetricks wmp10
</syntaxhighlight>
* Special Detections (SD)
*:If you are using a 64 wine version you may have problems with [http://wiki.multitheftauto.com/wiki/Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E Special Detections]. If the server you are trying to connect keeps showing something like [http://i.imgur.com/33T8a82.jpg this], then you should make a [http://wiki.archlinux.org/index.php/Wine#Using_WINEARCH 32 bit wine prefix] (or bottle).
*:
<syntaxhighlight lang="lua">export WINEARCH=win32 WINEPREFIX=~/.winegta
winecfg</syntaxhighlight>
Change Windows version on the bottom to Windows 7 and press OK. Now you have a 32-bit wine prefix on ~/.winegta.
Install GTA:SA and them MTA.
After this, MTA and GTA have been installed within ~/.winegta prefix which is a 32-bit wine environment.

== See Also ==
* [http://nightly.mtasa.com/ nightly.mtasa.com] - For nightly builds.
* https://bugs.mtasa.com/view.php?id=8895 - a bug report containing useful info for running MTA in Wine
[[Category:Support]]
[[ru:Client on Linux Manual]]
[[hu:Client on Linux Manual]]

Branches

2020-04-19T19:54:08Z

Haxardous:

== Weapon Creation ==
Weapon creation is a branch for creating weapon elements which can fire bullets and do not require ped/players assigned to them.
{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:green">Merged - 1.3.1</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/weapon-creation Weapon-Creation]
|-
|'''Branch version'''
|1.4
|}

=== Functions ===
{{Client_weapon_creation_functions}}

=== General Notes ===
Created entities are for all intent and purpose objects so any object function will work on them like attachElements, setElementAlpha and such.

=== Media ===
* http://youtu.be/LN1nZZnzlms

== Custom Animations ==
Custom Animations is a branch for loading animations from .ifp files
{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:red">Abandoned</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/Custom-Animations Custom-Animations]
|-
|'''Branch version'''
|1.4
|}

=== Functions ===
* [[engineLoadIFP]]
* [[engineUnloadIFP]]

=== Media ===
* http://youtu.be/D9YfVPiJniU

=== General Notes ===
See [[User:Cazomino05]] for bugs.

== Custom Weapon Stats ==
Custom Weapon Stats is a branch to allow people to edit one of each weapon "properties" for each skill level
so, for example, an M4 at the Pro level can have 1000 damage and an M4 at a standard level can have 0.

{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:green">Merged - 1.3.1</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/Custom-Weapon-Stats Custom-Weapon-Stats]
|-
|'''Branch version'''
|1.4
|}

=== Functions ===
* [[getWeaponProperty]]
* [[setWeaponProperty]]

=== Media ===
* http://youtu.be/M1dQWpDFq98
* http://youtu.be/xfdEvpcuk7s
* http://youtu.be/eDU06fZiU9M

=== General Notes ===
None.

== Analog Control States ==
The Analog Control States is a branch that is designed to allow proper setting and management of controls and therefore allows for the setting of controls to be between the range of 0 and 1 rather than true/false

This only works for certain properties such as left/right

{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:green">Merged - 1.3.1</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/Analog-Control-States Analog-Control-States]
|-
|'''Branch version'''
|1.4
|}

=== Functions ===
* [[setAnalogControlState]]
* [[getAnalogControlState]]

=== Media ===
None.

=== General Notes ===
None.

== Custom-Vehicle-Sirens ==
Custom Vehicle Sirens allows adding sirens to any individual vehicle in the game for instance to add an undercover sultan.

{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:green">Merged - 1.3.1</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/Custom-Vehicle-Sirens Custom-Vehicle-Sirens]
|-
|'''Branch version'''
|1.4
|}

=== Functions ===
* [[SetVehicleSirens]]
* [[GetVehicleSirens]]
* [[RemoveVehicleSirens]]
* [[GetVehicleSirenParams]]
* [[AddVehicleSirens]]

=== Media ===
* http://youtu.be/zjJdLCtKccA
* http://youtu.be/ZJDrVf3qSm0
* http://youtu.be/1J0_v85FioA
* http://youtu.be/X3zE6hZOx4c

=== General Notes ===
None.

== Custom-Train-Tracks ==
See the main page for this branch ([[Custom Train Tracks]]) for more information.
{{:Custom_Train_Tracks}}

== Awesomium ==
Possibility to create in-game browser.

{| class="wikitable" style="width: auto; table-layout: fixed;"
|-
|'''Status'''
|<span style="color:green">Merged - 1.5</span>
|-
|'''Branch'''
|[https://github.com/multitheftauto/mtasa-blue/tree/awesomium Awesomium]
|-
|'''Branch version'''
|1.5
|}

=== Functions ===
See [[User:Jusonex]].

=== Media ===
* http://youtu.be/9w2qU6mZDh8
* http://youtu.be/qvqc1ScZSbM
* http://youtu.be/cyUw1F6uBig

=== General notes ===
See [[User:Jusonex]].

[[Category: Development]]

Building MTASA Server on GNU Linux

2020-04-19T19:53:00Z

Haxardous:

{{Needs Checking|Confirm steps work.}}

== Installing and Running MTASA server on Linux ==
{{Note|This article is only for developers who changed the server code if you are looking for the precompiled server (for normal server owners). Go to: [http://linux.mtasa.com/ linux.mtasa.com] and see [[Installing and Running MTASA Server on GNU_Linux]]}}


== Preparing your system ==

In order to build the Multi Theft Auto dedicated server, you will have to set up your system with the correct libraries and tools. How these are installed depends on your distribution.

Our network module (net.dll or net.so) is distributed as a precompiled binary library. The file for GNU/Linux can be found inside the lastest Linux nightly from [http://nightly.mtasa.com/ here]. Use the net.so from {{Current Version|master}} if you are compiling from the trunk, or the net.so from {{Current Version|full}} if you are compiling the {{Current Version|full}} branch. Be sure the read the top of ''Server/version.h'' as it contains directions on how to compile the different build types.

=== Debian Linux ===

Includes derivative distributions such as Ubuntu.

You will need the necessary build tools, headers and libraries, which are distributed through the following Debian packages (e.g. Debian Lenny):

* '''build-essential:''' contains the necessary tools, headers and libraries to build applications
* '''automake:''' contains the automake tools
* '''libtool:''' contains the libtool software required to build libraries

* '''libreadline-gplv2-dev:''' contains the readline library (version 5)
* '''libncurses5-dev:''' contains software for controlling writing to the console screen
* '''libncursesw5-dev:''' contains support for wide characters

* '''default-libmysqlclient-dev:''' contains the MySQL library
* '''git:''' contains the git client used to check out our code repository
To install these packages through apt, use the apt-get install <package list> command as in the following example (execute as root):

apt-get install build-essential automake libtool
apt-get install libreadline-gplv2-dev libncurses5-dev libncursesw5-dev
apt-get install default-libmysqlclient-dev git

Note: On Debian 8 systems please use this: '''apt-get install build-essential automake libtool libreadline-gplv2-dev libncurses5-dev libncursesw5-dev libmysqlclient-dev git'''
=== Gentoo Linux ===
You will need the necessary build tools, headers, and libraries. Because Gentoo’s portage system is designed to compile any packages on your own system, the necessary build tools will have already been installed. This only leaves you to install the necessary libraries:


* '''git:''' contains the git client used to check out our code repository
To compile and install these packages through emerging, use the emerge -v <package list> command. The -v option shows additional * * information and can be omitted. (If you want to use any USE flags, prepend emerge with USE="use flags here". You can also use the -pv option to verify that you’re using the correct flags.) Refer to the [http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=1 Gentoo Handbook] or manual for more information on emerge.

Example:

emerge -v git sqlite
USE=“net-misc/curl ssl” emerge -v curl

=== Fedora ===

You will need these packages to be able to successfully compile a MTA server on Fedora:
* '''glibc-devel:'''

* '''readline-devel:''' contains the readline library

* '''git:''' contains the git client to check out the source code
To install these packages through yum, use the yum install <package list> command as in the following example (execute as root):

yum install glibc-devel readline-devel git

== General instructions for {{Current Version|master}} ==

'''Downloading the source.'''

First, you need to download the source. Either clone as shown below or [https://github.com/multitheftauto/mtasa-blue/archive/master.zip download a zip snapshot]

git clone <nowiki>https</nowiki>://github.com/multitheftauto/mtasa-blue.git mtasa-blue
cd mtasa-blue

Then compile it thus:

./linux-build.sh

Then copy the configuration files, network module and resources into '''Bin/server''' by running this command:

./linux-install-data.sh

And the resources and stuff should be downloaded and stuff. As well as the net_d.dll file.

=== '''Troubleshooting''' ===

If you’re getting any unexpected errors while compiling, please check our [http://bugs.mtasa.com/ Bug tracker] or our [irc://irc.multitheftauto.com/ IRC channel]

[[ru:Building MTASA Server on GNU Linux]]
[[Category: Development]]

Compiling MTASA

2020-04-19T19:52:26Z

Haxardous:

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Auto client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download'''<br>
[https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)]<br>

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h'''<br>
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib'''<br>
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error'''<br>
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)]<br style="clear:both">

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository.<br>
We recommend cloning the repository in your Git client because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software.<br>
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can go to ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software.<br>
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build.<br>
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.<br>
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise, your
breakpoints will not work for anything besides the MTA Launcher project.<br>
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on the coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

Access Control List

2020-04-19T19:50:15Z

Haxardous:

MTA includes a complete Access Control List (ACL) that allows you to secure and limit access to the server, its functions, and resources in any number of ways.

The key concept of MTA's ACL (and ACLs in general) is that you're giving a specific object a set of rights. In MTA's case objects is one of two things - resources or users. There are numerous ''rights'' available in MTA - these mainly focus on server-side scripting functions.

What this essentially means is that the ACL allows you to choose exactly what functions a resource or user can perform. This can obviously be invaluable - for example preventing all your server's players from being able to ban each other, or preventing your new untested resources from doing the same.

Of course, ''with great power comes great responsibility'' and it is very easily possible to completely break resources - for example, disabling [[spawnPlayer]] for all resources would be a Bad Thing. Of course, there are situations when you might want to do this - if you want to force all your resources to use a spawn manager resource for example, but even this is somewhat draconian.

==Understanding the ACL==
There are two major components to the ACL: groups and ACL lists. They appear as '''<group name="">''' nodes and '''<acl name="" />''' nodes. Their purpose is to:<br \>
'''1.''' Grant users permission to control the server and use resource commands. Examples:''<br \>
*Allowing only admins to use the giveweapon function of freeroam
*Allowing all users to start a resource
'''2.''' Grant resources permission to use script functions and functions of other resources. Examples:<br \>
*Allowing a resource to use the restartResource function
*Allowing a resource to use the call function to use exported functions from another script

===Default Groups===
MTA has provided some default groups with increasing permissions. These groups are:
*'''Everyone'''
*'''Moderator'''
*'''SuperModerator'''
*'''Admin'''
*'''Console''' - This controls permissions of people who are using the console through '''<object name="user.Console" />'''
*'''RPC''' - Remote Procedure Call. Specifically grants access to [[callRemote]] only and disables commands of default resources. Check the function for details.
<br \>

To explain further, I will use the Everyone group as an example. By default it looks like this:
<syntaxhighlight lang="xml"> <group name="Everyone">
<acl name="Default" />
<object name="user.*" />
<object name="resource.*" />
</group>
</syntaxhighlight>
<br \>
You will first notice the acl name inside the group. It defines what permissions the group has. Users and resources in this group will have the permissions specified on the "Default" acl name list. ''Note: You will notice this group is special, in that it includes every user and resource by using a '''wildcard (*)''' where the user or resource name would be.''

Now, scroll further down the ACL and you will see the '''<acl name="Default" />''' listing. Note I have trimmed this list dramatically due to its length.

<syntaxhighlight lang="xml"> <acl name="Default">
<right name="command.start" access="false" />
<right name="command.stop" access="false" />
<right name="command.stopall" access="false" />
...etc etc...
<right name="function.executeCommandHandler" access="false" />
<right name="function.setPlayerMuted" access="false" />
<right name="function.restartResource" access="false" />
...etc etc...
<right name="general.adminpanel" access="false" />
<right name="general.tab_players" access="false" />
<right name="general.tab_resources" access="false" />
...etc etc...
<right name="command.freeze" access="false" />
<right name="command.shout" access="false" />
<right name="command.spectate" access="false" />
...etc etc...
</acl>
</syntaxhighlight>
<br \>
*'''Function''' entries are MTA scripting functions. For example, if a resource needed to use restartResource and was only in the 'Everyone' group (with the 'Default' list), it would be denied access to restartResource and fail to work correctly.
*'''Commands''' are created when a resource uses [[addCommandHandler]]. An example would be typing '''/createvehicle [vehicle]''' in the chatbox for the freeroam resource. This controls whether users in the group using this ACL can use the command. ''Note: commands have no effect on resources within the group. Commands are only related to users.''
**''General is a custom right name group created by the admin resource but it works on the same principles. The script works with them by using [[hasObjectPermissionTo]]''

You will notice some groups such as admin have multiple '''<acl name="" />''' nodes. An example is the admin group:
<syntaxhighlight lang="xml">
<group name="Admin">
<acl name="Moderator" />
<acl name="SuperModerator" />
<acl name="Admin" />
<acl name="RPC" />
<object name="resource.admin" />
<object name="resource.webadmin" />
<object name="user.Random" />
</group>
</syntaxhighlight>

This gives all the permissions defined in each '''<acl name="" />''' node in order of listing. So for example, the admin group makes sure all the permissions are given to admins by using all the lists. If there are any conflicts, the lowest entry wins. For example, pretend these 2 acls were in a group in the following order:

'''1.''' '''<acl name="Default">''' sets <right name="general.ModifyOtherObjects" access="false" /> <br/>
'''2.''' '''<acl name="Admin">''' sets <right name="general.ModifyOtherObjects" access="true" /> <br/>
'''3.''' For all users and resources in group admin: <right name="general.ModifyOtherObjects" access="true" /><br/>
<br/>

=== Resource Groups and ACLs ===
You will notice there are some other groups that came with MTA. These were defined by resources that came with MTA. If a resource wants to designate specific ACL rights not provided by the default MTA groups, it can create its own ACL name and a group to use it. I will show AMX's entry as an example. AMX is designed to emulate SA-MP scripts and it needs a certain set of permissions that don't fit the default groups well. It is shown below:

<syntaxhighlight lang="xml">
<group name="AMX">
<acl name="AMX" />
<object name="resource.amx" />
</group>

<acl name="AMX">
<right name="general.ModifyOtherObjects" access="true" />
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="general.adminpanel" access="false" />
...etc etc...
<right name="command.kick" access="false" />
<right name="command.freeze" access="false" />
<right name="command.mute" access="false" />
...etc etc...
</acl>
</syntaxhighlight>

=== Grant resources access to other resources ===
To allow resource access to any other resource, you have to allow it explicitly in your ACL file. The rule <code>general.ModifyOtherObjects</code> grants full access to any resource on the server.
See the example in the last section of what it should look like.

{{New feature/item|3.0156|1.5.5|14166|
If you don't want to grant a resource complete access to every resource on the server, then you can append the modifiable resource's name preceded by a dot (.) to the <code>general.ModifyOtherObjects</code> rule:

<syntaxhighlight lang="xml">
<acl name="Custom">
<right name="general.ModifyOtherObjects.resourceName" access="true" />
<right name="general.ModifyOtherObjects.admin" access="true" />
<right name="general.ModifyOtherObjects.runcode" access="true" />
<right name="general.ModifyOtherObjects.mapmanager" access="true" />
</acl>
</syntaxhighlight>

The ACL definitions above will grant any resource with the ACL '''Custom''' access to the resources ''resourceName'', ''admin'', ''runcode'' and ''mapmanager''.
}}

==Modifying the ACL==
There are three ways you can modify the ACL - how you do it depends on who you are.

===HTTP Interface===
You can use the [[Resource/webadmin|webadmin]] HTTP interface to modify the ACL in your web browser. This is by far the easiest way to do so. Just make sure the ''webadmin'' resource is started on your server and visit ''<nowiki>http://ServerIP:HttpPort/</nowiki>''. You can then use the two sections - ACLs and Groups. ACLs allow you to create your Access Control Lists - lists of rights. Groups allow you to group together collections of users and assign ACLs to them. For example, the ACLs section allows you to specify that the Admin ACL has access to the ''start'' console command. You can go to the Groups section and create an Admin ''group'' that has access to your Admin ''acl''. You can then add users to your Admin ''group''.

===XML file===
You can modify the ACL.xml file manually. This has a fairly straightforward syntax, but it can get a bit confusing at times. If you do it while the server is running, don't forget to call the scripting function [[aclReload]] ("start runcode", "run aclReload()") so the new ACL is loaded, or otherwise stop your server before modifying. This also prevents your changes from being accidentally overwritten by the server.

===Scripting functions===
You can use a large number of ACL scripting functions to modify the ACL on the fly. Of course, you can (and really should!) limit access to the ACL functions with the ACL. Note that the '''admin resource''' that comes with MTA can be used to manage the ACL from the resources tab. You must be set up as admin to use the admin panel. [http://wiki.multitheftauto.com/wiki/Admin Click here for admin setup instructions].

==See Also==
{{ACL functions}}

[[hu:ACL]]
[[Category:Scripting Concepts]]
[[ru:Access Control List]]
[[Category:Tutorials]]

Writing Gamemodes

2020-04-19T19:49:46Z

Haxardous:

This guide tries to outline the process of how to write a proper gamemode. If you just started with scripting for MTA, you may want to check the other scripting tutorials at the [[Main Page]] first.
==Introduction==
A gamemode is a resource that, once started, controls all of the gameplay. This may include telling the players what to do, spawning players, creating teams, defining what the players have to do to win or to get points and much more. Examples are Race and Deathmatch.

==What does "proper gamemode" mean?==
To put it simply, a proper gamemode is one that makes full use of MTA's .map file system. This means that the gamemode code does not have any map-specific data hardcoded in it, like the positions of players or cars. Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows user-made maps with lots of possibilities within the .map file. To alter spawnpoints, objects, etc., the user doesn't need to edit the gamemode itself.

===Map Files===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects, and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Example====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node that defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Example of getting the .map information====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events, you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basically two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the [[Resource:Helpmanager|helpmanager help page]] for details on how to do it.

===Scoreboard===
The scoreboard displays players and teams currently in-game. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the [[Resource:Dxscoreboard|scoreboard help page]] for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specify for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[hu:Writing Gamemodes]]
[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]
[[Category:Tutorials]]

Access Control List

2020-04-19T19:48:33Z

Haxardous:

MTA includes a complete Access Control List (ACL) that allows you to secure and limit access to the server, its functions, and resources in any number of ways.

The key concept of MTA's ACL (and ACLs in general) is that you're giving a specific object a set of rights. In MTA's case objects is one of two things - resources or users. There are numerous ''rights'' available in MTA - these mainly focus on server-side scripting functions.

What this essentially means is that the ACL allows you to choose exactly what functions a resource or user can perform. This can obviously be invaluable - for example preventing all your server's players from being able to ban each other, or preventing your new untested resources from doing the same.

Of course, ''with great power comes great responsibility'' and it is very easily possible to completely break resources - for example, disabling [[spawnPlayer]] for all resources would be a Bad Thing. Of course, there are situations when you might want to do this - if you want to force all your resources to use a spawn manager resource for example, but even this is somewhat draconian.

==Understanding the ACL==
There are two major components to the ACL: groups and ACL lists. They appear as '''<group name="">''' nodes and '''<acl name="" />''' nodes. Their purpose is to:<br \>
'''1.''' Grant users permission to control the server and use resource commands. Examples:''<br \>
*Allowing only admins to use the giveweapon function of freeroam
*Allowing all users to start a resource
'''2.''' Grant resources permission to use script functions and functions of other resources. Examples:<br \>
*Allowing a resource to use the restartResource function
*Allowing a resource to use the call function to use exported functions from another script

===Default Groups===
MTA has provided some default groups with increasing permissions. These groups are:
*'''Everyone'''
*'''Moderator'''
*'''SuperModerator'''
*'''Admin'''
*'''Console''' - This controls permissions of people who are using the console through '''<object name="user.Console" />'''
*'''RPC''' - Remote Procedure Call. Specifically grants access to [[callRemote]] only and disables commands of default resources. Check the function for details.
<br \>

To explain further, I will use the Everyone group as an example. By default it looks like this:
<syntaxhighlight lang="xml"> <group name="Everyone">
<acl name="Default" />
<object name="user.*" />
<object name="resource.*" />
</group>
</syntaxhighlight>
<br \>
You will first notice the acl name inside the group. It defines what permissions the group has. Users and resources in this group will have the permissions specified on the "Default" acl name list. ''Note: You will notice this group is special, in that it includes every user and resource by using a '''wildcard (*)''' where the user or resource name would be.''

Now, scroll further down the ACL and you will see the '''<acl name="Default" />''' listing. Note I have trimmed this list dramatically due to its length.

<syntaxhighlight lang="xml"> <acl name="Default">
<right name="command.start" access="false" />
<right name="command.stop" access="false" />
<right name="command.stopall" access="false" />
...etc etc...
<right name="function.executeCommandHandler" access="false" />
<right name="function.setPlayerMuted" access="false" />
<right name="function.restartResource" access="false" />
...etc etc...
<right name="general.adminpanel" access="false" />
<right name="general.tab_players" access="false" />
<right name="general.tab_resources" access="false" />
...etc etc...
<right name="command.freeze" access="false" />
<right name="command.shout" access="false" />
<right name="command.spectate" access="false" />
...etc etc...
</acl>
</syntaxhighlight>
<br \>
*'''Function''' entries are MTA scripting functions. For example, if a resource needed to use restartResource and was only in the 'Everyone' group (with the 'Default' list), it would be denied access to restartResource and fail to work correctly.
*'''Commands''' are created when a resource uses [[addCommandHandler]]. An example would be typing '''/createvehicle [vehicle]''' in the chatbox for the freeroam resource. This controls whether users in the group using this ACL can use the command. ''Note: commands have no effect on resources within the group. Commands are only related to users.''
**''General is a custom right name group created by the admin resource but it works on the same principles. The script works with them by using [[hasObjectPermissionTo]]''

You will notice some groups such as admin have multiple '''<acl name="" />''' nodes. An example is the admin group:
<syntaxhighlight lang="xml">
<group name="Admin">
<acl name="Moderator" />
<acl name="SuperModerator" />
<acl name="Admin" />
<acl name="RPC" />
<object name="resource.admin" />
<object name="resource.webadmin" />
<object name="user.Random" />
</group>
</syntaxhighlight>

This gives all the permissions defined in each '''<acl name="" />''' node in order of listing. So for example, the admin group makes sure all the permissions are given to admins by using all the lists. If there are any conflicts, the lowest entry wins. For example, pretend these 2 acls were in a group in the following order:

'''1.''' '''<acl name="Default">''' sets <right name="general.ModifyOtherObjects" access="false" /> <br/>
'''2.''' '''<acl name="Admin">''' sets <right name="general.ModifyOtherObjects" access="true" /> <br/>
'''3.''' For all users and resources in group admin: <right name="general.ModifyOtherObjects" access="true" /><br/>
<br/>

=== Resource Groups and ACLs ===
You will notice there are some other groups that came with MTA. These were defined by resources that came with MTA. If a resource wants to designate specific ACL rights not provided by the default MTA groups, it can create its own ACL name and a group to use it. I will show AMX's entry as an example. AMX is designed to emulate SA-MP scripts and it needs a certain set of permissions that don't fit the default groups well. It is shown below:

<syntaxhighlight lang="xml">
<group name="AMX">
<acl name="AMX" />
<object name="resource.amx" />
</group>

<acl name="AMX">
<right name="general.ModifyOtherObjects" access="true" />
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="general.adminpanel" access="false" />
...etc etc...
<right name="command.kick" access="false" />
<right name="command.freeze" access="false" />
<right name="command.mute" access="false" />
...etc etc...
</acl>
</syntaxhighlight>

=== Grant resources access to other resources ===
To allow resource access to any other resource, you have to allow it explicitly in your ACL file. The rule <code>general.ModifyOtherObjects</code> grants full access to any resource on the server.
See the example in the last section of what it should look like.

{{New feature/item|3.0156|1.5.5|14166|
If you don't want to grant a resource complete access to every resource on the server, then you can append the modifiable resource's name preceded by a dot (.) to the <code>general.ModifyOtherObjects</code> rule:

<syntaxhighlight lang="xml">
<acl name="Custom">
<right name="general.ModifyOtherObjects.resourceName" access="true" />
<right name="general.ModifyOtherObjects.admin" access="true" />
<right name="general.ModifyOtherObjects.runcode" access="true" />
<right name="general.ModifyOtherObjects.mapmanager" access="true" />
</acl>
</syntaxhighlight>

The ACL definitions above will grant any resource with the ACL '''Custom''' access to the resources ''resourceName'', ''admin'', ''runcode'' and ''mapmanager''.
}}

==Modifying the ACL==
There are three ways you can modify the ACL - how you do it depends on who you are.

===HTTP Interface===
You can use the [[Resource/webadmin|webadmin]] HTTP interface to modify the ACL in your web browser. This is by far the easiest way to do so. Just make sure the ''webadmin'' resource is started on your server and visit ''<nowiki>http://ServerIP:HttpPort/</nowiki>''. You can then use the two sections - ACLs and Groups. ACLs allow you to create your Access Control Lists - lists of rights. Groups allow you to group together collections of users and assign ACLs to them. For example, the ACLs section allows you to specify that the Admin ACL has access to the ''start'' console command. You can go to the Groups section and create an Admin ''group'' that has access to your Admin ''acl''. You can then add users to your Admin ''group''.

===XML file===
You can modify the ACL.xml file manually. This has a fairly straightforward syntax, but it can get a bit confusing at times. If you do it while the server is running, don't forget to call the scripting function [[aclReload]] ("start runcode", "run aclReload()") so the new ACL is loaded, or otherwise stop your server before modifying. This also prevents your changes from being accidentally overwritten by the server.

===Scripting functions===
You can use a large number of ACL scripting functions to modify the ACL on the fly. Of course, you can (and really should!) limit access to the ACL functions with the ACL. Note that the '''admin resource''' that comes with MTA can be used to manage the ACL from the resources tab. You must be setup as admin to use the admin panel. [http://wiki.multitheftauto.com/wiki/Admin Click here for admin setup instructions].

==See Also==
{{ACL functions}}

[[hu:ACL]]
[[Category:Scripting Concepts]]
[[ru:Access Control List]]
[[Category:Tutorials]]

Resource Web Access

2020-04-19T19:47:45Z

Haxardous:

The Multi Theft Auto Server provides a web interface that resources can use in a variety of ways. This document's purpose is to explain what these ways are and how to go about using them.
{{Note|If you are looking for a tutorial on how to use the in-game web browser and create websites using CEF, please visit [[CEF_Tutorial|CEF Tutorial]] instead.}}

==Overview==
There are two key parts that make up this system. The first is a standard web server that allows web browsers to request pages and files you have in a resource. The second is a system for allowing web browsers to call functions you have exported from your resource.

==Pages==
===Specifying a file in the meta===
You can specify in your resource's meta file that certain files are accessible through the web server. To do this, you add a line:
<syntaxhighlight lang="xml">
<html src="filename.ext" />
</syntaxhighlight>
You can then access this file from your web browser by visiting: http://host:port/resourcename/filename.ext<br/>
For example, on a locally hosted server using default http port with webmap started: http://127.0.0.1:22005/webmap/map.htm

===Binary files===
Despite the misleading name, files specified using the html node can be of any type. If they are binary files (like images, zip files) then you need to specify this in the meta file, by adding ''raw="true"'' to the ''html'' node. This means that the files are not preprocessed before being sent to the web browser.

For example:
<syntaxhighlight lang="xml">
<html src="image.gif" raw="true" />
</syntaxhighlight>

===Parsed files===
If a file is not specified in the metafile as "raw", then it is passed through a pre-processor before it is returned to the client. This pre-processor works much like PHP or ASP but uses Lua. You can embed standard MTA scripts within HTML pages, controlling the output. Almost all standard MTA functions work, plus a number of special [[Template:HTTP functions|HTTP Functions]], such as [[httpWrite]], a function that outputs text to the buffer.

For example:
<syntaxhighlight lang="html4strict">
<html>
<body>
This resource is called <* httpWrite( getResourceName(getThisResource()) ) *>
</body>
<html>
</syntaxhighlight>

There is a shorthand (in common with PHP and ASP) for this code, meaning that you can also write the above code as:

<syntaxhighlight lang="html4strict">
<html>
<body>
This resource is called <* = getResourceName(getThisResource()) *>
</body>
<html>
</syntaxhighlight>

Aside from HTTP functions, embedded Lua has access to the following environment variables that contain information about how the page was requested:
* table '''requestHeaders''': This is a table containing all the headers that were requested with the page. You can set returned headers using [[httpSetResponseHeader]].
* table '''form''': This is a table containing all the form data submitted to the page using HTTP POST combined with any variables passed in the querystring with HTTP GET.
* table '''cookies''': This is a table of all the cookies. You can modify cookies using [[httpSetResponseCookie]].
* string '''hostname''': This is a string containing the IP address or hostname that requested the page.
* string '''url''': This is the URL of the page.
* account '''user''': This is the account of the current user.

It's important to note that parsed files are run in a separate virtual machine from the rest of your resource's code. As such, if you want to call a function in your resource's main code, you need to export the function and use the [[call]] function from your parsed file.

==Calls==
You can specify that certain exported functions in your resource are able to be called from the HTTP interface. All the SDKs (listed below) allow you to call these functions from a remote location.

To specify an exported http-accessible function, add the following to your meta.xml file:
<syntaxhighlight lang="xml">
<export function='functionName' http='true' />
</syntaxhighlight>

You can code your function just as you would any normal function, returning as many values as you want, including tables and resources and most important elements. You ''cannot'' however return other 'userdata' values such as [[xmlnode|xmlnodes]] or functions.

===Protocol===
{{Note|You don't need to know this unless you're writing your own HTTP request code. You can just use one of the [[#SDK|SDKs listed below]].}}

Calls are done by requesting ''<nowiki>http://<your IP>:<your port>/<resource_name>/call/<exported_function_name></nowiki>'' using HTTP POST. The body of the request should be a JSON array of the arguments for the function.

The request will return a JSON array of the value(s) returned from the function as the HTTP response.

The server supports HTTP Basic authentication and you can configure access via the ACL and the built-in accounts system.

===Calls from the HTTP web interface===
Using calls is probably easiest from the web interface and can be done almost seamlessly.

First, add this to your meta.xml file:
<syntaxhighlight lang="xml">
<include resource="ajax" />
</syntaxhighlight>

Secondly, add the following to the <head> section of the page you want to call from:
<syntaxhighlight lang="lua">
<* = exports.ajax:start(getResourceName(getThisResource())) *>
</syntaxhighlight>

Finally, you can create a javascript block on your page and call your functions almost as if they were local. The only difference is that the calls are asynchronous - you should specify a callback function as the last argument for your call. This is called when the function returns.

Here's a simple example.

'''meta.xml'''
<syntaxhighlight lang="xml">
<meta>
<include resource="ajax" />
<script src='code.lua' />
<html src='page.htm' default='true' />
<export function='showChatMessage' http='true' />
</meta>
</syntaxhighlight>

'''code.lua'''
<syntaxhighlight lang="lua">
function showChatMessage ( message )
outputChatBox ( message )
return 5;
end
</syntaxhighlight>

'''page.htm'''
<syntaxhighlight lang="html4strict">
<html>
<head>
<* = exports.ajax:start(getResourceName(getThisResource())) *>
<script type='text/javascript'>
function say() {
var message = document.getElementById('message')
showChatMessage ( message.value,
function ( number ) {
// the function has been called and returned something
message.value = "The function returned " + number;
}
);
}
</script>
</head>
<body>
<input type='text' id='message' /><input type='button' value='say' onclick='say();' />
</body>
</html>
</syntaxhighlight>

You can see (fairly complex) examples of how this can be done in the resources ''resourcebrowser'', ''resourcemanager'' and ''webadmin''.

==Securing the web interface==
The [[ACL]] has a number of rights that can affect what files can be accessed.
{{Deprecated feature|3.0139|1.3.1|
* general.http: If disabled, none of the HTTP files can be accessed (except by game clients)
** '''Important Note''': ''If 'general.http' is enabled, HTTP access to all resources (for that ACL) is enabled by default. To disable HTTP access you have to explicitly block access to resources that contain exported HTTP functions.''
** '''Important Note''': ''If 'general.http' is enabled on an ACL which has a user with no password (i.e. user.* or user.guest or user.http_guest), it is essential that you explicitly block access to resources that contain exported HTTP functions.''
* resource.'''ResourceName''': If disabled, none of the files in the resource can be accessed
* resource.'''ResourceName'''.file.'''FileName''': If disabled, the file named cannot be accessed
* resource.'''ResourceName'''.function.'''FunctionName''': If disabled, the function cannot be called
These work as with other ACL rights - you can disable them for normal users and just enable them for Admin users, or any other group of users you wish.
}}
{{New_feature|3.0139|1.3.1|
* '''resource.ResourceName.http''': If enabled, the resource will be accessible from http://server_ip:22005/ResourceName/
This works as with other ACL rights - You can enable it just for Admin users, or any other group of users you wish.
}}

==SDK==
There are a number of so-called 'SDKs' available that allow you to interface with the server from other programming languages. With these, you could (in theory) write whole gamemodes. In practice, this is probably a bad idea, but it is useful for statistics and administration. The PHP SDK is the most developed version. Feel free to modify or create your own SDKs - if you do please send us a copy.

* [[JavaSDK|Java SDK]]
* [[Javascript SDK]]
* [https://www.npmjs.com/package/mtasa Node.js SDK]
* [[Perl SDK]]
* [[PHP SDK]]
* [[CSharp SDK|C# SDK]]

==See Also==
[[callRemote]] - Allows game servers to call functions on PHP pages (with the PHP SDK) and on other game servers.
[[Category:Scripting Concepts]]

[[hu:Resource Web Access]]
[[ru:Resource Web Access]]

[[Category:Tutorials]]

Resources

2020-04-19T19:46:43Z

Haxardous:

Resources are a key part of MTA. A resource is essentially a folder or zip file that contains a collection of files - including script files, plus a ''meta'' file that describes how the resource should be loaded. A resource can be seen as being partly equivalent to a program running in an operating system - it can be started and stopped, and multiple resources can run at once. Its worth remembers though, that unlike programs on an operating system, there is no multi-tasking between resources.

==Terminology==
* '''Resource''' - A zip file or folder containing a meta.xml file and a number of resource items. These are placed in the ''mods/deathmatch/resources'' folder in the server directory.
* '''Resource item''' - A file contained within a resource, currently this can be a map, script, images, etc.

==The Meta File==
''See main article [[Meta.xml]] for details''

The Metafile is the core of each the resource. It describes exactly what files in the resource should be used, and how. The following is an example that covers every option there is, your metafiles can have as many or as few of these tags as you require:

<syntaxhighlight lang="xml">
<meta>
<info author="eAi" description="This is a basic CTF script" version="4"/>

<include resource="radarblips"/>
<include resource="markermanagement" />

<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />

<file src="model.dff" />
<file src="quitbutton.png" />
<file src="killed.png" />

<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />

<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>

<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />

<map src="somestuff.map" dimension="99" />
</meta>
</syntaxhighlight>
While a CTF map may have a meta.xml that looks like:
<syntaxhighlight lang="xml">
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />

<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
</syntaxhighlight>

Script/type, Config/type, and File/type attributes specify if the script/resource should be sent to clients or not, and defaults to "server".

The include tag specifies other resources that should be started before this resource is started. In other words, if your resource is dependent on another, you can include it so that the other resource is started first.

Each resource has its own virtual machine (VM). This contains every script in the resource. This means that variables are not shared with other resources. The best way to communicate with other resources is by using the ''export'' tag and exporting a function. This will enable other resources to fire this function using the [[call]] scripting function.

Scripts sent to clients are started as soon as all the scripts have been downloaded.

Scripts are able to read and write to their own resource folder with functions such as [[xmlCreateFile]] and [[fileCreate]]. They can also read and write to other resources but must have [[Access_Control_List|ACL]] access.

Each resource can only be loaded once, the server will ensure this. If a resource is included more than once, the same instance will be used by each resource that includes it.

==File storage==
Resource files can either be stored in a zip or a directory. This is located in:

server/mods/deathmatch/resources/ (if you've installed your server with the client)

or

mods/deathmatch/resources/ (for dedicated server installations)

Each resource can have a zip file, a directory or both. In the case of both existing, the directory has precedence over the zip file, as such files can be placed in the directory to over-ride the files in the zip file. This allows directories to be used for testing and developing of maps/scripts while zip files used by end-users.

==Other things to note==
*Resource names can't have dots in.
*If the resource does any file saving, the file names used should not be listed in the meta.xml
*Files listed in the meta.xml should be considered read-only by your scripts. Do not modify them with xmlSaveFile, FileSave etc.
*When making a zip file of your resource, do not include save files. If your resource uses to save files, they must be created by your resource when needed.
*When making a zip file of your resource, only include files that are listed in the meta.xml. Do not include 'example' save files, otherwise, bad things will happen.
*We recommend avoiding spaces and exotic characters from resource names.

==Script functions==
The resource system can be manipulated by script. As such, the following Serverside scripting functions are provided:
{{Resource functions}}

The following events are also provided:
{{Resource_events}}

[[hu:Resources]]
[[it:Introduzione alle Risorse]]
[[pt-br:Recursos]]
[[ru:Resources]]

Debugging

2020-04-19T19:45:49Z

Haxardous:

When scripting you will often come across problems that are not immediately apparent. This page tries to point out some basic strategies to locate the error.

==Debug console==
MTA features a built-in debug console that shows debug messages output from MTA functions or from scripts. Keeping it mind that you should have administrator access (unless you modify the ACL to change this), you can open the debug console by typing ''debugscript *x*'' in the console, where ''x'' is the debug level:
* '''0:''' close debug console
* '''1:''' only errors
* '''2:''' errors and warnings
* '''3:''' errors, warnings and info messages
By typing ''debugscript 3'' all messages are visible. Level 3 and level 2 are recommended for most occasions. You should have ''debugscript'' enabled whenever you are testing your scripts as it will help you easily detect and solve typos and other issues.

===Example===
This example code has two errors:
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Fedor")
outputChatbox("Hello Fedor")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>
When the script this piece of code is in is tried to be loaded, debugscript will output something similiar to this:
:{{Debug info|Loading script failed: myResource\script.lua:2: 'then' expected near ´outputChatbox'}}
This means the script could not be parsed because there was a syntax error. It shows the script path relative to the resource directory so you can identify to script where the error originated from. After the filename it shows a colon and a number, this number presents the line number - this is so you can find out where in your script the error is - it is very helpful for large scripts. After that is the error message, which varies depending on the error made. Looking at the error message, we can easily determine that the error originated from the resource '''myResource''' and line two of the script file '''script.lua'''. The error message is very clear, we forgot the "then"! We can easily fix that!
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Fedor") then
outputChatbox("Hello Fedor")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>
Now the script will load fine and won't output any errors until a player with the name 'Fedor' says something in the chat. At that moment, the debug console will output:
:{{Debug error|myResource\script.lua:2: attempt to call global 'outputChatbox' (a nil value)}}
This error means that the function '''outputChatbox''' is a nil value, that is - it doesn't exist! This is because the function is actually called [[outputChatBox]], not [[outputChatbox]] - take care of that capital B.:
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Fedor") then
outputChatBox("Hello Fedor")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>

Of course, this is just an example and I've only skimmed the surface of error messages. There are plenty of other messages and scenarios, but you should get a general idea.

==Server & client debug logging==
====Server====
Navigate to: ''(MTA root folder)>server>mods>deathmatch''

There are two nearly identical files:

*The local.conf is the settings for the "host game" menu item in the main menu of MTA. This is a quick and easy way of starting a temporary server from inside the client. When the client is turned off the server will also turn off.

*The mtaserver.conf is used when "MTA Server.exe" is executed from (MTA root folder)>server. This runs the server in its own console window which does not need the client to exist or to be run. This is can be useful if you're interested in hosting servers for a longer time period or if you want to experiment with a real-world console.

Depending on which way you host, you will want to edit those files. The settings in question are:

<syntaxhighlight lang="xml">
<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>


<scriptdebugloglevel>0</scriptdebugloglevel></syntaxhighlight>

You want to make sure you have a log name specified. Also, you want to specify what level of errors will be logged. If it is 0 nothing will be logged. The levels were explained at the top of this article. If the logging level was changed to 3, then, in this case, all '''serverside''' script errors log to (MTA root folder)>server>mods>deathmatch>logs>scripts.log

====Client====
Navigate to: ''(MTA root folder)>MTA>logs>clientscript.log''

This file logs all '''clientside''' script errors. This is set to log by default, no setup required.

==Debug strategies==
There are several strategies that support finding errors, apart from going through the code. Most of them include outputting debug messages, with have different information depending on the situation.

===Useful functions===
There are some functions that may come in handy for debugging.
* [[outputDebugString]] or [[outputChatBox]] for outputting any information (use outputDebugString for technical output)
* [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] on a variable to turn the value into a string. Useful if the value is not a number or string.
* [[inspect]] returns a useful human-readable string notation of any datatype including tables, non-element userdatas such as ACL groups, accounts, etc, and elements.
* [[iprint]] similar to inspect, except it takes in as many arguments as desired and outputs them into debugscript.
* [[getElementType]] to check the type of the MTA element.
* [[isElement]] to check if the MTA element exists.

===Add debugmessages to check ''if'', ''when'' or ''how often'' a section of code is executed===
A typical example would be verify whether an ''if''-section is executed or not. To do that, just add any message you will recognize later within the ''if''-section.
<syntaxhighlight lang="lua">
if (variable1 == variable2) then
outputDebugString("variable1 is the same as variable2!")
-- do anything
end
</syntaxhighlight>

Another application would be to check when variable values are modified. First search for all occurrences of the variable being edited and add a message just beside it.

===Add debugmessages to check the ''value'' of a variable===
Let's say you want to create a marker, but it doesn't appear at the position you expect it to be. The first thing you might want to do is check if the [[createMarker]] function is executed. But while doing this, you can also check the values being used in the [[createMarker]] function in one run.
<syntaxhighlight lang="lua">
outputChatBox("posX is: "..x.." posY is: "..y.." posZ is: "..z)
createMarker(x,y,z)
</syntaxhighlight>
This would output all three variables that are used as coordinates for the marker. Assuming you read those from a map file, you can now compare the debug output to the desired values. The [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] will ensure that the values of the variables can be concatenated (put together) as a string, even if it's a boolean value.

==Example==
Imagine you created a [[Colshape|collision shape]] somewhere and you want an action to perform after the player stays for ten seconds inside it, you would do this:
<syntaxhighlight lang="lua">
function colShapeHit(player)
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit", root, colShapeHit)

function colShapeLeave(player)
-- kill the timer when the player leaves the colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave", root, colShapeLeave)
</syntaxhighlight>
When a player enters the colshape, debugscript outputs the following message:
:{{Debug error|..[path]: attempt to index global 'colshapeTimer' (a nil value)}}
This means you tried to index a table that does not exist (because the table is a nil value, it doesn't exist). In the example above, this is done when storing the timer id in the table. We need to add a check if the table exists and if it does not exist we should create it.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit", root, colShapeHit)

function colShapeLeave(player)
-- kill the timer when the player leaves the colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",root,colShapeLeave)
</syntaxhighlight>

Now we will still receive a warning when a player enters the colshape, waits for the message and leaves it again:

:{{Debug warning|[..]: Bad argument @ 'killTimer' Line: ..}}

Except for that (we will talk about that later) everything seems to work fine. A player enters the colshape, the timer is started, if he stays the message occurs, if he leaves the timer is killed.

===A more inconspicuous error===
But for some reason, the message gets outputted twice when you stay in the colcircle while in a vehicle. Since it would appear some code is executed twice, we add debug messages to check this.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- add a debug message
outputDebugString("colShapeHit")
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- add a debug message
outputDebugString("colShapeLeave")
-- kill the timer when the player leaves the colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

Now we notice that both handler functions get executed twice when we are in a vehicle, but only once when we are on foot. It would appear the vehicle triggers the colshape as well. To confirm this theory, we ensure that the ''player'' variable actually holds a reference to a player element.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- add a debug message, with the element type
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- add a debug message, with the element type
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

The debug messages tell us that one of the ''player'' variables is a player and that the other one is a vehicle element. Since we only want to react when a player enters the colshape, we add an ''if'' that will end the execution of the function if it's '''not''' a player element.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- add a check for the element type
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- add a check for the element type
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

Now the script should work as desired, but it will still output the warning mentioned above. This happens because the timer we try to kill when a player leaves the colshape will not exist anymore when it has reached the 10 seconds (and therefore executed after the 10th second has completed). There are different ways to get rid of that warning (since you know that the timer might not exist anymore and you only want to kill it if it exists). One way would be to check if the timer referenced in the table really exists. To do this, we need to use [[isTimer]], which we will use when we kill the timer:
<syntaxhighlight lang="lua">
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
end
</syntaxhighlight>

So the complete working code would be:
<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- add a check for the element type
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- store the timer id in a table, using the player as index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- add a check for the element type
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

==Debugging Performance Issues==

If your server is using up more resources than it should or you just want to make sure your scripts are efficient, you can find the source of the issue by using a great tool that comes with the default resource package called [[Resource:Performancebrowser|performancebrowser]]. You can start it with ''''start performancebrowser''''. If it doesn't exist then you can get the latest resources from the [https://github.com/multitheftauto/mtasa-resources GitHub repository]. This tool provides an incredible amount of information for performance debugging. Memory leaks, element leaks, and CPU intensive scripts are all easily findable via performancebrowser. If you use the ''''d'''' option in Lua timing you can see which functions are using up the CPU.

To access performancebrowser you will need to go to your web browser and enter the address: http://serverIPHere:serverHTTPPortHere/performancebrowser/ Note that the / at the end is required. So for example: http://127.0.0.1:22005/performancebrowser/ You will then need to login with an in-game admin account or any account that has access to ''''resource.performancebrowser.http'''' and ''''resource.ajax.http''''. Most of the information you will need is in the categories Lua timing and Lua memory, look for values that are much higher than other values.

===Examples of scripts that could cause performance problems===

Adding data to a table but never removing it. This would take months/years before it causes a problem though.
<syntaxhighlight lang="lua">
local someData = {}

function storeData()
someData[source] = true
-- There is no handling for when a player quits, this is considered a memory leak
-- Using the Lua timing tab you can detect the RAM usage of each resource.
end
addEventHandler("onPlayerJoin", root, storeData)
</syntaxhighlight>

Element leaking is possible if you use temporary colshapes for whatever reason and may not destroy them. This would cause bandwidth, CPU and memory performance issues over time.
<syntaxhighlight lang="lua">
function useTemporaryCol()
local col = createColCircle(some code here)
if (normally this should happen) then
destroyElement(col)
end
-- But sometimes it didn't so the script ended but the collision area remained and overtime
-- you may end up with hundreds to thousands of pointless collision areas.
-- The Lua timing tab allows you to see the number of elements each script has created.
end
</syntaxhighlight>

High CPU usage resulting in the server FPS dropping so much that the server is unplayable. In under 24 hours, this can create havoc on a very busy server. The amount of "refs" in the Lua timing detect this type of build-up, surprisingly the Lua timing tab didn't help in this case but Lua memory did.
<syntaxhighlight lang="lua">
addEventHandler("onPlayerJoin", root, function()
-- Code for joiner
addEventHandler("onPlayerQuit", root, function()
-- Code for when they have quit
-- See the problem? It's bound to root which the event handler is being added again and again and again
end)
end)
</syntaxhighlight>

A function uses up a lot of your CPU because whatever it does takes a long time. This is just some function that takes a long time to complete. Without performancebrowser you'd have no idea its the cause but with performancebrowser you can see that a resource is using lots of CPU in the Lua timing tab. If you then enter: ''''d'''' into the options edit box it will even tell you what file name and the first line of the function that is using up so much CPU.
<syntaxhighlight lang="lua">
function someDodgyCode()
for i=1, 100000 do
-- some code
end
end
</syntaxhighlight>

[[hu:Debugging]]
[[it:Guida al Debug]]
[[Category:Scripting Concepts]]
[[ru:Debugging]]
[[zh-cn:脚本调试教程]]
[[Category:Tutorials]]

CEF Tutorial

2020-04-19T19:44:00Z

Haxardous:

This page gives you a brief introduction to CEF.

=What is CEF?=
CEF stands for '''C'''hromium '''E'''mbedded '''F'''ramework and is a framework for embedding Chromium-based browsers in other applications - in our case MTA. CEF is based on Google's Chromium project so it is also a fast, secure and stable web engine.

You can find more information about CEF on CEF's GoogleCode project page: https://bitbucket.org/chromiumembedded/cef

=The basics=
Creating a new browser is really simple. Let's open YouTube for example:
<syntaxhighlight lang="lua">
-- Create a new remote browser (size is 800*600px) with transparency enabled
local browser = createBrowser(800, 600, true, true)

-- "Wait" for the browser (this is necessary because CEF runs in a secondary thread and hence requires the 'asynchronous' event mechanism)
addEventHandler("onClientBrowserCreated", browser,
function()
-- We're ready to load the URL now (the source of this event is the browser that has been created)
loadBrowserURL(source, "https://youtube.com/")
end
)</syntaxhighlight>
This example does not require any domain requests as YouTube is whitelisted by default. More about domain requests below.

=Domain request system=
In order to prevent people from abusing the possibilities CEF offers, we decided to introduce a request system.
This means the domain you want to load has to meet at least one of the following requirements:
*it is whitelisted globally by the MTA team (you can create a post in [this topic] to suggest a new domain to be whitelisted) - '''**TODO: Add forum URL here**'''
*the domain was requested via requestBrowserDomains/Browser.requestDomains and accepted by the player '''before'''
*the domain is on the user's whitelist (MTA settings => Tab: Browser => Whitelist)

Apart from these options, a domain might be blacklisted due to malicious content. Such domains cannot be requested.

=Local vs remote mode=
There are two modes CEF can run in:

Characteristics of local mode:
*you '''can''' execute Javascript code without any restriction (See: [[executeBrowserJavascript]])
*you '''can''' only load websites stored in the resource folder
*you '''cannot''' load remote content

Characteristics of remote mode:
*you '''cannot''' execute Javascript code
*you '''can''' only load remote content
*keep in mind that either loading remote websites or Javascript on remote websites can be disabled in the MTA settings

Changing the mode after the browser was created is not possible due to technical reasons.

=Resource management=
==How to load local HTML files==
Loading local HTML files works similar to loading images.

Add your HTML files to your meta.xml through the file tag:
<syntaxhighlight lang="xml">
<file src="html/myAwesomeUI.html"/></syntaxhighlight>

==How to load local resources in local HTML files==
Imagine you want to load an image or play a video from your MTA resource. This is possible via a custom URI scheme named '''''mtalocal://'''''

===Example===
This examples shows how to play a video. Note that you have to enable OOP.
====Lua====
<syntaxhighlight lang="lua">
-- Create a browser (local mode is also required to access local data)
local webView = Browser(640, 480, true, true)

addEventHandler("onClientBrowserCreated", webView,
function()

-- Load HTML UI
webView:loadURL("http://mta/local/html/myVideo.html")

end
)</syntaxhighlight>
====meta.xml====
<syntaxhighlight lang="lua">
<file src="html/myVideo.html"/>
<file src="media/myVideo.webm"/></syntaxhighlight>
====HTML====
This is the most interesting part:
<syntaxhighlight lang="html">
<!DOCTYPE HTML>
<html>
<head></head>
<body>
<video width="640" height="480" controls>
<source src="http://mta/local/myVideo.webm" type="video/webm"/>
</video>
</body>
</html></syntaxhighlight>

=Lua <==> Javascript communication=
First of all, communication between Lua and Javascript is only available in local mode due to security reasons.

==Lua to Javascript==
Lua to javascript is pretty easy as you can execute Javascript code from Lua using [[executeBrowserJavascript]].

So, a bit Lua code around it and you have got the first direction:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/WebWindow.lua#L180-189
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/mtaevents.js#L9-L15

==Javascript to Lua==
You are able to trigger a client event via the Javascript method ''triggerEvent'' which is part of the static class/namespace ''mta''.
The syntax is as follows:
<syntaxhighlight lang="javascript">
mta.triggerEvent(string event, var parameter1, var parameter2, var parameter3, ...)
</syntaxhighlight>
The source of this event is always the browser element that triggered the event.

An example is available here:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/html/ui2.html#L66
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/Main.lua#L35-L40

=Debugging=
The ''web development mode'' can be enabled as follows (type it in the client's F8 console):
<syntaxhighlight lang="lua">start runcode
crun setDevelopmentMode(true, true)
debugscript 3</syntaxhighlight>
Now, you should be able to see web errors and blocked domains/URLs in the debug window at the bottom.

=Things you should keep in mind while working with CEF=
You should always keep in mind that some modern browser features are not available on some computers.
This is for example true for '''WebGL'''.

Another problematic feature is '''Adobe Flash'''. Adobe Flash is enabled by default, but you should avoid using it due to the fact that plugins can be disabled in the settings on the one hand (Java is disabled completely by the way) and Flash is very restrictive on the other hand. Restrictive means it runs in a separate process uses a very old interface and offers therefore just a few ways to control it.
As a consequence, you cannot control the volume of flash objects. Fortunately, HTML5 is an even better replacement and provides very good audio and video interface (http://www.w3schools.com/tags/ref_av_dom.asp) which even supports 3D sound (@all bored people among us: Feel free to write a 3D sound 'wrapper' that maps the GTA onto HTML5 coordinates :P).

=Advanced usage=
Since our CEF implementation does not do z-ordering by default, you have to provide your own z-ordering mechanism.
You can find a basic implementation of such a mechanism here: https://github.com/Jusonex/mtasa_cef_tools
There are also a few utility functions that allow you to integrate these classes easily into your own object-oriented UI system.
I'll provide some code to use CEF along with CEGUI soon too.

=Performance=
Creating lots of browsers does not influence MTA directly (except the fact MTA has to copy the texture data in the main/GTA thread due to technical restrictions), because one part of CEF runs in another process and the other part in a secondary thread.
So if you do not want to show the browser, it is definitely the best to destroy the browser. If you cannot destroy the browser (imagine you have to save the website's state for some reason), you can save a lot of resources by disabling rendering via [[setBrowserRenderingPaused]]. This will stop CEF from rendering new frames/processing input and MTA from copying the texture data.

=Troubleshooting=
===google.com doesn't work (even though I requested google.com)===
Google redirects to a country-specific website by default. If you want to prevent Google from doing this, load the following URL: https://www.google.com/ncr

=Scripting functions=
{{CEF_functions}}
=Scripting events=
{{CEF_events}}

[[Category:Tutorials]]

GetServerConfigSetting

2020-04-15T12:56:33Z

Haxardous: /* Required Arguments */

__NOTOC__
{{Server function}}
This function retrieves server settings which are usually stored in the '''mtaserver.conf''' file.

{{New feature|3.0110|1.1|
Available in 1.1 and onwards
}}

==Syntax==
<syntaxhighlight lang="lua">
string getServerConfigSetting ( string name )
</syntaxhighlight>

===Required Arguments===
*'''name :''' The name of the setting (setting names can be found [[Server_mtaserver.conf|here]])

===Returns===
Returns a string containing the current value for the named setting, or ''false'' if the setting does not exist.

==Example==
This example prints the server minimum allowed client version to the chatbox
<syntaxhighlight lang="lua">
outputChatBox( getServerConfigSetting ("minclientversion") )
</syntaxhighlight>

==See Also==
{{Utility functions}}

SetFPSLimit

2020-04-15T12:54:03Z

Haxardous:

{{Server client function}}
__NOTOC__
This function sets the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.
{{Note|When set client side, the actual limit used is the lowest of both the server and client set values}}
==Syntax==
<syntaxhighlight lang="lua">
bool setFPSLimit ( int fpsLimit )
</syntaxhighlight>

===Required Arguments===
*'''fpsLimit:''' An integer value representing the maximum FPS. This value may be between '''25''' and '''100''' FPS. You can also pass '''0''' or ''false'', in which case the FPS limit will be the one set in the client settings (by default, 100 FPS and the client fps limit should also be manually changed via "fps_limit=0" in console or '''MTA San Andreas 1.5\MTA\config\coreconfig.xml''').

===Returns===
Returns ''true'' if successful, or ''false'' if it was not possible to set the limit or an invalid value was passed.

==Issues when increasing FPS==
It is also recommended to set a conservative FPS limit (between 30-60 and 74 highest) because high FPS can break some GTA internal calculations. The higher the FPS the more of a problem these become:
* Impossibility to move sideways while aiming certain weapons.
* Speed of vehicles is effected, racers with a higher FPS will have an unfair advantage.
* Pressing the horn button to turn on and off sirens gets really hard the higher the FPS.
* Climbing over certain objects will result in instant death. Example at: 2520.108, -1681.407, 19.406, 266
* Animations can randomly get messed up.
* There were more issues like not being able to take off in Skimmer which MTA developers have fixed.
* Satchels can be thrown ~10% less distance.

==Example==
This command sets the fps limit in a command handler.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function fpsFunction( player, command, limit ) -- First define the function
if hasObjectPermissionTo ( player, "function.setFPSLimit" ) and limit then
-- If the player has permission to set FPS limit and limit is submitted...
setFPSLimit ( limit ) -- Set the fps.
end
end

addCommandHandler ( "setfps", fpsFunction ) -- Attach the setfps command to fpsFunction function.
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

[[pl:setFPSLimit]]
[[ru:setFPSLimit]]

SetFPSLimit

2020-04-15T12:53:37Z

Haxardous: /* Required Arguments */

{{Server client function}}
__NOTOC__
This function sets the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.
{{Note|When set client side, the actual limit used is the lowest of both the server and client set values}}
==Syntax==
<syntaxhighlight lang="lua">
bool setFPSLimit ( int fpsLimit )
</syntaxhighlight>

===Required Arguments===
*'''fpsLimit:''' An integer value representing the maximum FPS. This value may be between '''25''' and '''100''' FPS. You can also pass '''0''' or ''false'', in which case the FPS limit will be the one set in the client settings (by default, 100 FPS and the client fps limit should also be manually changed via "fps_limit=0" in console or '''MTA San Andreas 1.5\MTA\config\coreconfig.xml''').

===Returns===
Returns ''true'' if successful, or ''false'' if it was not possible to set the limit or an invalid value was passed.

==Issues when increasing FPS==
It is also recommended to set a conservative FPS limit (between 30-60 and 74 highest), because high FPS can break some GTA internal calculations. The higher the FPS the more of a problem these become:
* Impossibility to move sideways while aiming certain weapons.
* Speed of vehicles is effected, racers with a higher FPS will have an unfair advantage.
* Pressing the horn button to turn on and off sirens gets really hard the higher the FPS.
* Climbing over certain objects will result in instant death. Example at: 2520.108, -1681.407, 19.406, 266
* Animations can randomly get messed up.
* There were more issues like not being able to take off in Skimmer which MTA developers have fixed.
* Satchels can be thrown ~10% less distance.

==Example==
This command sets the fps limit in a command handler.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function fpsFunction( player, command, limit ) -- First define the function
if hasObjectPermissionTo ( player, "function.setFPSLimit" ) and limit then
-- If the player has permission to set FPS limit and limit is submitted...
setFPSLimit ( limit ) -- Set the fps.
end
end

addCommandHandler ( "setfps", fpsFunction ) -- Attach the setfps command to fpsFunction function.
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

[[pl:setFPSLimit]]
[[ru:setFPSLimit]]

SetFPSLimit

2020-04-15T12:52:59Z

Haxardous: /* Required Arguments */

{{Server client function}}
__NOTOC__
This function sets the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.
{{Note|When set client side, the actual limit used is the lowest of both the server and client set values}}
==Syntax==
<syntaxhighlight lang="lua">
bool setFPSLimit ( int fpsLimit )
</syntaxhighlight>

===Required Arguments===
*'''fpsLimit:''' An integer value representing the maximum FPS. This value may be between '''25''' and '''100''' FPS. You can also pass '''0''' or ''false'', in which case the FPS limit will be the one set in the client settings (by default, 100 FPS and the client fps limit should also manually be changed via "fps_limit=0" in console or '''MTA San Andreas 1.5\MTA\config\coreconfig.xml''').

===Returns===
Returns ''true'' if successful, or ''false'' if it was not possible to set the limit or an invalid value was passed.

==Issues when increasing FPS==
It is also recommended to set a conservative FPS limit (between 30-60 and 74 highest), because high FPS can break some GTA internal calculations. The higher the FPS the more of a problem these become:
* Impossibility to move sideways while aiming certain weapons.
* Speed of vehicles is effected, racers with a higher FPS will have an unfair advantage.
* Pressing the horn button to turn on and off sirens gets really hard the higher the FPS.
* Climbing over certain objects will result in instant death. Example at: 2520.108, -1681.407, 19.406, 266
* Animations can randomly get messed up.
* There were more issues like not being able to take off in Skimmer which MTA developers have fixed.
* Satchels can be thrown ~10% less distance.

==Example==
This command sets the fps limit in a command handler.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function fpsFunction( player, command, limit ) -- First define the function
if hasObjectPermissionTo ( player, "function.setFPSLimit" ) and limit then
-- If the player has permission to set FPS limit and limit is submitted...
setFPSLimit ( limit ) -- Set the fps.
end
end

addCommandHandler ( "setfps", fpsFunction ) -- Attach the setfps command to fpsFunction function.
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

[[pl:setFPSLimit]]
[[ru:setFPSLimit]]

SetFPSLimit

2020-04-15T12:50:49Z

Haxardous: /* Issues when increasing FPS */

{{Server client function}}
__NOTOC__
This function sets the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.
{{Note|When set client side, the actual limit used is the lowest of both the server and client set values}}
==Syntax==
<syntaxhighlight lang="lua">
bool setFPSLimit ( int fpsLimit )
</syntaxhighlight>

===Required Arguments===
*'''fpsLimit:''' An integer value representing the maximum FPS. This value may be between '''25''' and '''100''' FPS. You can also pass '''0''' or ''false'', in which case the FPS limit will be the one set in the client settings (by default, 100 FPS).

===Returns===
Returns ''true'' if successful, or ''false'' if it was not possible to set the limit or an invalid value was passed.

==Issues when increasing FPS==
It is also recommended to set a conservative FPS limit (between 30-60 and 74 highest), because high FPS can break some GTA internal calculations. The higher the FPS the more of a problem these become:
* Impossibility to move sideways while aiming certain weapons.
* Speed of vehicles is effected, racers with a higher FPS will have an unfair advantage.
* Pressing the horn button to turn on and off sirens gets really hard the higher the FPS.
* Climbing over certain objects will result in instant death. Example at: 2520.108, -1681.407, 19.406, 266
* Animations can randomly get messed up.
* There were more issues like not being able to take off in Skimmer which MTA developers have fixed.
* Satchels can be thrown ~10% less distance.

==Example==
This command sets the fps limit in a command handler.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function fpsFunction( player, command, limit ) -- First define the function
if hasObjectPermissionTo ( player, "function.setFPSLimit" ) and limit then
-- If the player has permission to set FPS limit and limit is submitted...
setFPSLimit ( limit ) -- Set the fps.
end
end

addCommandHandler ( "setfps", fpsFunction ) -- Attach the setfps command to fpsFunction function.
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

[[pl:setFPSLimit]]
[[ru:setFPSLimit]]

Control names

2020-04-11T23:32:04Z

Haxardous: /* GTA control list */

This page lists all the control names. These can be used as key arguments by the console commands ''bind'' and ''unbind'' as well as scripting functions such as [[bindKey]], [[unbindKey]], [[toggleControl]] etc.

Lua table of all the valid control names listed on this page:
<syntaxhighlight lang="lua">controlTable = { "fire", "aim_weapon", "next_weapon", "previous_weapon", "forwards", "backwards", "left", "right", "zoom_in", "zoom_out",
"change_camera", "jump", "sprint", "look_behind", "crouch", "action", "walk", "conversation_yes", "conversation_no",
"group_control_forwards", "group_control_back", "enter_exit", "vehicle_fire", "vehicle_secondary_fire", "vehicle_left", "vehicle_right",
"steer_forward", "steer_back", "accelerate", "brake_reverse", "radio_next", "radio_previous", "radio_user_track_skip", "horn", "sub_mission",
"handbrake", "vehicle_look_left", "vehicle_look_right", "vehicle_look_behind", "vehicle_mouse_look", "special_control_left", "special_control_right",
"special_control_down", "special_control_up" }</syntaxhighlight>

==GTA control list==
<div style="border:3px solid green;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">ON FOOT</div>
* '''fire''' Fire a player's weapon ('''Note''': If you want to disable weapons fire, remember to also disable the control '''action''' in addition to the control '''fire'''.)
* '''aim_weapon''' Aim the player's current weapon (if possible) (this also affects right-click + F punching)
* '''next_weapon''' Switch to the next weapon
* '''previous_weapon''' Switch to the previous weapon
* '''forwards''' Move forwards
* '''backwards''' Move backwards
* '''left''' Move left
* '''right''' Move right
* '''zoom_in''' Zoom targeted weapon in (sniper/rocket launcher/camera etc)
* '''zoom_out''' Zoom targeted weapon out
* '''change_camera''' Change camera mode
* '''jump''' Make the player jump
* '''sprint''' Make the player sprint
* '''look_behind''' Make the player look behind (and allow the player to see behind them)
* '''crouch''' Make the player crouch/duck
* '''action''' Show the stats menu - Fire with tab key.
* '''walk''' Make the player move slowly/quietly
* '''conversation_yes''' Answer yes to a question
* '''conversation_no''' Answer no to a question
* '''group_control_forwards''' Make the group you are controlling move forwards
* '''group_control_back''' Make the group you are controlling move backwards
* '''enter_exit''' Make the player enter a vehicle. Also used for alternative fighting styles.
</div>
<div style="border:3px solid red;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">IN VEHICLE</div>
* '''vehicle_fire''' Fire the player's vehicle's primary weapon (e.g. hunter's missiles) or shoot with driveby
* '''vehicle_secondary_fire''' Fire the player's vehicle's secondary weapon (e.g. hunter's minigun)
* '''vehicle_left''' Make the player's vehicle turn left
* '''vehicle_right''' Make the player's vehicle turn right
* '''steer_forward''' Make the player's vehicle turn down (lean forwards for helicopters/planes)
* '''steer_back''' Make the player's vehicle turn up (lean backwards for helicopters/planes)
* '''accelerate''' Make the player's vehicle accelerate
* '''brake_reverse''' Make the player's vehicle brake (slow down) and if stationary reverse
* '''radio_next''' Change to the next radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_previous''' Change to the previous radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_user_track_skip''' Skip the current track being played on the custom radio station
* '''horn''' Play the horn of the player's vehicle (if the vehicle has a horn) and can trigger the siren on emergency vehicles
* '''sub_mission''' Start a submission if one is avaliable (e.g. taxi missions)
* '''handbrake''' Apply the handbrake on the player's vehicle
* '''vehicle_look_left''' Look to the left
* '''vehicle_look_right''' Look to the right
* '''vehicle_look_behind''' Look behind
* '''vehicle_mouse_look'''
* '''special_control_left''' Move the some special vehicle component left (e.g. tank's turret)
* '''special_control_right''' Move the some special vehicle component right (e.g. tank's turret)
* '''special_control_down''' Move the some special vehicle component down (e.g. tank's turret)
* '''special_control_up''' Move the some special vehicle component up (e.g. tank's turret)
* '''enter_exit''' Make the player exit a vehicle
</div>

==MTA hard-coded commands==
The following are names of hard-coded MTA commands which do not use bindKey, but can act as bindKey by using them in an [[addCommandHandler]]. Other than that, this control list will '''only''' work with the functions [[toggleControl]] and [[toggleAllControls]]. Please note that [[toggleControl]] can't disable screenshot.

<div style="border:3px solid blue;margin-bottom:3px;"><div
style="float:right;padding-right:5px;font-weight:bold;">MTA COMMANDS</div>
* '''enter_passenger''' Enters the closest vehicle as passenger
* '''screenshot''' Takes a screenshot
* '''chatbox''' Opens the chatbox for input
* '''radar''' Toggles the radar-map showing
* '''radar_zoom_in''' Zooms in on the radar-map
* '''radar_zoom_out''' Zooms out on the radar-map
* '''radar_move_north''' Moves north on the radar-map
* '''radar_move_south''' Moves south on the radar-map
* '''radar_move_east''' Moves east on the radar-map
* '''radar_move_west''' Moves west on the radar-map
* '''radar_attach''' Attaches the view to the local-player on the radar-map
</div>
[[Category:Scripting Concepts]]

Control names

2020-04-11T23:31:41Z

Haxardous: /* GTA control list */

This page lists all the control names. These can be used as key arguments by the console commands ''bind'' and ''unbind'' as well as scripting functions such as [[bindKey]], [[unbindKey]], [[toggleControl]] etc.

Lua table of all the valid control names listed on this page:
<syntaxhighlight lang="lua">controlTable = { "fire", "aim_weapon", "next_weapon", "previous_weapon", "forwards", "backwards", "left", "right", "zoom_in", "zoom_out",
"change_camera", "jump", "sprint", "look_behind", "crouch", "action", "walk", "conversation_yes", "conversation_no",
"group_control_forwards", "group_control_back", "enter_exit", "vehicle_fire", "vehicle_secondary_fire", "vehicle_left", "vehicle_right",
"steer_forward", "steer_back", "accelerate", "brake_reverse", "radio_next", "radio_previous", "radio_user_track_skip", "horn", "sub_mission",
"handbrake", "vehicle_look_left", "vehicle_look_right", "vehicle_look_behind", "vehicle_mouse_look", "special_control_left", "special_control_right",
"special_control_down", "special_control_up" }</syntaxhighlight>

==GTA control list==
<div style="border:3px solid green;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">ON FOOT</div>
* '''fire''' Fire a player's weapon (Note: If you want to disable weapons fire, remember to also disable the control action in addition to the control fire.)
* '''aim_weapon''' Aim the player's current weapon (if possible) (this also affects right-click + F punching)
* '''next_weapon''' Switch to the next weapon
* '''previous_weapon''' Switch to the previous weapon
* '''forwards''' Move forwards
* '''backwards''' Move backwards
* '''left''' Move left
* '''right''' Move right
* '''zoom_in''' Zoom targeted weapon in (sniper/rocket launcher/camera etc)
* '''zoom_out''' Zoom targeted weapon out
* '''change_camera''' Change camera mode
* '''jump''' Make the player jump
* '''sprint''' Make the player sprint
* '''look_behind''' Make the player look behind (and allow the player to see behind them)
* '''crouch''' Make the player crouch/duck
* '''action''' Show the stats menu - Fire with tab key.
* '''walk''' Make the player move slowly/quietly
* '''conversation_yes''' Answer yes to a question
* '''conversation_no''' Answer no to a question
* '''group_control_forwards''' Make the group you are controlling move forwards
* '''group_control_back''' Make the group you are controlling move backwards
* '''enter_exit''' Make the player enter a vehicle. Also used for alternative fighting styles.
</div>
<div style="border:3px solid red;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">IN VEHICLE</div>
* '''vehicle_fire''' Fire the player's vehicle's primary weapon (e.g. hunter's missiles) or shoot with driveby
* '''vehicle_secondary_fire''' Fire the player's vehicle's secondary weapon (e.g. hunter's minigun)
* '''vehicle_left''' Make the player's vehicle turn left
* '''vehicle_right''' Make the player's vehicle turn right
* '''steer_forward''' Make the player's vehicle turn down (lean forwards for helicopters/planes)
* '''steer_back''' Make the player's vehicle turn up (lean backwards for helicopters/planes)
* '''accelerate''' Make the player's vehicle accelerate
* '''brake_reverse''' Make the player's vehicle brake (slow down) and if stationary reverse
* '''radio_next''' Change to the next radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_previous''' Change to the previous radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_user_track_skip''' Skip the current track being played on the custom radio station
* '''horn''' Play the horn of the player's vehicle (if the vehicle has a horn) and can trigger the siren on emergency vehicles
* '''sub_mission''' Start a submission if one is avaliable (e.g. taxi missions)
* '''handbrake''' Apply the handbrake on the player's vehicle
* '''vehicle_look_left''' Look to the left
* '''vehicle_look_right''' Look to the right
* '''vehicle_look_behind''' Look behind
* '''vehicle_mouse_look'''
* '''special_control_left''' Move the some special vehicle component left (e.g. tank's turret)
* '''special_control_right''' Move the some special vehicle component right (e.g. tank's turret)
* '''special_control_down''' Move the some special vehicle component down (e.g. tank's turret)
* '''special_control_up''' Move the some special vehicle component up (e.g. tank's turret)
* '''enter_exit''' Make the player exit a vehicle
</div>

==MTA hard-coded commands==
The following are names of hard-coded MTA commands which do not use bindKey, but can act as bindKey by using them in an [[addCommandHandler]]. Other than that, this control list will '''only''' work with the functions [[toggleControl]] and [[toggleAllControls]]. Please note that [[toggleControl]] can't disable screenshot.

<div style="border:3px solid blue;margin-bottom:3px;"><div
style="float:right;padding-right:5px;font-weight:bold;">MTA COMMANDS</div>
* '''enter_passenger''' Enters the closest vehicle as passenger
* '''screenshot''' Takes a screenshot
* '''chatbox''' Opens the chatbox for input
* '''radar''' Toggles the radar-map showing
* '''radar_zoom_in''' Zooms in on the radar-map
* '''radar_zoom_out''' Zooms out on the radar-map
* '''radar_move_north''' Moves north on the radar-map
* '''radar_move_south''' Moves south on the radar-map
* '''radar_move_east''' Moves east on the radar-map
* '''radar_move_west''' Moves west on the radar-map
* '''radar_attach''' Attaches the view to the local-player on the radar-map
</div>
[[Category:Scripting Concepts]]

Multi Theft Auto: Wiki:About

2020-04-10T23:15:51Z

Haxardous:

'''Multi Theft Auto''' ''(MTA)'' is a multiplayer modification for the Microsoft Windows version of Rockstar North games Grand Theft Auto III, Grand Theft Auto: Vice City and Grand Theft Auto: San Andreas that adds online multiplayer functionality, find out more at [https://en.wikipedia.org/wiki/Multi_Theft_Auto wikipedia.org]

MTA Classes

2020-04-10T23:13:55Z

Haxardous:

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

Element tree

2020-04-10T23:13:29Z

Haxardous:

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

==Pratical 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 ( getRootElement(), 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]]

Client Manual

2020-04-10T23:02:45Z

Haxardous: /* Notes */

==Before you start==
Before you install Multi Theft Auto: San Andreas, first make sure that there are no modifications to GTA:SA installed. These will conflict with MTA. If you would like to keep your single-player mods, you can create two installations by reinstalling San Andreas to a second folder on your hard drive.

Also, make sure that your machine is capable of running the game in single player. Note that if you are running single player on the absolute minimum requirements, you will experience slowdowns in MTA as it takes up extra processing power.
{{Note|
* MTA:SA will only work on GTA:SA '''v1.0'''. If you bought the game recently, it is likely that you have a later version.''' [[Known_Issues_-_FAQ#Does_MTASA_work_with_v1.01_or_v2.00_of_GTA_San_Andreas.3F| (More info)]]
* If you have a Steam copy of GTA: San Andreas you should [[Known_Issues_-_FAQ#I_have_the_Steam_version_of_GTA_San_Andreas._How_can_I_play_MTASA.3F|read this first]].
}}

===System requirements===
====Minimum system requirements====
The minimum system requirements for Multi Theft Auto: San Andreas are '''slightly higher''' than the original minimum requirements for Grand Theft Auto: San Andreas:
* Windows 7 or newer (Microsoft supported) operating system ([[Compatibility FAQ|XP and Vista work, but they are obsolete and their support is being phased out]])
* Intel Pentium 4 or AMD Athlon XP
* 1GB DDR RAM
* Clean installation of Grand Theft Auto: San Andreas, version 1.0 (American or European)
* 3.7GB of free hard disk space (3.6GB for a minimum Grand Theft Auto installation; remember that MTA caches files from the servers that you play on and require disk space)
* Nvidia GeForce 4 series or ATI Radeon 8xxx series (64MB VRAM and DirectX 9.0 compatible)
* DirectX 9.0 compatible sound card
* Keyboard and mouse
* Internet access

====Recommended system requirements====
* Windows 7 or newer 64-bits (Microsoft supported) operating system
* Intel Core 2 Duo Processor or AMD equivalent
* 2GB DDR RAM
* Clean installation of Grand Theft Auto: San Andreas, version 1.0 (American or European)
* >5GB of free hard disk space (Remember that MTA caches files from the servers that you play on and require disk space)
* Nvidia GeForce FX series or higher, ATI Radeon 9xxx series or higher, Pixel Shader 2.0 compatible
* DirectX 9.0 compatible sound card
* Keyboard and mouse
* Broadband internet access (for smooth online play)

====Notes====
* The minimum system requirements are considered the bare minimum for MTA: San Andreas, the performance can depend on the game modes that are running and the player count.
* For extra loading performance, more RAM is recommended.
* Make sure Windows is fully up to date.
* Make sure you head over to the [[Known_Issues_-_FAQ|Known Issues]] page if you have issues, or join us on IRC @ irc://irc.multitheftauto.com/mta or [https://mtasa.com/discord MTA discord] and do so in the #help-support channel.

==Installing the game==
# If you haven't already, download the MTA:SA client from the download page at [http://mtasa.com mtasa.com].
# Run the installer, for Windows Vista and 7 it is required to run this with administrator rights. (The installer will ask.)
# You need to accept the license that comes with MTA:SA (GPLv3).
# You will be asked which components to install:
#* '''Game Client''' interfaces with the game and is a required component.
#* '''Dedicated Server''' enables you to host your own home-brew server.
#** '''Core components''' and '''Game module''' are required components for the dedicated server.
#** '''Core resources''' required resources for dedicated server.
#** '''Optional resources''' additional resources for your dedicated server, gamemodes and maps.
#** '''Editor''' is used to create new maps, this is an optional component.
#* '''Development''' development tools.
#** '''Module SDK''' development SDK for creating your own MTA server modules, this component requires C++ knowledge.
#* '''Start menu group''' creates a start menu group for the installed components.
#* '''Desktop icon''' creates a desktop icon for the client.
# You are then asked for a folder in which to install the mod. This can by anywhere and doesn't have to be in you San Andreas directory.
# Next, you will be asked for the directory where you have San Andreas installed. The default location is: '''C:\Program Files\Rockstar Games\GTA San Andreas\'''.
# When the installation completes, you will be given the option to start MTA: San Andreas straight away. Choose your option and then press '''Finish'''.
# You will be able to launch ''MTA San Andreas'' from your Start Menu if you wish to play.

==Running the game==
# Start Multi Theft Auto by clicking the icon located in your Start Menu under '''MTA:San Andreas'''.
# GTA: San Andreas will start and once it is loaded, you will be presented with the MTA:SA main menu. Here you will find several options (you could also watch a how-to tutorial [http://www.youtube.com/watch?v=ShiqnOazNYw here]):

{| border="0" align="center"

| width="188" |
[[Image:Server_Browser.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Browse servers''' – this allows you to receive a list of available servers to play on. </font>

<br />
|-
| width="188" |
[[Image:Host_Game.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Host game''' – this allows you to start a local server. </font>

<br />
|-
| width="188" |
[[Image:Menu_Settings.JPG|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Settings '''– this allows you to change your in-game nickname, customize controls and adjust display settings.</font>

<br /><br />
|-
| width="188" |
[[Image:About_Menu.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''About '''– this gives you a list of contributors to the project.</font>

<br />
|-
| width="188" |
[[Image:Map_Editor.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Map editor '''– this allows you to create your own maps, complete with checkpoints, ramps, pickups and other objects. These can then be uploaded onto a server so that you can play them with other people.</font>

<br /><br />
|-
| width="188" |
<br>
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Quit '''– this returns you back to your Windows desktop.</font>

<br /><br />
|}

The easiest way to play the game is to click '''Browse Servers''' on the menu. If servers have not appeared already, press the '''Refresh''' button and MTA will scan for servers, displaying them as a list.

* Under the '''Name''' tab, each server's name is displayed.
* Under the '''Players''' tab, the number of players and the maximum capacity of the server is displayed, in the format of [Used Slots] / [Maximum Slots].
* The '''Ping''' tab displays the ping, or latency, between your machine and the server. Ping is a measure of the time it takes for "packets" of data to be received back from the server after sending them, so a higher ping means that you will experience more lag on that particular server. Generally, servers closest to your location should have the lowest pings.
* The '''Host''' is the IP address of the server. You can use this address in future to connect to the same server via the Quick Connect option on the main menu.

Each tab can be clicked to arrange the respective column in ascending or descending order.

For optimal performance and gameplay, look for the best balance between players and ping.

Once you have picked a server, select it and click the '''Connect''' button in the top right-hand corner of the dialog. If all goes well, you should connect to the server and automatically join the game.

==How to Play==

MTA:SA offers a comprehensive scripting system that allows map creators to customize many elements of the game in order to create their own innovative game modes. The game incorporates as many single player elements as possible but some aspects are different.

The only other people on the map are your opponents, or allies if it is a team game. You can talk with them using the chatbox located in the left-hand corner of the screen by pressing '''T'''. To chat only to your team members, press '''Y'''.

MTA's map editor allows map creators to add various GTA objects to their maps including roads, exploding barrels, ramps, buildings, hills and more. Not only this, but the objects can be scripted to move, change model and disappear. This offers a great deal of fun and variation to the gameplay.

Holding Tab will display the scoreboard. By default, only names and pings are displayed, but scripts can add extra columns that are specific to the particular gamemode being played. For example, a deathmatch game mode would definitely have a column listing total kills, but the map creator may choose to add extra columns for the number of deaths you have and how long you have been playing for, in order to put your score into perspective.

==Default Controls==

===In-Game Keys===

* F8 (or Tilde Key) - Console
* F11 - Show SA map ''(the following list is for use when the map is up)''
**numpad /- - Zoom in and out
**numpad 4, 8, 6, 2 - move map left, up, right, down
**numpad 0 - toggle between attach to local player (map follows player blip) and free move (map stays stationary)
* F12 - Take a screenshot
* T - Chat
* Y - Team Chat

===Resource Specific Keys===
These keys depend on the scripts that are running on the server.

* F9 - In-game help (Help manager resource)
* Z - Push to talk, if voice is enabled on the server.
* TAB - Player List (if [[Scoreboard]] resource is running on the server)

==Console Commands==

'''bind defaults''' Binds control defaults in the settings menu

Press '''~ (tilde)''' or '''F8''' to access the console, then type a command followed by any necessary parameters (if applicable) then press Enter.

;'''maps''' :This displays a list of all maps available on the server.

;'''nick [nickname]''' :This changes your nickname whilst in-game to whatever you specify in the parameters.

;'''msg [nickname] [message]''' or '''pm [nickname] [message]''' :This sends a private message to the person you specify in the [nickname] parameter. Only the person you specify can see the message. Both '''msg''' and '''pm''' perform the same function.

;'''quit''' or '''exit''' :This disconnects you from the server and returns you to the Windows desktop. Performs the same function as the Quit button on the main menu.

;'''ver''' :This displays the version number and copyright information for the software.

;'''sver''' :This displays the version number of the server you are connected to.

;'''time''' :This displays the current time.

;'''disconnect''' :This disconnects you from the server and returns you to the main menu.

;'''say [text]''' :This enables you to continue talking to people in the chat box whilst the console is open.

;'''ignore [nickname]''' :This will not display any text typed by the player you wish to ignore. To stop ignoring a player, type '''ignore [nickname]''' again.
{{Tip|You can use these commands in the chatbox by putting a / (forward slash) in front of them.}}

A list of console commands can be seen by typing '''help''' into the console and pressing Enter. The current map may also have extra commands which can be accessed by typing '''commands''' into the console.

For information on more commands see: [[Client Commands]]

==Error codes and their meanings==
=== Download errors ===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|0
|UNKNOWN_ERROR
|-
|1
|INVALID_FILE_DESCRIPTORS
|-
|2
|INVALID_MAX_FILE_DESCRIPTOR
|-
|3
|INVALID_SELECT_RETURN
|-
|4
|INVALID_INITIAL_MULTI_PERFORM
|-
|5
|INVALID_MULTI_PERFORM_CODE
|-
|6
|INVALID_MULTI_PERFORM_CODE_NEW_DOWNLOADS
|-
|7
|UNEXPECTED_CURL_MESSAGE
|-
|8
|UNABLE_TO_CONNECT
|-
|9
|UNABLE_TO_DOWNLOAD_FILE
|-
|10
|FAILED_TO_INITIALIZE_DOWNLOAD
|}
===Fatal errors===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|1
|no local player model on ingame event
|-
|2
|no local player on ingame event
|-
|3
|server downloads disabled
|-
|4
|no local player model on player-list packet
|-
|5
|no local player on player-list packet
|-
|6
|invalid custom data length on entity-add packet
|-
|7
|invalid bitstream data on entity-add packet
|-
|8
|system entity on entity-add packet
|-
|9
|failed to create object on entity-add packet
|-
|10
|failed to create pickup on entity-add packet
|-
|11
|failed to create vehicle on entity-add packet
|-
|12
|invalid team-name length on entity-add packet
|-
|13
|invalid lua-event name length in lua-event packet
|-
|14
|invalid resource name length in resource-start packet
|}

==='Unable to enter vehicle' errors===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|1
|script cancelled
|-
|2
|script cancelled (jack)
|-
|3
|current occupier is entering/exiting
|-
|4
|invalid seat
|-
|5
|not close enough
|-
|6
|already in a vehicle
|-
|7
|already entering/exiting
|-
|8
|invalid vehicle (trailer)
|}

==Special: Playing MTA on Linux or macOS?==
If you're one of those who use other precious systems, and want to have the client working on your computer,
please read the [[Client on Linux Manual]] or [[Client on Mac OS X Manual]].

[[cs:Client Manual]]
[[es:Manual Cliente Deathmatch]]
[[de:MTA DM Client Anleitung]]
[[it:Manuale del Client]]
[[nl:Deathmatch Client Manual]]
[[ru:Deathmatch Client Manual]]
[[pl:Client Manual]]
[[pt-br:Manual do Cliente]]
[[hu:Client Manual]]
[[zh-cn:客户端手册]]

[[Category:Support]]

Where to buy GTASA

2020-04-10T23:02:20Z

Haxardous:

This page outlines some of the places Grand Theft Auto San Andreas can be bought and played with MTA:SA (sometimes with an automatic downgrade step).

<br />
'''Compatibility'''
<br />
Not all of the GTA versions listed below have been tested, but all should work correctly. If not, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and first follow the described procedure of re-installing MTA and if necessary afterward, using the patcher offered in the topic. If MTA is still not compatible, then please [https://forum.mtasa.com/forum/83-client/ contact MTA support] on the forums, or join the [https://mtasa.com/discord MTA discord] and do so in the #help-support channel.

Even though this page focuses on digital downloads, disc (DVD) versions of Windows GTA:SA are known to work fine.
If you are planning on buying GTA:SA to play MTA:SA, you should try to obtain a "Standard" version rather than "Second Edition", "Remastered Edition", or "Greatest Hits" editions.

{| class="wikitable" style="width: 900px; text-align: center; table-layout: fixed;"
|-
!Retailer
!Notes
!Works with MTA:SA?
|-
|[http://store.steampowered.com/app/12120/ Steam]
|Specialized Steam version of the game.
MTA installer will make this compatible for you (make sure to install the latest version of MTA '''after''' installing the Steam GTA version), but without modifying original game files.
|{{Yes}}
|-
|rowspan="2" |[http://www.amazon.com/Grand-Theft-Auto-Andreas-Download/dp/B006YVXGJQ Amazon]
|For the '''Standard''' edition of the game, if MTA is incompatible, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and follow the instructions.
|{{Partial|Unconfirmed (Standard)}}
|-
| Steam version and disc copies of GTA:SA will work fine
| {{Yes| Yes (Steam/Boxed DVD)}}
|-
|[https://www.gamersgate.com/DD-GTASAS-GN/grand-theft-auto-san-andreas GamersGate]
|rowspan=4|To our knowledge, these vendors are offering Steam versions of the game (make sure to verify), and therefore will function similarly to the first entry in this article (Retailer: Steam).
|rowspan="4" {{Yes}}
|-
|[http://digital.gamefly.co.uk/#!/download-grand-theft-auto-san-andreas/5006365 GameFly Digital]
|-
|[https://www.greenmangaming.com/games/grand-theft-auto-san-andreas/ GreenManGaming]
|-
|[https://www.walmart.com/ip/Grand-Theft-Auto-San-Andreas-PC-Digital-Download/55689611 Walmart]
|-
|[https://www.rockstarwarehouse.com/store/rsg/en_IE/pd/productID.5281755000 Rockstar Games Launcher]
|It is recommended to get GTA:SA straight from the [https://socialclub.rockstargames.com/rockstar-games-launcher Rockstar Games Launcher application] rather than the webshop page.
|{{Yes}}
|-
|[https://www.microsoft.com/en-us/p/grand-theft-auto-san-andreas/9wzdncrfj1zn Windows App Store]
|This is a mobile version of the game ported to PC. '''Will never work with MTA.'''
|{{No}}
|}

[[hu:Where to buy GTASA]]
[[es:Dónde comprar GTA: SA]]
[[pl:Where to buy GTASA]]
[[ru:Where to buy GTASA]]
[[uk:Where to buy GTASA]]
[[tr:GTA:SA Nerden Alınır]]
[[zh-cn:在那里可以购买GTASA]]
[[ro:Where to buy GTASA]]

Client Manual

2020-04-10T23:00:26Z

Haxardous: /* Recommended system requirements */

==Before you start==
Before you install Multi Theft Auto: San Andreas, first make sure that there are no modifications to GTA:SA installed. These will conflict with MTA. If you would like to keep your single-player mods, you can create two installations by reinstalling San Andreas to a second folder on your hard drive.

Also, make sure that your machine is capable of running the game in single player. Note that if you are running single player on the absolute minimum requirements, you will experience slowdowns in MTA as it takes up extra processing power.
{{Note|
* MTA:SA will only work on GTA:SA '''v1.0'''. If you bought the game recently, it is likely that you have a later version.''' [[Known_Issues_-_FAQ#Does_MTASA_work_with_v1.01_or_v2.00_of_GTA_San_Andreas.3F| (More info)]]
* If you have a Steam copy of GTA: San Andreas you should [[Known_Issues_-_FAQ#I_have_the_Steam_version_of_GTA_San_Andreas._How_can_I_play_MTASA.3F|read this first]].
}}

===System requirements===
====Minimum system requirements====
The minimum system requirements for Multi Theft Auto: San Andreas are '''slightly higher''' than the original minimum requirements for Grand Theft Auto: San Andreas:
* Windows 7 or newer (Microsoft supported) operating system ([[Compatibility FAQ|XP and Vista work, but they are obsolete and their support is being phased out]])
* Intel Pentium 4 or AMD Athlon XP
* 1GB DDR RAM
* Clean installation of Grand Theft Auto: San Andreas, version 1.0 (American or European)
* 3.7GB of free hard disk space (3.6GB for a minimum Grand Theft Auto installation; remember that MTA caches files from the servers that you play on and require disk space)
* Nvidia GeForce 4 series or ATI Radeon 8xxx series (64MB VRAM and DirectX 9.0 compatible)
* DirectX 9.0 compatible sound card
* Keyboard and mouse
* Internet access

====Recommended system requirements====
* Windows 7 or newer 64-bits (Microsoft supported) operating system
* Intel Core 2 Duo Processor or AMD equivalent
* 2GB DDR RAM
* Clean installation of Grand Theft Auto: San Andreas, version 1.0 (American or European)
* >5GB of free hard disk space (Remember that MTA caches files from the servers that you play on and require disk space)
* Nvidia GeForce FX series or higher, ATI Radeon 9xxx series or higher, Pixel Shader 2.0 compatible
* DirectX 9.0 compatible sound card
* Keyboard and mouse
* Broadband internet access (for smooth online play)

====Notes====
* The minimum system requirements are considered the bare minimum for MTA: San Andreas, the performance can depend on the game modes that are running and the player count.
* For extra loading performance, more RAM is recommended.
* Make sure Windows is fully up to date.
* Make sure you head over to the [[Known_Issues_-_FAQ|Known Issues]] page if you have issues, or join us on IRC @ irc://irc.multitheftauto.com/mta

==Installing the game==
# If you haven't already, download the MTA:SA client from the download page at [http://mtasa.com mtasa.com].
# Run the installer, for Windows Vista and 7 it is required to run this with administrator rights. (The installer will ask.)
# You need to accept the license that comes with MTA:SA (GPLv3).
# You will be asked which components to install:
#* '''Game Client''' interfaces with the game and is a required component.
#* '''Dedicated Server''' enables you to host your own home-brew server.
#** '''Core components''' and '''Game module''' are required components for the dedicated server.
#** '''Core resources''' required resources for dedicated server.
#** '''Optional resources''' additional resources for your dedicated server, gamemodes and maps.
#** '''Editor''' is used to create new maps, this is an optional component.
#* '''Development''' development tools.
#** '''Module SDK''' development SDK for creating your own MTA server modules, this component requires C++ knowledge.
#* '''Start menu group''' creates a start menu group for the installed components.
#* '''Desktop icon''' creates a desktop icon for the client.
# You are then asked for a folder in which to install the mod. This can by anywhere and doesn't have to be in you San Andreas directory.
# Next, you will be asked for the directory where you have San Andreas installed. The default location is: '''C:\Program Files\Rockstar Games\GTA San Andreas\'''.
# When the installation completes, you will be given the option to start MTA: San Andreas straight away. Choose your option and then press '''Finish'''.
# You will be able to launch ''MTA San Andreas'' from your Start Menu if you wish to play.

==Running the game==
# Start Multi Theft Auto by clicking the icon located in your Start Menu under '''MTA:San Andreas'''.
# GTA: San Andreas will start and once it is loaded, you will be presented with the MTA:SA main menu. Here you will find several options (you could also watch a how-to tutorial [http://www.youtube.com/watch?v=ShiqnOazNYw here]):

{| border="0" align="center"

| width="188" |
[[Image:Server_Browser.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Browse servers''' – this allows you to receive a list of available servers to play on. </font>

<br />
|-
| width="188" |
[[Image:Host_Game.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Host game''' – this allows you to start a local server. </font>

<br />
|-
| width="188" |
[[Image:Menu_Settings.JPG|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Settings '''– this allows you to change your in-game nickname, customize controls and adjust display settings.</font>

<br /><br />
|-
| width="188" |
[[Image:About_Menu.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''About '''– this gives you a list of contributors to the project.</font>

<br />
|-
| width="188" |
[[Image:Map_Editor.jpg|280px]]
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Map editor '''– this allows you to create your own maps, complete with checkpoints, ramps, pickups and other objects. These can then be uploaded onto a server so that you can play them with other people.</font>

<br /><br />
|-
| width="188" |
<br>
| width="380" |
<font size="-1" face="tahoma,helvetica,arial,sans-serif">'''Quit '''– this returns you back to your Windows desktop.</font>

<br /><br />
|}

The easiest way to play the game is to click '''Browse Servers''' on the menu. If servers have not appeared already, press the '''Refresh''' button and MTA will scan for servers, displaying them as a list.

* Under the '''Name''' tab, each server's name is displayed.
* Under the '''Players''' tab, the number of players and the maximum capacity of the server is displayed, in the format of [Used Slots] / [Maximum Slots].
* The '''Ping''' tab displays the ping, or latency, between your machine and the server. Ping is a measure of the time it takes for "packets" of data to be received back from the server after sending them, so a higher ping means that you will experience more lag on that particular server. Generally, servers closest to your location should have the lowest pings.
* The '''Host''' is the IP address of the server. You can use this address in future to connect to the same server via the Quick Connect option on the main menu.

Each tab can be clicked to arrange the respective column in ascending or descending order.

For optimal performance and gameplay, look for the best balance between players and ping.

Once you have picked a server, select it and click the '''Connect''' button in the top right-hand corner of the dialog. If all goes well, you should connect to the server and automatically join the game.

==How to Play==

MTA:SA offers a comprehensive scripting system that allows map creators to customize many elements of the game in order to create their own innovative game modes. The game incorporates as many single player elements as possible but some aspects are different.

The only other people on the map are your opponents, or allies if it is a team game. You can talk with them using the chatbox located in the left-hand corner of the screen by pressing '''T'''. To chat only to your team members, press '''Y'''.

MTA's map editor allows map creators to add various GTA objects to their maps including roads, exploding barrels, ramps, buildings, hills and more. Not only this, but the objects can be scripted to move, change model and disappear. This offers a great deal of fun and variation to the gameplay.

Holding Tab will display the scoreboard. By default, only names and pings are displayed, but scripts can add extra columns that are specific to the particular gamemode being played. For example, a deathmatch game mode would definitely have a column listing total kills, but the map creator may choose to add extra columns for the number of deaths you have and how long you have been playing for, in order to put your score into perspective.

==Default Controls==

===In-Game Keys===

* F8 (or Tilde Key) - Console
* F11 - Show SA map ''(the following list is for use when the map is up)''
**numpad /- - Zoom in and out
**numpad 4, 8, 6, 2 - move map left, up, right, down
**numpad 0 - toggle between attach to local player (map follows player blip) and free move (map stays stationary)
* F12 - Take a screenshot
* T - Chat
* Y - Team Chat

===Resource Specific Keys===
These keys depend on the scripts that are running on the server.

* F9 - In-game help (Help manager resource)
* Z - Push to talk, if voice is enabled on the server.
* TAB - Player List (if [[Scoreboard]] resource is running on the server)

==Console Commands==

'''bind defaults''' Binds control defaults in the settings menu

Press '''~ (tilde)''' or '''F8''' to access the console, then type a command followed by any necessary parameters (if applicable) then press Enter.

;'''maps''' :This displays a list of all maps available on the server.

;'''nick [nickname]''' :This changes your nickname whilst in-game to whatever you specify in the parameters.

;'''msg [nickname] [message]''' or '''pm [nickname] [message]''' :This sends a private message to the person you specify in the [nickname] parameter. Only the person you specify can see the message. Both '''msg''' and '''pm''' perform the same function.

;'''quit''' or '''exit''' :This disconnects you from the server and returns you to the Windows desktop. Performs the same function as the Quit button on the main menu.

;'''ver''' :This displays the version number and copyright information for the software.

;'''sver''' :This displays the version number of the server you are connected to.

;'''time''' :This displays the current time.

;'''disconnect''' :This disconnects you from the server and returns you to the main menu.

;'''say [text]''' :This enables you to continue talking to people in the chat box whilst the console is open.

;'''ignore [nickname]''' :This will not display any text typed by the player you wish to ignore. To stop ignoring a player, type '''ignore [nickname]''' again.
{{Tip|You can use these commands in the chatbox by putting a / (forward slash) in front of them.}}

A list of console commands can be seen by typing '''help''' into the console and pressing Enter. The current map may also have extra commands which can be accessed by typing '''commands''' into the console.

For information on more commands see: [[Client Commands]]

==Error codes and their meanings==
=== Download errors ===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|0
|UNKNOWN_ERROR
|-
|1
|INVALID_FILE_DESCRIPTORS
|-
|2
|INVALID_MAX_FILE_DESCRIPTOR
|-
|3
|INVALID_SELECT_RETURN
|-
|4
|INVALID_INITIAL_MULTI_PERFORM
|-
|5
|INVALID_MULTI_PERFORM_CODE
|-
|6
|INVALID_MULTI_PERFORM_CODE_NEW_DOWNLOADS
|-
|7
|UNEXPECTED_CURL_MESSAGE
|-
|8
|UNABLE_TO_CONNECT
|-
|9
|UNABLE_TO_DOWNLOAD_FILE
|-
|10
|FAILED_TO_INITIALIZE_DOWNLOAD
|}
===Fatal errors===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|1
|no local player model on ingame event
|-
|2
|no local player on ingame event
|-
|3
|server downloads disabled
|-
|4
|no local player model on player-list packet
|-
|5
|no local player on player-list packet
|-
|6
|invalid custom data length on entity-add packet
|-
|7
|invalid bitstream data on entity-add packet
|-
|8
|system entity on entity-add packet
|-
|9
|failed to create object on entity-add packet
|-
|10
|failed to create pickup on entity-add packet
|-
|11
|failed to create vehicle on entity-add packet
|-
|12
|invalid team-name length on entity-add packet
|-
|13
|invalid lua-event name length in lua-event packet
|-
|14
|invalid resource name length in resource-start packet
|}

==='Unable to enter vehicle' errors===
:{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!Code
!scope="col" class="unsortable" | Meaning
|-
|1
|script cancelled
|-
|2
|script cancelled (jack)
|-
|3
|current occupier is entering/exiting
|-
|4
|invalid seat
|-
|5
|not close enough
|-
|6
|already in a vehicle
|-
|7
|already entering/exiting
|-
|8
|invalid vehicle (trailer)
|}

==Special: Playing MTA on Linux or macOS?==
If you're one of those who use other precious systems, and want to have the client working on your computer,
please read the [[Client on Linux Manual]] or [[Client on Mac OS X Manual]].

[[cs:Client Manual]]
[[es:Manual Cliente Deathmatch]]
[[de:MTA DM Client Anleitung]]
[[it:Manuale del Client]]
[[nl:Deathmatch Client Manual]]
[[ru:Deathmatch Client Manual]]
[[pl:Client Manual]]
[[pt-br:Manual do Cliente]]
[[hu:Client Manual]]
[[zh-cn:客户端手册]]

[[Category:Support]]

Where to buy GTASA

2020-04-10T22:59:08Z

Haxardous:

This page outlines some of the places Grand Theft Auto San Andreas can be bought and played with MTA:SA (sometimes with an automatic downgrade step).

<br />
'''Compatibility'''
<br />
Not all of the GTA versions listed below have been tested, but all should work correctly. If not, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and first follow the described procedure of re-installing MTA and if necessary afterward, using the patcher offered in the topic. If MTA is still not compatible, then please [https://forum.mtasa.com/forum/83-client/ contact MTA support] on the forums, or join the [https://mtasa.com/discord MTA discord] and do so in the #support channel.

Even though this page focuses on digital downloads, disc (DVD) versions of Windows GTA:SA are known to work fine.
If you are planning on buying GTA:SA to play MTA:SA, you should try to obtain a "Standard" version rather than "Second Edition", "Remastered Edition", or "Greatest Hits" editions.

{| class="wikitable" style="width: 900px; text-align: center; table-layout: fixed;"
|-
!Retailer
!Notes
!Works with MTA:SA?
|-
|[http://store.steampowered.com/app/12120/ Steam]
|Specialized Steam version of the game.
MTA installer will make this compatible for you (make sure to install the latest version of MTA '''after''' installing the Steam GTA version), but without modifying original game files.
|{{Yes}}
|-
|rowspan="2" |[http://www.amazon.com/Grand-Theft-Auto-Andreas-Download/dp/B006YVXGJQ Amazon]
|For the '''Standard''' edition of the game, if MTA is incompatible, visit [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this topic] and follow the instructions.
|{{Partial|Unconfirmed (Standard)}}
|-
| Steam version and disc copies of GTA:SA will work fine
| {{Yes| Yes (Steam/Boxed DVD)}}
|-
|[https://www.gamersgate.com/DD-GTASAS-GN/grand-theft-auto-san-andreas GamersGate]
|rowspan=4|To our knowledge, these vendors are offering Steam versions of the game (make sure to verify), and therefore will function similarly to the first entry in this article (Retailer: Steam).
|rowspan="4" {{Yes}}
|-
|[http://digital.gamefly.co.uk/#!/download-grand-theft-auto-san-andreas/5006365 GameFly Digital]
|-
|[https://www.greenmangaming.com/games/grand-theft-auto-san-andreas/ GreenManGaming]
|-
|[https://www.walmart.com/ip/Grand-Theft-Auto-San-Andreas-PC-Digital-Download/55689611 Walmart]
|-
|[https://www.rockstarwarehouse.com/store/rsg/en_IE/pd/productID.5281755000 Rockstar Games Launcher]
|It is recommended to get GTA:SA straight from the [https://socialclub.rockstargames.com/rockstar-games-launcher Rockstar Games Launcher application] rather than the webshop page.
|{{Yes}}
|-
|[https://www.microsoft.com/en-us/p/grand-theft-auto-san-andreas/9wzdncrfj1zn Windows App Store]
|This is a mobile version of the game ported to PC. '''Will never work with MTA.'''
|{{No}}
|}

[[hu:Where to buy GTASA]]
[[es:Dónde comprar GTA: SA]]
[[pl:Where to buy GTASA]]
[[ru:Where to buy GTASA]]
[[uk:Where to buy GTASA]]
[[tr:GTA:SA Nerden Alınır]]
[[zh-cn:在那里可以购买GTASA]]
[[ro:Where to buy GTASA]]

User:Haxardous

2020-04-06T18:52:15Z

Haxardous: /* Haxardous */

User:Haxardous

2020-04-06T18:52:08Z

Haxardous: /* Haxardous */

== Haxardous ==
*'''Forums:''' https://forum.mtasa.com/profile/57792-haxardous/
*'''GTA Forums''': https://gtaforums.com/profile/1056938-axa/
*'''GitHub''': https://github.com/Haxardous
*'''Community Resources''': https://community.multitheftauto.com/index.php?p=profile&id=474102

Known Issues - FAQ

2020-04-06T18:47:28Z

Haxardous: /* General */

{{Important Note|Before you check the known issues make sure everything is [[Up-to-date]].}}
Post here your proposed Q&A, regarding the known problems with MTA:SA and their solutions, especially the problems we are encountering now, that might be also encountered by users in the final release. You are also welcome to edit them grammar/style wise.

* [[Resource:Editor#FAQ|Map editor FAQ/known issues can be found here.]]<br>
* [[MTA 0.5r2 Known Issues|Known issues for MTA 0.5r2 can be found here.]]
* [[Compatibility FAQ|Compatibility FAQ]]

== Client ==
=== General ===
==== I have the Steam version of GTA San Andreas. How can I play MTASA? ====
:The Steam version of GTASA is currently incompatible with MTASA, just like it is with some other mods. However, it can be made to work with it.

:'''If you just want to play the newest version of the mod, all you need to do is download the mod from our home page and then install it'''. The installer will detect your Steam's GTASA installation and will make some adjustments automatically.
:No original files are modified in the process, so the single-player mode will work the same way as it did before.

:If you want to play some older MTA:SA version (1.3.2 or older), follow a few simple steps, and the Steam version will be compatible with it:
:* '''Option 1:''' Find a '''GTA SA 1.00 No-CD''' (Google will give useful results). You should obtain a 1.00 Cracked/NoCd EXE, not a Disc image. Any HOODLUM release will work fine.
:** Open the download with Winrar or other similar archive tools, and inside there should be a gta_sa.exe. Place this file inside your installation directory. This is normally '''C:\Program Files\Steam\steamapps\common\grand theft auto san andreas'''. No files need to be replaced during this process.
:This procedure will not affect your Steam version of GTASA, but will allow MTASA to boot alongside it.
:* '''Option 2:''' Use the unofficial [https://forums.steampowered.com/forums/showthread.php?t=1952458 steam downgrade patch], be sure to downgrade to 1.0 and not 1.01.

==== Does MTASA work with v1.01 or v2.00 of GTA San Andreas? ====
:No. It can be made to work with them, however - please see [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ this forum topic] for instructions on patching the exe.

==== Initial black screen/hanging GTA splash screens ====
:* '''MTA shows a permanent black screen or hanging GTA splash screens.'''

:It may be necessary that during/after the logo splash screens in Grand Theft Auto you have to give some input in order to skip the videos correctly. Try to click your left-mouse button a few times, or tapping a few keys.

:* '''MTA shows a permanent black screen after the GTA splash screens (possibly with text in the bottom right corner).'''

:This can be related to a lack of support for DirectX or video card features, on your system, which is needed to run the dynamically rendered menu. This dynamic menu is enabled by default. You can disable it by opening your [[coreconfig.xml]] configuration file located in the ''GTA San Andreas\MTA'' directory, and changing the value of ''menu_options'' to ''248''.

==== Halt after MTA splash screen ====
:* '''Nothing happens after the 'Stop playing with yourself' splash screen'''

:If you use Nvidia GeForce, try turning off nView Desktop Manager before starting MTA.

:Also try deleting GTA San Andreas settings file ("gta_sa.set") in "Documents\GTA San Andreas User Files" folder.

:If it all fails and you run Kaspersky Anti-Virus or Internet Security, make sure status of "multi theft auto.exe" is not restricted. Other anti-virus software may block MTA from running.

==== Crash after MTA splash screen ====
:* '''MTA crashes after the 'Stop playing with yourself' logo. Both single-player and the MTA: Race ran fine before.'''

:Try downloading the latest DirectX Runtime files from [https://www.microsoft.com/downloads/details.aspx?FamilyID=2da43d38-db71-4c1b-bc6a-9b6652cd92a3&DisplayLang=en Microsoft]. Also check in Task Manager, if :gta_sa.exe process isn't already running.

:If you run at any substandard resolutions (e.g. 960x720), try to change your resolution to a commonly supported one (e.g. 640×480, 800×600, 1024×768, 1152×864, 1280×1024) by launching Grand Theft Auto: San Andreas in normal mode, setting the new resolution and exiting.

:If you are a user of Windows Vista or Windows 7, try the following:
:* Enable Windows XP SP3 compatibility mode for both Multi Theft Auto.exe and gta_sa.exe, setting their privilege level to "Run this program as an administrator".
:* Configure Data Execution Prevention: Use the setting ''Turn DEP for all programs and services except those I select''. Click ''add'' and find "Multi Theft Auto.exe" and "gta_sa.exe" and add them.
:* Run MTASA as administrator.

==== Crash after connecting to any server ====
:* '''MTASA crashes upon connecting to any server. Single player runs fine.'''

:Single-player mods can affect the way MTA:SA works, potentially causing crashes - you should always use a clean GTASA install for MTA:SA.

:This might also occur on non-modded installs, when your GTASA executable is in an unsupported by MTA:SA version (eg. 1.0 German or Australian). To resolve this, use [https://forum.mtasa.com/topic/11757-patching-your-101-or-200-version-of-gta_saexe/ our converter].

==== Controls not working ====
:* '''My controls don't seem to work as they should.'''

:Try using the 'copygtacontrols' command in the console.

==== Incorrect models ====
:* '''Woman model's breasts look awkward ingame / I'm seeing odd, spider-like shaped player models.'''

:This is caused by the way GTA handles player stats. To fix this, be sure to set both fat and muscles player stats to 0 when you're changing player skin.

==== Incorrect drive-by functionality ====
:* '''Drivebys arent working as they should'''

:Drivebys are handled by the script, and will change depending on the loaded gamemode.

==== Unsaved settings ====
:* '''My MTA setting(s) didn't get saved (...) I crashed.'''

:First, configure the MTA the way you want to, then exit the game and launch it again. Settings should get saved. Alternatively, try removing the coreconfig.xml file, then configure it and quit the game.

==== Gamepad support ====
:* '''MTA doesn't recognise my gamepad'''

:Ensure that your controller is the first controller recognized by Windows (MTA will only use the first controller). You can configure your gamepad in options in MTASA's main menu.

==== Free mouselook not working properly ====
:* '''MTA doesnt recognise my mouse'''

:Some people got problems with their mouse in MTA. They can use it in the menu, connect to a server, but they can't use the mouse for free look.
:This problem can be solved by entering a server, click your Win/Windows key at your keyboard once, and then click your mouse.
:If that doesn't work try starting GTA in Singleplayer, go to options > controller setup and set "Configuration" to "Mouse + Keys" instead of "Joypad".

==== Server browser not working ====
:* '''The in-game server browser shows "Loading" but does not come up with any servers'''

:Depending on the type and status of the internet connection you are using, it can take up to a few seconds for the server browser to retrieve all the servers. Please wait a little longer for the results to appear.

==== Invalid serial number ====
:* '''I am getting an 'Invalid serial number' error when trying to launch or play the game'''

:You are running an outdated version of Multi Theft Auto. Head over to the [https://mtasa.com/ main page] and download the latest version of Multi Theft Auto.

==== 'Network module not compatible!' on MTA:SA launch ====
:* '''I am getting 'Network module not compatible!' error message upon launching MTA:SA

:This could mean that your MTA:SA install is incomplete or broken. Reinstall it.

==== 'No such mod installed (deathmatch)' ====
:* '''I am getting a 'No such mod installed (deathmatch)' error message when trying to connect to any server

:'''Option 1:''' Simply re-install MTA. <br>
:'''Option 2:''' Run both gta_sa.exe and Multi Theft Auto.exe with administrator privileges.

==== D3dx9_**.dll is not found ====
:* '''When I start Multi Theft Auto: San Andreas I am getting an error D3dx9_**.dll (** = a number) cannot be found.

:This means that DirectX 9 is not installed or not up to date.
:To install/update DirectX download the [https://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=2da43d38-db71-4c1b-bc6a-9b6652cd92a3 DirectX End-User Runtime Web Installer] from the Microsoft download site.

==== CRC mismatch ====
:* '''When joining a server, the chatbox shows 'CRC mismatch'
:This is a server problem. Tell the owner to look at the server section of this page.

==== 'Error loading netc.dll module! (Error 14001)' on MTA:SA launch ====
:* Full error message:
:''Error loading netc.dll module! (Error 14001: The application has failed to start because its side-by-side configuration is incorrect. Please see the application event log for more detail.)''

:Make sure you have installed Microsoft Visual C++ 2008 regular and SP1 redistributable packages (x86):

:[https://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en Microsoft Visual C++ 2008 Redistributable Package (x86)]

:[https://www.microsoft.com/download/en/details.aspx?id=5582 Microsoft Visual C++ 2008 SP1 Redistributable package (x86)]

==== 'Error 1935. An error occurred during the installation of assembly 'Microsoft.VC90.ATL...' ====
: Download the 'Fix it' helper from here: [https://support.microsoft.com/default.aspx?scid=kb;en-us;946414]

==== Your virus scanner warns you about MTA:SA ====
:* '''Your virus scanner informs you that the MTA:SA or setup executable is a virus or malware.'''
:MTA does '''NOT''' contain any viruses, malware, adware or spyware. You should re-download MTASA [https://mtasa.com here] if you doubt the validity of your copy of MTA.

==== When downloading large maps, progress halts ====
:* '''When downloading large maps, progress often halts, while transmission is still taking place.'''
:This issue is fixed in [https://forum.mtasa.com/topic/33297-multi-theft-auto-san-andreas-13-released/ MTA:SA 1.3].

==== loader.dll (error 126) ====
loader.dll (error 126) has been flagged as a false positive by Avast, McAfee and perhaps other antivirus software. This means that your antivirus software thinks it's a virus, but it actually isn't.

'''Avast instructions'''

:* Make sure Avast is up to date.
:* Reinstall MTA.

'''McAfee'''
:* Open your McAfee security software.
:* Click the settings cog at the top right.
:* Click Real-Time Scanning.
:* Click Excluded Files.
:* Click Add file.
:* Browse to, and select, the file that you want to exclude from scans.

You'll need to exclude the MTA installation folder. Once done, reinstall MTA and then add "loader.dll" to your exclusions and remove the previously added exclusion for the MTA folder. If you want you can skip the last bit and keep MTA installation folder whitelisted (excluded)

=== Display ===
==== I can only set my display to square resolutions... ====
: Try reinstalling your display driver.

=== Windows Vista® / Windows 7-specific (Vista is no longer supported on 1.5.7) ===

==== Crash on connect ====
:* '''I seem to crash whenever I connect to a server just before I go in-game on Vista'''

:This seems to be an issue with the Microsoft DirectX April 2006 SDK Redistributable DLL file (d3dx9_30.dll) when running in compatibility mode. Please make sure that compatibility mode is completely turned off for '''both''' your GTA_SA.exe and Multi Theft Auto.exe executables.

==== Clock manipulation error ====
:* '''I am getting 'Clock manipulation detected!' error message upon launching MTA:SA

:This is caused by incorrect system date/time is set (which could be a result of wrong settings or a faulty battery on the pc's motherboard). Setting time and date again should fix the problem.

:It might also happen if you are using an AMD Athlon 64 X2 processor with some old drivers. Update them at [https://support.amd.com/en-us/download AMD's site].

==== Halt on launch ====
:* '''When I launch MTA:SA, nothing happens (GTA_SA.exe is running but not loading up)

:Run MTA:SA with Administrator privileges. To do this, right-click on the installer executable, choose 'Properties', go into 'Compatibility' tab and tick the checkbox on the last field and try again.

==== General GTA problems ====
:* '''I have unexplainable GTA problems or crashes'''

:Make sure your computer, as well as your GTA install, meet the [[Deathmatch_Client_Manual#System_requirements|minimum requirements]] and that you are not running in any 98/2000/XP/2003 compatibility modes.

:Also try the solutions from these pages:
:* http://gtaforums.com/topic/307992-san-andreas-v1-works-on-windows-vista/
:* [https://web.archive.org/web/20160330172922/http://pullmonkey.com/2007/4/30/how-i-got-gta-san-andreas-to-work-with-a-crappy-os-vista http://pullmonkey.com/2007/4/30/how-i-got-gta-san-andreas-to-work-with-a-crappy-os-vista]

==== Performance Issues Sandy Bridge / Second Generation Intel Core ====
:* '''Slow MTA performance on Sandy Bridge Processors while other games and San Andreas Singleplayer run fine.'''
:There seems to be an issue in combination with the Windows power profile running in power saving mode, you can solve this issue by changing the power profile to high performance when playing MTA:SA.
:* Topic about this issue: [https://forum.mtasa.com/topic/26441-solved-sandy-bridge-performance-issues/ Sandy Bridge performance issues?]

== Server ==

=== General ===
==== Fatal error 3 ====
:* '''I'm getting ''Fatal Error 3'' whenever I connect to my server'''

:This error happens when the server you are trying to connect to is unable to provide you the required downloads because it does not have HTTP downloading enabled. Be sure to set the '''httpdownload''' configuration tag in your configuration to '''1'''.
==== Download error 9: Error downloading requested files ====
:* '''I'm getting ''Download Error 9: Error downloading requested files'' whenever I connect to my server'''

:This error happens when the server you are trying to connect to is unable to provide you with a valid link. This results in a 404 (Not found) HTTP error and an error at your end.

:* If you are running the built-in server ('''httpserver''' is set to '''1''' and '''httpdownloadurl''' is empty), make sure that your HTTP server is accessible (you can try to access it by using a browser) for everyone.

:* If you have configured an external web server ('''httpdownloadurl''' is set to your custom URL), make sure that your HTTP is accessible and make sure you have read the [[Deathmatch_Server_Manual#Configuring_an_external_web_server | Configuring an external web server]] guide.

==== CRC mismatch ====
:* '''When clients join my server, their chatbox shows 'CRC mismatch'
:CRC mismatch occurs when either:
:* The server files have been changed, but the resource has not been restarted/refreshed
:* An external HTTP server is being used and the files are not synchronized

==== Accounts missing ====
:The file ''accounts.xml'' is not used from 1.0.4, it has been replaced by a file called ''internal.db''. To ensure your old accounts information is migrated:
:*Stop the server
:*Make sure your old ''accounts.xml'' is correct
:*Delete ''internal.db''
:*Start the server

==== Resources missing ====
:From 1.0.4, resource names cannot contain dots.

==== Download error 28 ====
:Try closing anti-virus or firewall applications. If it then works, try adding an exception to your firewall to allow your HTTP port through.

==== Accounts disappearing ====
:Account information (or anything else) not being saved correctly can be caused by database corruption. From build 2836, the server checks the integrity of the SQLite database files on startup. If it reports a database error, please read [[How to repair the database files]].
:If you are running an earlier version and are having troubles such as accounts disappearing, you should upgrade your server to the [https://nightly.multitheftauto.com/ latest build]

=== Windows-related ===
:No known reported issues in {{Current Version|full}}.

=== Linux-related ===
====Default nohup creates infinitely big nohup.out====

:Temporary fix, disable the nohup file: 'nohup ./mta_server > /dev/null &'

[[es:Problemas Conocidos - FAQ]]
[[it:Bugs noti e FAQ]]
[[ru:Known Issues - FAQ]]
[[de:Known Issues - FAQ]]
[[pt-br:Soluções de Problemas - FAQ]]
[[hu:Known Issues - FAQ]]
[[zh-cn:已知问题 - 常见问题]]

[[Category:Support]]

Compiling MTASA

2020-03-31T21:16:50Z

Haxardous: /* Compiling the code */

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Atuo client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've make a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download'''<br>
[https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)]<br>

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h'''<br>
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib'''<br>
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error'''<br>
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)]<br style="clear:both">

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository.<br>
We recommend cloning the repository in your Git client, because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software.<br>
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run the step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can goto ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software.<br>
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compilling the code'' and follow the steps for a ''Debug'' build.<br>
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.<br>
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise your
breakpoints will not work for anything beside the MTA Launcher project.<br>
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

Compiling MTASA

2020-03-31T21:16:00Z

Haxardous: /* Compiling the code */

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Atuo client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've make a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download'''<br>
[https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)]<br>

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h'''<br>
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib'''<br>
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error'''<br>
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)]<br style="clear:both">

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository.<br>
We recommend cloning the repository in your Git client, because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln[MTASA.sln - Shortcut]''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software.<br>
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run the step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can goto ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software.<br>
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compilling the code'' and follow the steps for a ''Debug'' build.<br>
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.<br>
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise your
breakpoints will not work for anything beside the MTA Launcher project.<br>
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

Compiling MTASA

2020-03-31T20:33:49Z

Haxardous: /* The Windows SDK version 8.1 was not found. */

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Atuo client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've make a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download'''<br>
[https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)]<br>

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h'''<br>
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib'''<br>
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error'''<br>
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)]<br style="clear:both">

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository.<br>
We recommend cloning the repository in your Git client, because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software.<br>
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run the step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can goto ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software.<br>
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compilling the code'' and follow the steps for a ''Debug'' build.<br>
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.<br>
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise your
breakpoints will not work for anything beside the MTA Launcher project.<br>
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

Compiling MTASA

2020-03-31T20:31:16Z

Haxardous: /* Errors */

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Atuo client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've make a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download'''<br>
[https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)]<br>

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h'''<br>
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib'''<br>
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error'''<br>
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)]<br style="clear:both">

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository.<br>
We recommend cloning the repository in your Git client, because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software.<br>
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run the step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can goto ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software.<br>
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compilling the code'' and follow the steps for a ''Debug'' build.<br>
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.<br>
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise your
breakpoints will not work for anything beside the MTA Launcher project.<br>
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

== The Windows SDK version 8.1 was not found. ==
Solution: Download & Install https://go.microsoft.com/fwlink/p/?LinkId=323507

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]