Multi Theft Auto: Wiki - User contributions [en]

Server mtaserver.conf

2022-12-29T03:37:29Z

IDannz: fix "ped_sync_interval" default value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>500</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 50 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:35:50Z

IDannz: fix "keysync_analog_sync_interval" max value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 50 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:35:19Z

IDannz: fix "keysync_mouse_sync_interval" max value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 50 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:34:51Z

IDannz: fix "unoccupied_vehicle_sync_interval" min value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 50 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:33:23Z

IDannz: fix "ped_sync_interval" min and default value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:32:34Z

IDannz: fix "camera_sync_interval" min and max value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 50 - 4000; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server mtaserver.conf

2022-12-29T03:31:14Z

IDannz: fix "player_sync_interval" max value

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[https://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 4000; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 200 - 400; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: https://bugs.mtasa.com/view.php?id=8191 + https://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: https://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />
:''<resource src-"resources" startup"1" protected="0"
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

User:IDannz

2021-12-10T12:30:04Z

IDannz:

Discord: iDannz#8143

Template:DxFonts

2021-08-26T21:45:57Z

IDannz: add unifont

** '''"default":''' Tahoma
** '''"default-bold":''' Tahoma Bold
** '''"clear":''' Verdana
** '''"arial":''' Arial
** '''"sans":''' Microsoft Sans Serif
** '''"pricedown":''' Pricedown (GTA's theme text)
** '''"bankgothic":''' Bank Gothic Medium
** '''"diploma":''' Diploma Regular
** '''"beckett":''' Beckett Regular
** '''"unifont":''' Unifont

TestLineAgainstWater

2021-04-19T15:54:02Z

IDannz: fix wrong wave's information

__NOTOC__
{{Client function}}
This function checks to see if a line between two points collides with the water. This is similar to [[processLineOfSight]], but only collides with water. Waves are not taken into account when testing the line.

==Syntax==
<syntaxhighlight lang="lua">
bool float float float testLineAgainstWater ( float startX, float startY, float startZ, float endX, float endY, float endZ )
</syntaxhighlight>

===Required Arguments===
*'''startX, startY, startZ:''' the position of the starting point of the line.
*'''endX, endY, endZ:''' the position of the end point of the line.

===Returns===
Returns ''true'' and the position of the intersection point of the line and the water surface if there is a collision, or ''false'' if there is no collision.

==Example==
This code snippet adds a /isanywaterbelowme command, which checks if there is water at 500 units below the ground at the position of the player who types it.

<syntaxhighlight lang="lua">
function checkForWater()
if isPedOnGround(localPlayer) then
local px, py, pz = getElementPosition(localPlayer)
if testLineAgainstWater(px, py, pz, px, py, pz - 500) then
outputChatBox("Yes, there is water below you.")
else
outputChatBox("This place looks a bit dry.")
end
end
end
addCommandHandler("isanywaterbelowme", checkForWater)
</syntaxhighlight>

==See Also==
{{Client world functions}}

GetVehicleNameFromModel

2021-04-19T02:36:48Z

IDannz: fix returned value

{{Server client function}}
__NOTOC__
Gets the name of a vehicle by its model ID.

==Syntax==
<syntaxhighlight lang="lua">
string getVehicleNameFromModel ( int model )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Vehicle class.|[[Vehicle]].getNameFromModel}}
===Required Arguments===
*'''model:''' This is the vehicle model ID. See [[vehicle IDs]] to see what values will return names.

===Returns===
Returns the name of the vehicle if the model ID was valid, ''false'' otherwise.

==Example==
This will retrieve the name of a car so its name can be displayed when the player chooses to spawn a car by model ID.
<syntaxhighlight lang="lua">
function createVehicleCommand ( thePlayer, commandName, carModel )
-- This function is triggered by the text "spawnvehicle" in the console.
-- The player must specify the parameter 'carModel' to specify
-- what car they wish to spawn.
local x, y, z = getElementPosition ( thePlayer )
-- Get the position of the player to spawn the car near this location
local carName = getVehicleNameFromModel ( tonumber ( carModel ) )
-- Get the name of the car the player asked for and store it in the
-- variable 'carName'
if not carname then
outputChatBox ( "That is not a valid car model ID", thePlayer )
else
createVehicle ( tonumber ( carModel ), x + 5, y, z )
-- Spawn the car at x + 5 from the player so it doesn't crush him
outputChatBox ( "A " .. carName .. " was created!" )
end
-- If the entered car model ID is invalid, false will be returned.
-- Otherwise a string is returned, we create the car and announce the car name in the chatbox.
end
addCommandHandler ( "spawnvehicle", createVehicleCommand )
</syntaxhighlight>

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

EngineSetModelVisibleTime

2021-04-15T15:01:40Z

IDannz: update maximum time from 23 to 24 (it has been changed here https://github.com/multitheftauto/mtasa-blue/pull/752/commits/906e93ebb671ac35de05fcd9ca2257ab38efba7c#diff-d6d2100da6b9b456c3f97be0fe2b123180ecc5171dcd41f8fa532c6d99372075R940)

__NOTOC__
{{Client function}}
{{New feature/item|3.0159|1.5.8|20416|This function changes model visibility time, this is used for example for building lights being shown after 23:00.}}

==Syntax==
<syntaxhighlight lang="lua">bool engineSetModelVisibleTime( int modelID, int timeOn, int timeOff )</syntaxhighlight>
===Required Arguments===
*'''modelID''': ID of the model
*'''timeOn''': value between 0 and 24 that states when the model should appear
*'''timeOff''': value between 0 and 24 that states when the model should disappear

===Returns===
Returns '''true''' if the change was successful, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
Make Los Santos Tower visible only between 10 and 12 AM. Please keep in mind that this function does not affect collision - the building is still there, it's just invisible.
<syntaxhighlight lang="lua">
function init()
engineSetModelVisibleTime(4550, 10, 12)
end
addEventHandler("onClientResourceStart", resourceRoot, init)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.5.8-9.20416|}}
==See Also==
{{Engine_functions}}

GetCameraViewMode

2021-04-08T05:36:34Z

IDannz: add ped camera modes

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20851|Now you can get the camera mode when the [[player]] is not inside a [[vehicle]].}}

This function allows you to get the camera's view mode. This indicates at what distance the camera will follow the player.

==Syntax==
<syntaxhighlight lang="lua">
int, int getCameraViewMode ( )
</syntaxhighlight>
{{OOP||Camera.getCameraViewMode|viewMode|setCameraViewMode}}

===Returns===
Returns two [[int]] indicating the current camera view modes. Their meanings can be seen below.

{{Camera view modes}}

==Example==
This example tells the player their current camera view when they change it
<syntaxhighlight lang="lua">
function onPlayerSpawn ( theSpawnpoint )
currentCam("fire") -- start a repeating check
end
addEventHandler ( "onClientPlayerSpawn", root, onPlayerSpawn )

function currentCam(key)
if (getControlState(key)) then
local vehicleMode, pedMode = getCameraViewMode()
outputChatBox("Your current cam view is: "..vehicleMode..".")
end
end
</syntaxhighlight>

==See Also==
{{Client camera functions}}

[[hu:getCameraViewMode]]
[[RO:getCameraViewMode]]

SetCameraViewMode

2021-04-08T05:31:32Z

IDannz: add ped camera modes

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20851|Now you can change the camera mode when the [[player]] is not inside a [[vehicle]].}}

This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player.

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraViewMode ( int vehicleCameraMode [, int pedCameraMode ] )
</syntaxhighlight>
{{OOP||Camera.setCameraViewMode|viewMode|getCameraViewMode}}
===Required Arguments===
*'''vehicleCameraMode''': The view mode you wish to use when inside vehicles.

===Optional Arguments===
*'''pedCameraMode''': The view mode you wish to use when you are not inside vehicles.
{{Camera view modes}}

===Returns===
Returns ''true'' if the view was set correctly, ''false'' otherwise.

==Example==
This example sets the camera to bumper view when the local player enters any vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerVehicleEnter", localPlayer, function()
setCameraViewMode(0)
end)
</syntaxhighlight>

==See Also==
{{Client camera functions}}

[[hu:setCameraViewMode]]
[[RO:setCameraViewMode]]

Template:Camera view modes

2021-04-08T05:20:34Z

IDannz: fix ped mode's indexes

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
Vehicle Modes:
* '''0''': Bumper
* '''1''': Close external
* '''2''': Middle external
* '''3''': Far external
* '''4''': Low external
* '''5''': Cinematic

Ped Modes:
* '''1''': Close
* '''2''': Middle
* '''3''': Far
</div>

Template:Camera view modes

2021-04-08T05:18:53Z

IDannz: add ped view modes

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
Vehicle Modes:
* '''0''': Bumper
* '''1''': Close external
* '''2''': Middle external
* '''3''': Far external
* '''4''': Low external
* '''5''': Cinematic

Ped Modes:
* '''0''': Close
* '''1''': Middle
* '''2''': Far
</div>

SetTransferBoxVisible

2021-01-05T02:51:05Z

IDannz: add setTransferBoxVisible

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.5.8|20788|Determines whether or not the transferbox should appear to [[players]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool setTransferBoxVisible ( bool visible )
</syntaxhighlight>

===Required Arguments===
*'''visible:''' The new visibility state.

===Returns===
Returns ''true'' if the visibility was set successfully, ''false'' otherwise.

==Examples==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
addEventHandler('onResourceStart', resourceRoot, function()
setTransferBoxVisible(false)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.8-9.20788|1.5.8-9.20788|}}

User:IDannz

2021-01-03T05:28:15Z

IDannz: Created page with "Discord: iDannz#7527"

Discord: iDannz#7527

Template:Client audio functions

2021-01-03T04:50:18Z

IDannz: add isSoundLooped and setSoundLooped

*[[getRadioChannel]]
*[[getRadioChannelName]]
*[[getSFXStatus]]
*[[getSoundBPM]]
{{New items|3.0157|1.5.6|
*[[getSoundBufferLength]]
|16216}}
*[[getSoundEffects]]
*[[getSoundFFTData]]
*[[getSoundLength]]
*[[getSoundLevelData]]
*[[getSoundMaxDistance]]
*[[getSoundMetaTags]]
*[[getSoundMinDistance]]
*[[getSoundPan]]
*[[getSoundPosition]]
*[[getSoundProperties]]
*[[getSoundSpeed]]
*[[getSoundVolume]]
*[[getSoundWaveData]]
{{New items|3.0160|1.5.8|
*[[isSoundLooped]]
|20785}}
*[[isSoundPanningEnabled]]
*[[isSoundPaused]]
*[[playSFX]]
*[[playSFX3D]]
*[[playSound]]
*[[playSound3D]]
*[[playSoundFrontEnd]]
*[[setRadioChannel]]
*[[setSoundEffectEnabled]]
{{New items|3.0160|1.5.8|
*[[setSoundLooped]]
|20785}}
*[[setSoundMaxDistance]]
*[[setSoundMinDistance]]
*[[setSoundPan]]
*[[setSoundPanningEnabled]]
*[[setSoundPaused]]
*[[setSoundPosition]]
*[[setSoundProperties]]
*[[setSoundSpeed]]
*[[setSoundVolume]]
*[[stopSound]]
<noinclude>[[Category:Functions templates]]</noinclude>

IsSoundLooped

2021-01-03T04:42:42Z

IDannz: add isSoundLooped

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to return the current loop option of the [[sound]] [[element]].}}

==Syntax==
<syntaxhighlight lang="lua">bool isSoundLooped(element theSound)</syntaxhighlight>
{{OOP||[[sound]]:isLooped||setSoundLooped}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which you want to get the loop state.

===Returns===
Returns ''true'' if the [[sound]] [[element]] is seted to loop, ''false'' otherwise.

<syntaxhighlight lang="lua">
local mySound
addEventHandler('onClientResourceStart', resourceRoot, function()
mySound = playSound('sound.mp3')
setSoundLooped(mySound, true)
end)

addCommandHandler('loop', function()
if isElement(mySound) then
local newState = not isSoundLooped(mySound)
setSoundLooped(mySound, newState)
if newState then
outputChatBox('The sound will loop...')
else
outputChatBox('The sound will not loop anymore...')
end
end
end)
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

SetSoundLooped

2021-01-03T04:39:59Z

IDannz: add "see also"

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to change the loop option of the [[sound]] [[element]].}}
{{Note|If the [[sound]] [[element]] is destroyed by [[destroyElement]] the loop will not happen.}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundLooped(element theSound, bool loop)</syntaxhighlight>
{{OOP||[[sound]]:setLooped||isSoundLooped}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] to set the loop.
*'''bool:''' A [[boolean]] representing whether the sound will be looped.

===Returns===
Returns ''true'' if the [[sound]] [[element]] loop was successfully changed, ''false'' otherwise.

<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local mySound = playSound('sound.mp3')
setSoundLooped(mySound, true)
end)
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

SetSoundLooped

2021-01-03T04:38:53Z

IDannz:

SetSoundLooped

2021-01-03T04:38:28Z

IDannz: add SetSoundLooped

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to change the loop option of the [[sound]] [[element]].}}

{{Note|If the [[sound]] [[element]] is destroyed by [[destroyElement]] the loop will not happen.}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundLooped(element theSound, bool loop)</syntaxhighlight>
{{OOP||[[sound]]:setLooped||isSoundLooped}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] to set the loop.
*'''bool:''' A [[boolean]] representing whether the sound will be looped.

===Returns===
Returns ''true'' if the [[sound]] [[element]] loop was successfully changed, ''false'' otherwise.

<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local mySound = playSound('sound.mp3')
setSoundLooped(mySound, true)
end)
</syntaxhighlight>

GetVehicleWheelFrictionState

2021-01-02T16:53:09Z

IDannz: added the minimum version

{{Client function}}
__NOTOC__

{{New feature/item|3.0160|1.5.8|20726|This function returns the current wheel friction state of the [[vehicle]].}}

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleWheelFrictionState ( vehicle theVehicle, int wheel )
</syntaxhighlight>

{{OOP||[[vehicle]]:getWheelFrictionState}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the wheel friction state.
*'''wheel:''' The wheel you want to check. (0: front left, 1: rear left, 2: front right, 3: rear right)

===Returns===
Returns a [[int]] indicating the wheel friction state. This value can be:

* '''0:''' Normal friction
* '''1:''' Slip with acceleration (only for driving wheels)
* '''2:''' Slip without acceleration
* '''3:''' Locked wheel (on brake on handbrake).

==Example==
<section name="Client" class="client" show="true">
This example will show the friction state of each wheel of the player's current vehicle.

<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
local veh = getPedOccupiedVehicle(localPlayer)

if (not veh) then
return false
end

dxDrawRectangle(0, 0, 300, 140, tocolor(0, 0, 0, 150))
dxDrawText('FRICTION FRONT LEFT = ' .. getVehicleWheelFrictionState(veh, 0), 8, 10, 290, 40, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION FRONT RIGHT = ' .. getVehicleWheelFrictionState(veh, 2), 8, 40, 290, 70, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR LEFT = ' .. getVehicleWheelFrictionState(veh, 1), 8, 70, 290, 100, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR RIGHT = ' .. getVehicleWheelFrictionState(veh, 3), 8, 100, 290, 130, tocolor(255, 255, 255), 1.5)

end)</syntaxhighlight>
</section>

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

Template:Client vehicle functions

2021-01-01T21:33:04Z

IDannz: add getVehicleWheelFrictionState

*[[addVehicleUpgrade]]
{{New items|3.0158|1.5.7|
*[[areVehicleLightsOn]]
|19626}}
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getHeliBladeCollisionsEnabled]]
*[[getHelicopterRotorSpeed]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainPosition]]
*[[getTrainSpeed]]
{{New items|3.0160|1.6|
*[[getTrainTrack]]
|7485}}
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleComponentPosition]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentScale]]
*[[getVehicleComponentVisible]]
*[[getVehicleComponents]]
*[[getVehicleController]]
*[[getVehicleCurrentGear]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleGravity]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
{{New items|3.0157|1.5.6|
*[[getVehicleModelDummyPosition]]
|14403}}
*[[getVehicleModelExhaustFumesPosition]]
*[[getVehicleModelFromName]]
{{New items|3.0158|1.5.7|
*[[getVehicleModelWheelSize]]
|20642}}
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleNitroCount]]
*[[getVehicleNitroLevel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleSirenParams]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
{{Deprecated items|3.0156|1.5.6|
*[[getVehicleTurnVelocity]]
}}
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleUpgrades]]
*[[getVehicleVariant]]
{{New items|3.0158|1.5.7|
*[[getVehicleWheelScale]]
|20642}}
*[[getVehicleWheelStates]]
*[[isTrainChainEngine]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleNitroActivated]]
*[[isVehicleNitroRecharging]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
{{New items|3.0156|1.5.5|
*[[isVehicleWheelOnGround]]
|11854}}
*[[isVehicleWindowOpen]]
*[[removeVehicleUpgrade]]
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[resetVehicleComponentScale]]
*[[setHeliBladeCollisionsEnabled]]
*[[setHelicopterRotorSpeed]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainPosition]]
*[[setTrainSpeed]]
{{New items|3.0160|1.6|
*[[setTrainTrack]]
|7485}}
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentScale]]
*[[setVehicleComponentVisible]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleGravity]]
{{New items|3.0156|1.5.5|
*[[setVehicleHandling]]
|12009}}
*[[setVehicleHeadLightColor]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
{{New items|3.0157|1.5.6|
*[[setVehicleModelDummyPosition]]
|14403}}
*[[setVehicleModelExhaustFumesPosition]]
{{New items|3.0158|1.5.7|
*[[setVehicleModelWheelSize]]
|20642}}
*[[setVehicleNitroActivated]]
*[[setVehicleNitroCount]]
*[[setVehicleNitroLevel]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTaxiLightOn]]
{{Deprecated items|3.0156|1.5.6|
*[[setVehicleTurnVelocity]]
}}
*[[setVehicleTurretPosition]]
{{New items|3.0160|1.5.8|
*[[setVehicleVariant]]
|20693}}
{{New items|3.0158|1.5.8|
*[[getVehicleWheelFrictionState]]
|20726}}
{{New items|3.0158|1.5.7|
*[[setVehicleWheelScale]]
|20642}}
*[[setVehicleWheelStates]]
*[[setVehicleWindowOpen]]

<noinclude>[[ru:Template:RU/Client_vehicle_functions]]
[[Category:Functions templates]]</noinclude>

GetVehicleWheelFrictionState

2021-01-01T20:55:14Z

IDannz:

{{Client function}}
__NOTOC__
This function returns the current wheel friction state of the [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleWheelFrictionState ( vehicle theVehicle, int wheel )
</syntaxhighlight>

{{OOP||[[vehicle]]:getWheelFrictionState}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the wheel friction state.
*'''wheel:''' The wheel you want to check. (0: front left, 1: rear left, 2: front right, 3: rear right)

===Returns===
Returns a [[int]] indicating the wheel friction state. This value can be:

* '''0:''' Normal friction
* '''1:''' Slip with acceleration (only for driving wheels)
* '''2:''' Slip without acceleration
* '''3:''' Locked wheel (on brake on handbrake).

==Example==
<section name="Client" class="client" show="true">
This example will show the friction state of each wheel of the player's current vehicle.

<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
local veh = getPedOccupiedVehicle(localPlayer)

if (not veh) then
return false
end

dxDrawRectangle(0, 0, 300, 140, tocolor(0, 0, 0, 150))
dxDrawText('FRICTION FRONT LEFT = ' .. getVehicleWheelFrictionState(veh, 0), 8, 10, 290, 40, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION FRONT RIGHT = ' .. getVehicleWheelFrictionState(veh, 2), 8, 40, 290, 70, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR LEFT = ' .. getVehicleWheelFrictionState(veh, 1), 8, 70, 290, 100, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR RIGHT = ' .. getVehicleWheelFrictionState(veh, 3), 8, 100, 290, 130, tocolor(255, 255, 255), 1.5)

end)</syntaxhighlight>
</section>

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

GetVehicleWheelFrictionState

2021-01-01T20:54:16Z

IDannz: add GetVehicleWheelFrictionState

{{Client function}}
__NOTOC__
Returns the current wheel friction state of the [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleWheelFrictionState ( vehicle theVehicle, int wheel )
</syntaxhighlight>

{{OOP||[[vehicle]]:getWheelFrictionState}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the wheel friction state.
*'''wheel:''' The wheel you want to check. (0: front left, 1: rear left, 2: front right, 3: rear right)

===Returns===
Returns a [[int]] indicating the wheel friction state. This value can be:

* '''0:''' Normal friction
* '''1:''' Slip with acceleration (only for driving wheels)
* '''2:''' Slip without acceleration
* '''3:''' Locked wheel (on brake on handbrake).

==Example==
<section name="Client" class="client" show="true">
This example will show the friction state of each wheel of the player's current vehicle.

<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
local veh = getPedOccupiedVehicle(localPlayer)

if (not veh) then
return false
end

dxDrawRectangle(0, 0, 300, 140, tocolor(0, 0, 0, 150))
dxDrawText('FRICTION FRONT LEFT = ' .. getVehicleWheelFrictionState(veh, 0), 8, 10, 290, 40, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION FRONT RIGHT = ' .. getVehicleWheelFrictionState(veh, 2), 8, 40, 290, 70, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR LEFT = ' .. getVehicleWheelFrictionState(veh, 1), 8, 70, 290, 100, tocolor(255, 255, 255), 1.5)
dxDrawText('FRICTION REAR RIGHT = ' .. getVehicleWheelFrictionState(veh, 3), 8, 100, 290, 130, tocolor(255, 255, 255), 1.5)

end)</syntaxhighlight>
</section>

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

DxDrawWiredSphere

2020-10-29T17:10:36Z

IDannz: /* Example */

__NOTOC__
{{Client function}}
This function drawn same sphere as /showcol. It provides 4 levels of iterations which mean density of sphere. Adjust radius to iterations to get optimum density of mesh. About 50 spheres with iterations = 4 can cause fps drop.

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawWiredSphere( float x, float y, float z, float radius, color theColor, float fLineWidth, uint iterations )
</syntaxhighlight>

===Required Arguments===
* '''x, y, z:''' A position in world of sphere.
* '''radius:''' A radius of sphere.
* '''theColor:''' A color of sphere from tocolor function.
* '''fLineWidth:''' A width of line
* '''iterations :''' Number 1, 2, 3 or 4. 1 mean low density, 4 mean high.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local BONE_IDS = {1, 2, 3, 4, 5, 6, 7, 8, 21, 22, 23, 24, 25, 26, 31, 32, 33, 34, 35, 36, 41, 42, 43, 44, 51, 52, 53, 54}

addEventHandler('onClientRender', root, function()
for k, v in ipairs(BONE_IDS) do
local x, y, z = getPedBonePosition(localPlayer, v)
local color = tocolor(math.random(0, 255), math.random(0, 255), math.random(0, 255), math.random(0, 255))
dxDrawWiredSphere(x, y, z, 0.1, color, 0.1, 4)
end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.7-9.20328|}}

==See Also==
{{Drawing_functions}}
[[dxDrawWiredSphere]]

Resource:Object preview

2020-08-07T19:45:21Z

IDannz: /* setProjection */

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX, rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the object be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should the object be drawin to second render target.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosX, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget()</syntaxhighlight>
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Example==
<syntaxhighlight lang="lua">
local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (416, x1, y1, z1)

myObject = exports.object_preview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)

bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)

bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
exports.object_preview:setRotation(myObject, unpack(myRotation));
end, true, "high" )
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

Of course when you want to use these functions in your resources you have to include
the object_preview resource in meta.

==See Also==

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=11836 Object Preview resource on community]

Where to buy GTASA

2020-06-07T20:17:15Z

IDannz: removing not working links (GameFly and Walmart)

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

Resource:Editor

2020-04-28T15:51:28Z

IDannz: replaced old bugtracker to github issues and irc to discord link

{{Resource page}}
The MTA:SA map editor allows you to create maps for gamemodes.

==Starting==
To start the editor, simply click the "Map editor" menu item in the main MTA menu.

==Menus==
Once the editor has started, you are presented with two menu bars: the main menu at the top, and the element menu in the lower left.

===Main menu===
These are the buttons in the main menu:
* [[Image:Editor_New.png]] Create a new map.
* [[Image:Editor_Open.png]] Open an existing map.
* [[Image:Editor_Save.png]] Save the map you're working on.
* [[Image:Editor_Save_as.png]] Save your map under a different name.
* [[Image:Editor_Options.png]] Alter general map editor settings.
* [[Image:Editor_Undo.png]] Undo the last action.
* [[Image:Editor_Redo.png]] Restore the last undone action.
* [[Image:Editor_Locations.png]] Stored game world locations. The editor comes with a great list of San Andreas Interior locations but you can also add your own interior and non-interior locations to the list.
* [[Image:Editor_Current_elements.png]] List all the elements the map contains (objects, vehicles, markers, pickups etc.)
* [[Image:Editor_Map_settings.png]] Map specific settings, like time of day, gravity etc. Here you can also specify what gamemodes the map is compatible with.
* [[Image:Editor_Definitions.png]] Load [[Resource:Editor/EDF|editor definition files (EDF)]] that you want to use.
* [[Image:Editor_Test.png]] Go into play mode to try out the map. This will load up the gamemode the map is made for.

===Element menu===
The element menu is used to add new elements to the map.
* [[Image:Editor_Vehicle.png]] Create a new vehicle.
* [[Image:Editor_Object.png]] Create a new object (buildings, roads and other scenery).
* [[Image:Editor_Pickup.png]] Create a new pickup (health, armor, weapons and custom).
* [[Image:Editor_Marker.png]] Create a new marker (checkpoint, ring, cylinder, arrow and corona).
* [[File:Crosshair.png‎]] Select world object.
Additionally, if you have [[Resource:Editor/EDF|editor definitions loaded]], you can roll the mousewheel in this menu to bring up custom elements.

==Using the editor==
This section explains how to create and modify maps.

===Moving around the map===
When you initially start the editor, you are in ''camera mode''. You are able to use the '''WSAD''' keys to move the camera and the mouse to pan the camera. While moving around, you can hold '''ALT''' to move more slowly or '''SHIFT''' to go faster.

To access the editor's interface and control panel you need to switch to ''cursor mode''. You can toggle between cursor mode and camera mode with the '''F''' key. When in cursor mode, your view is fixed, and you can use the mouse cursor to manipulate elements and use the graphical interface.

Camera mode can be recognized by a crosshair in the center of the screen. You can use it to select and move elements just like in cursor mode.

[[Image:Editor_Crosshair.png|center]]

===Starting a new map===
* Start the editor, or if it is already started, click the ''New'' menu button.
* Click the ''Map settings'' button. In the ''Meta'' tab, fill in the Name and Author fields with the name of the map and your name respectively. Also open the ''Gamemodes'' tab and add the gamemodes your map is meant for (they will be moved to the ''Added gamemodes'' list). You can do this by selecting them and clicking ''Add'', or by double clicking them. Click OK when you're done.
[[Image:Editor_Mapsettings.png|center]]
* Click the ''Definitions'' window and add the resources of which you want to use the custom elements. These will consist of the gamemodes you selected in the ''Map settings'' window, plus eventual additional resources. For more information about editor definitions, see [[Resource:Editor/EDF|EDF]]. Click OK when you're done.

===Creating new elements===
Adding elements to your map, such as vehicles and objects, is very straightforward.
* If you are in camera mode, switch to cursor mode first by pressing '''F'''.
* Click the button in the element menu that represents what you want. E.g., click the button with a car on it to add a vehicle.
* A new element of the selected type will be created and attached to your cursor. Move it to the location where you want it and '''left click''' to drop it off.

[[Image:Editor_Addelem.png|center]]

To create custom elements that are specific to a resource, hover the cursor over the element menu and turn the scroll wheel until the desired resource comes up. Note that for this to work, you first have to add the [[Resource:Editor/EDF|EDF]] file of the resource in the ''Definitions'' window.

[[Image:Editor_Selectedf.png|center]]

===Selecting===
* '''Left click''' an element to select it in ''keyboard mode''.
* '''Right click''' it to select it in ''mouse mode''.
* Press the '''Spacebar''' or click in an empty area to deselect.

The selected element, if any, is denoted by a yellow cone marker. Elements (particularly objects) with poor collisions can be detected easier by enabling ''High sensitivity mode'', by pressing the '''E''' key. This increases detection at the expense of accuracy.

The ''Current elements'' dialog can also be used to select elements. Double-clicking an item within the list will select it in ''Keyboard mode''.

===Moving===
Moving elements can be done in several ways.

'''With the mouse'''
* Simply drag and drop with the '''left mouse button'''.
Or:
* Select the element in mouse mode ('''right click'''), move it to where you want it, and click to drop it off.

You can also adjust the ''Hold distance'' of an element toward and away from the camera by switching to camera mode, '''right clicking''' the element, and rolling the '''mouse wheel'''.

'''With the keyboard'''
* Select the element in keyboard mode ('''left click''').
* Use the '''arrow keys''' to move the element in the horizontal plane, and '''PgUp'''/'''PgDn''' to move it vertically. Hold '''ALT''' to decrease the movement speed, or '''SHIFT''' to increase it.

By default, elements move relative to the camera and are not locked to any axes. This can be disabled in the ''Options'' menu.

===Rotating===
'''With the mouse'''

You can rotate selected elements around the Z axis with the mouse wheel.
* Select the element in keyboard mode ('''left click''') and roll the mouse wheel while holding '''Left CTRL'''.
Or:
* Select the element in mouse mode ('''right click'''), hold '''CTRL''', and roll the mouse wheel.

'''With the keyboard'''
* Select the element in keyboard mode ('''left click''').
* While holding '''CTRL''' (the selection marker will turn green), use the '''arrow keys''' and '''PgUp'''/'''PgDn''' to rotate the element around the different axes.

With both methods you can additionally hold '''ALT''' to decrease the rotation speed or '''SHIFT''' to increase it.

[[Image:Editor_Rotateelem.png|center]]

===Changing model and other properties===
Most elements have a variety of options that can be altered to change their appearance and behaviour. Examples are the model, color and visual upgrades of a car.

* Open the properties window of an element by either double clicking it or by selecting it and pressing '''F3'''.
* Make any alterations that you want. For example, to change the model of a car or object, click the '''Browse''' button next to "model" to open the model browser.
* Click OK when you're done.

[[Image:Editor_Props.png|center]]

===Cloning===
You can clone an element by selecting it and pressing '''C'''.

* In mouse mode the cloned element will be attached to your cursor. '''Left click''' to place it in the map.
* In keyboard mode the cloned element will be cloned in the identical position.

If you hold '''CTRL''' while clicking, the element will be cloned again and will again be attached to the cursor. This way you can easily place large quantities of something.

Alternatively you can use the ''Pullout'' button located in the bottom-right corner of the properties box to clone an element.

===Deleting===
Simply select the element and press '''DEL''' ''(Delete)''.

Alternatively you can use the ''Pullout'' button located in the bottom-right corner of the properties box to delete an element.

==Creating maps for specific gamemodes==
To make a map for a specific gamemode, you have to do two things:
* Click the '''Map Settings''' button in the top menu, go to the '''Gamemodes''' tab and add any gamemodes that your map is to be used with.
* You will likely also need to add one or more [[Resource:Editor/EDF|Editor Definition Files]]. These will allow you to place gamemode specific elements in the map, like spawnpoints, race checkpoints, or CTF flags. You can add EDF's by clicking the '''Definitions''' menu button and adding the relevant gamemodes.

==Controls==
Here is a list of all default controls. To change them please go to the MTA Settings menu while the Editor is started.

===Camera===
{|
|-
| camera_move_forwards
| '''w'''
|-
| camera_move_backwards
| '''s'''
|-
| camera_move_left
| '''a'''
|-
| camera_move_right
| '''d'''
|-
| high_sensitivity_mode
| '''e'''
|}

===Cloning===
{|
|-
| clone_selected_element
| '''c'''
|-
| clone_drop_modifier
| '''lctrl''' || ''(Left CTRL)''
|}

===Element manipulation===
{|
|-
| element_move_forward
| '''arrow_u''' || ''(Arrow key Up)''
|-
| element_move_backward
| '''arrow_d''' || ''(Arrow key Down)''
|-
| element_move_left
| '''arrow_l''' || ''(Arrow key Left)''
|-
| element_move_right
| '''arrow_r''' || ''(Arrow key Right)''
|-
| element_move_downwards
| '''pgdn''' || ''(Page Down)''
|-
| element_move_upwards
| '''pgup''' || ''(Page Up)''
|-
| zoom_in
| '''mouse_wheel_down'''
|-
| zoom_out
| '''mouse_wheel_up'''
|-
| quick_rotate_increase
| '''mod_rotate''' + '''mouse_wheel_up''' || ''(Left CTRL + Mouse wheel Up)''
|-
| quick_rotate_decrease
| '''mod_rotate''' + '''mouse_wheel_down''' || ''(Left CTRL + Mouse wheel Down)''
|-
| mod_rotate
| '''lctrl''' || ''(Left CTRL)''
|-
| mod_slow_speed
| '''lalt''' || ''(Left ALT)''
|-
| mod_fast_speed
| '''lshift''' || ''(Left SHIFT)''
|-
| destroy_selected_element
| '''delete'''
|-
| drop_selected_element
| '''space'''
|-
| pickup_selected_element
| '''F2'''
|-
| reset_rotation
| '''mod_rotate''' + '''r''' || ''(Left CTRL + R)''
|}

===GUI===
{|
| toggle_gui_display
| '''F4'''
|-
| toggle_cursor
| '''f'''
|-
| select_target_keyboard
| '''mouse1''' || ''(Left Mouse button)''
|-
| select_target_mouse
| '''mouse2''' || ''(Right Mouse button)''
|-
| edf_next
| '''mouse_wheel_up'''
|-
| edf_prev
| '''mouse_wheel_down'''
|-
| undo
| '''Ctrl''' + '''z'''
|-
| redo
| '''Ctrl''' + '''y'''
|-
| properties_toggle
| '''F3'''
|-
| browser_up
| '''arrow_u''' || ''(Arrow key Up)''
|-
| browser_down
| '''arrow_d''' || ''(Arrow key Down)''
|-
| browser_zoom_in
| '''mouse_wheel_up'''
|-
| browser_zoom_out
| '''mouse_wheel_down'''
|-
| browser_confirm
| '''enter'''
|-
| currentelements_up
| '''num_8''' || ''(Numpad key 8)''
|-
| currentelements_down
| '''num_2''' || ''(Numpad key 2)''
|-
| toggle_test
| '''F5'''
|}

==Multiplayer==
The editor is built with both serverside and clientside components, and therefore supports multiplayer out of the box. To use the editor in multiplayer with other players, simply copy all of the editor's resources into your server, start the '''editor''' resource and allow other players to join.

Please note that currently the editor lacks any permissions system, so all users have access to every function.

==Plugins & External resources==
{{Main|Resource:Editor/Plugins}}

The editor allows basic importing of elements from external resources. This is useful for resources that may have to manipulate an element in a specific way that cannot be performed by the editor. For example, a map resource which uses custom models (and has a script to import these models) cannot be manipulated by default within the editor.

By using the '''import <resourceName>''' command in console the resource's elements can be imported within the editor.

==FAQ==
==== I get a black screen when launching the Map Editor ====

Usually this is caused due to incorrect installation of Map Editor resources. If you are using a stable MTASA client, please install it again and make sure that you use Client and Server install option.

If you are using a nightly build, to get it working right you need to download latest [https://github.com/multitheftauto/mtasa-resources resources (step 3)], unpack the archive and put its contents in:
''MTA San Andreas\server\mods\deathmatch\resources'' , where ''MTA San Andreas'' is a folder where you've installed MTA San Andreas (default location: C:\Program Files\MTA San Andreas).

Putting them in this path: MTA San Andreas\mods\deathmatch\resources '''is a common mistake''' - it won't work if you put them there. So make sure to put them in the ''italic'' path above.

If this issue still occurs, even when you've checked the note above and verified that you've installed it correctly, it might be because you've got an outdated '''acl.xml''' file. You can find the default one [https://github.com/multitheftauto/mtasa-blue/blob/master/Server/mods/deathmatch/acl.xml here]. It should be placed in '''server/mods/deathmatch/''' in your MTA: San Andreas installation directory.

==== I get an "Could not start the local server. See console for details" when using the "Map Editor" button ====
This is because you do not have a valid editor.conf installed. You can find the default one [https://github.com/multitheftauto/mtasa-blue/blob/master/Server/mods/deathmatch/editor.conf here]. It should be placed in '''server/mods/deathmatch/''' in your MTA: San Andreas installation directory.

==== I have saved a map but cannot find it in my server's resources directory, despite the Editor itself being able to see it ====
This is due to the fact that Vista/7 limits write-access for non-admin processes in Program Files directory. Files get written in the "VirtualStore" directory instead of real Program Files folder. You should be able to locate your map resource in a similar directory to:
C:\Users\<USERNAME>\AppData\Local\VirtualStore\Program Files\MTA San Andreas\server\mods\deathmatch\resources\

Running the Server/MTA San Andreas with Administrative rights will allow the map to be saved to the proper location.

==== I have some other problem with the map editor ====

Sometimes resetting the map editor will solve certain issues. The easiest way to do that is install MTA:SA to a brand new folder. Otherwise you can try the following steps:
::1. Go to the resources folder, '''server/mods/deathmatch/resources/''' and delete the '''editor_dump''' directory
::2. Go to the resources folder, '''server/mods/deathmatch/resources/''' and delete the '''editor_test''' directory

==== I have found a bug or have a suggestion/feedback for the map editor ====
Please use the official [https://github.com/multitheftauto/mtasa-blue/issues github issues] for reporting bugs. Feel free to also join us on [http://www.mtasa.com/discord Discord].

[[hu:Resource:Editor]]
[[ru:Resource:Editor]]
[[es:Resource:Editor]]

GetEventHandlers

2020-04-28T05:33:10Z

IDannz: /* Example */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0140|1.4|4973|
This function gets the attached functions from the event and attached element from current lua script.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getEventHandlers ( string eventName, element attachedTo )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event. For example ( "onPlayerWasted" ).
*'''attachedTo:''' The [[element]] attached to.

===Returns===
Returns table with attached functions, empty table otherwise.

===Example===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isEventHandlerAdded( sEventName, pElementAttachedTo, func )
if type( sEventName ) == 'string' and isElement( pElementAttachedTo ) and type( func ) == 'function' then
local aAttachedFunctions = getEventHandlers( sEventName, pElementAttachedTo )
if type( aAttachedFunctions ) == 'table' and #aAttachedFunctions > 0 then
for i, v in ipairs( aAttachedFunctions ) do
if v == func then
return true
end
end
end
end
return false
end

function onPlayerWasted()
outputChatBox( getPlayerName( source ) .. ' died.' )
end
addEventHandler( 'onPlayerWasted', root, onPlayerWasted )

addCommandHandler( 'removeOnPlayerWastedEvent', function()
if isEventHandlerAdded( 'onPlayerWasted', root, onPlayerWasted ) then
outputChatBox( 'onPlayerWasted succesfully removed!' )
removeEventHandler( 'onPlayerWasted', root, onPlayerWasted )
end
end)
</syntaxhighlight>
</section>

==See also==
{{Event functions}}

PT-BR/Resource:Editor-EDF

2020-03-07T00:04:05Z

IDannz:

{{PT-BR/Recursos}}
{{BR/Warning|Este artigo necessita de revisão, pois está '''incompleto'''.|true}}
__NOTOC__
EDF significa ''Editor Definition File'' ou ''Arquivo de Definições do Editor''. Ele é um arquivo XML com a extensão .edf e define elementos customizados usados pelo recurso. Em outras palavras, um elemento não reconhecível pelo MTA. Exemplos são <spawnpoints>, <bandeiras> e <checkpoints>. Ele também adiciona configurações do mapa específicas a cada recurso - salvos na tag designada no arquivo meta.

==Introdução==
Alguns recursos usam elementos customizados. Por exemplo, o ''Capture The Flag'' usa <bandeiras> para posicionar no mapa e indicar de qual time é. Quando o mapa é carregado, este modo de jogo irá procurar por qualquer elemento do tipo <flag> (bandeira) no seu arquivo .map, para por exemplo, criar um objeto no formato de uma bandeira e um colisor em torno dele.

O problema é que esses elementos customizados não podem estar inclusos no MTA, consequentemente, o editor não faz a menor ideia da existência deles. Então ele precisa de um arquivo EDF definindo como uma <bandeira> deve ser visualmente representada: Como ela deve aparecer no mapa? Qual é o ID do objeto? Quais são suas possíveis propriedades (seu time, por exemplo)? Se não for feito isso, o editor não poderá fazer nada sozinho e o usuário terá de editar o arquivo .map manualmente - algo que dá '''muito''' trabalho. Mas felizmente esse sistema é disponibilizado aos recursos e facilita a vida. Nada que pensar um pouco, não é?

[[en:Resource:Editor/EDF]]
<!--
==Using definition files in the editor==
As described in the [[Resource:Editor|main editor manual]], to be able to create the custom elements of a resource in your map you need to add it in the ''Definitions'' window. Click the ''Definitions'' button in the main menu and double click the resource in the left list. Then close the window and roll the mousewheel in the element panel until the resource comes up. At that point you can create and manipulate custom elements of that resource like any other element.

==Writing EDF files==
EDF files are simply XML files with an .edf extension. We'll start with an example: the EDF of the Capture the Orb gamemode.

<syntaxhighlight lang="xml">
<def name="Capture the Orb">
<element name="orb" friendlyname="Orb spawnpoint" instructions="Place your orb in a position that can be collected.">
<data name="position" type="coord3d" default="0,0,0" />
<marker size="0.5" type="corona" color="#ffff00ff" />
</element>
<element name="objective" friendlyname="Objective point" instructions="Place your objective point in a position that can be reached.">
<data name="position" type="coord3d" default="0,0,0" />
<marker size="3" type="cylinder" color="#9370dbaa" />
</element>
<element name="spawnpoint" friendlyname="Spawnpoint">
<object editorOnly="true" model="3092" posZ="1" />
<data name="position" type="coord3d" default="0,0,0" />
<data name="rotation" type="coord3d" default="0,0,0" />
<data name="skin" type="skinID" default="0" />
</element>
</def>
</syntaxhighlight>

As you can see, the syntax is fairly straightforward. The root element, <def>, contains a number of <element>s. Each of these <element>s describes a custom element and specifies its name, visual representation and available properties.

===Visual representation===

Any child node of an <element> that is not a <data> node is part of the visual representation. There can be one or more objects, markers, pickups etc. For each representation element you can optionally specify a position (posX, posY, posZ) and rotation (rotX, rotY, rotZ): these are ''relative'' to the position and rotation of the represented custom element. Using the above Capture the Orb example, if you were to create a spawnpoint at (30, 14, 3), the editor would display an object of model 3092 at (30, 14, 4) to represent it, because the object's posZ of 1 is added to the spawnpoint's z position of 3.

===Properties===

Properties of a custom element are described by <data> nodes. Some property names have a special meaning, like ''position'' and ''rotation'': these can be changed by moving and rotating the element in the editor. The other properties can be changed in the Properties window.

===Property-dependent visual representation===

It is possible to make the representation of a custom element depend on one or more of the element's properties. Take as example a <checkpoint> element of a race gamemode that contains a <marker> for representation: the checkpoint has several attributes like color and size that should be reflected in the marker. To accomplish this, specify something of the form ''!propertyname!'' in one or more of the representing element's attributes. For example:

<syntaxhighlight lang="xml">
<def name="Race">
<element name="checkpoint" friendlyname="Race checkpoint">
<data name="position" type="coord3d" required="true" default="0,0,0" />

<data name="type" type="selection:checkpoint,ring" required="true" default="checkpoint" />
<data name="size" type="number" required="true" default="2.25"/>
<data name="color" type="color" required="false" default="#ff0000ff" />
...

<marker type="!type!" size="!size!" color="!color!" />
</element>
</def>
</syntaxhighlight>

Now whenever the "type", "size" or "color" property of a checkpoint is changed, the new value will be copied to its marker, and the marker's visual appearance changes accordingly.

===Integrating in a resource===

Once you've written your EDF, save it as an .edf file in your resource's folder and add an "edf:definition" attribute to your meta.xml's <info> tag, like so:

<syntaxhighlight lang="xml">
<meta>
<info author="erorr404" type="gamemode" ... edf:definition="cto.edf" />
...
</meta>
</syntaxhighlight>

==EDF reference==

===Built-in elements===
These are the elements you can use for representing your custom elements, along with their properties.

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <blip>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|icon
| style="background-color: #EEE"|blipID
|-
| style="background-color: #EEE"|size
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|color
| style="background-color: #EEE"|color
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <marker>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|type
| style="background-color: #EEE"|markerType
|-
| style="background-color: #EEE"|size
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|color
| style="background-color: #EEE"|color
|-
| style="background-color: #EEE"|interior
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <object>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|model
| style="background-color: #EEE"|objectID
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|rotation
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|interior
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <ped>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|model
| style="background-color: #EEE"|skinID
|-
| style="background-color: #EEE"|rotZ
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|interior
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <pickup>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|type
| style="background-color: #EEE"|pickupType
|-
| style="background-color: #EEE"|amount
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|respawn
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|interior
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <vehicle>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|model
| style="background-color: #EEE"|vehicleID
|-
| style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|rotation
| style="background-color: #EEE"|coord3d
|-
| style="background-color: #EEE"|color
| style="background-color: #EEE"|vehiclecolors
|-
| style="background-color: #EEE"|upgrades
| style="background-color: #EEE"|vehicleupgrades
|-
| style="background-color: #EEE"|plate
| style="background-color: #EEE"|plate
|-
| style="background-color: #EEE"|interior
| style="background-color: #EEE"|integer
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

{| cellspacing="1"
! style="background-color: #EEE" colspan="2" | <radararea>
|-
! style="background-color: #EEE"|Property
! style="background-color: #EEE"|Type
|-
| style="background-color: #EEE"|posX
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|posY
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|sizeX
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|sizeY
| style="background-color: #EEE"|number
|-
| style="background-color: #EEE"|color
| style="background-color: #EEE"|color
|-
| style="background-color: #EEE"|dimension
| style="background-color: #EEE"|integer
|}

===Built-in property names===
Properties with these names have a special meaning to the editor and can be modified by other means than the Properties window.
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Type
|-
! style="background-color: #EEE"|position
| style="background-color: #EEE"|coord3d
|-
! style="background-color: #EEE"|rotation
| style="background-color: #EEE"|coord3d
|}

===Property types===
These are the types you can choose from for the properties (<data>) of your custom elements.

====Primitives====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|boolean
| style="background-color: #EEE"|Simple boolean value.
| style="background-color: #EEE"|"true" or "false"
|-
! style="background-color: #EEE"|natural
| style="background-color: #EEE"|Natural number (whole and non-negative).
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|integer
| style="background-color: #EEE"|Whole number.
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|number
| style="background-color: #EEE"|Rational number.
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|string
| style="background-color: #EEE"|Simple string of text.
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|color
| style="background-color: #EEE"|color, with or without alpha.
| style="background-color: #EEE"|#RRGGBB or #RRGGBBAA
|}

====Coordinates====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|camera
| style="background-color: #EEE"|Position and lookat coordinates for the camera.
| style="background-color: #EEE"|posX,posY,posZ,lookatX,lookatY,lookatZ
|-
! style="background-color: #EEE"|coord3d
| style="background-color: #EEE"|3-component vector, typically used for positions and rotations.
| style="background-color: #EEE"|x,y,z
|}

====Vehicles====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|plate
| style="background-color: #EEE"|Number plate text for a vehicle.
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|vehiclecolors
| style="background-color: #EEE"|colors of a vehicle
| style="background-color: #EEE"|colorID1,colorID2,colorID3,colorID4
|-
! style="background-color: #EEE"|vehicleupgrades
| style="background-color: #EEE"|Upgrades of a vehicle
| style="background-color: #EEE"|upgradeID1,upgradeID2,...
|}

====Model ID's====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|blipID
| style="background-color: #EEE"|Picture ID for blips
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|objectID
| style="background-color: #EEE"|Model ID for objects
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|pickupType
| style="background-color: #EEE"|Armor, health or weapon
| style="background-color: #EEE"|"armor", "health" or numeric weapon ID
|-
! style="background-color: #EEE"|skinID
| style="background-color: #EEE"|Skin ID for peds
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|vehicleID
| style="background-color: #EEE"|Model ID for vehicles
| style="background-color: #EEE"| 
|-
! style="background-color: #EEE"|weaponID
| style="background-color: #EEE"|Weapon, e.g. M4
| style="background-color: #EEE"|Numeric weapon ID, e.g. 31
|}

====Colshapes and markers====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|colshapeType
| style="background-color: #EEE"|collision circle, cube, rectangle, sphere or tube
| style="background-color: #EEE"|One of: "colcircle", "colcube", "colrectangle", "colsphere", "coltube"
|-
! style="background-color: #EEE"|markerType
| style="background-color: #EEE"|Arrow, checkpoint, corona, cylinder or ring marker.
| style="background-color: #EEE"|One of: "arrow", "checkpoint", "corona", "cylinder", "ring"
|-
|}

====Specials====
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Description
! style="background-color: #EEE"|Value
|-
! style="background-color: #EEE"|element:type
| style="background-color: #EEE"|Element of a certain type, for example: element:flag
| style="background-color: #EEE"|The element's ID
|-
! style="background-color: #EEE"|selection:val1,val2,...
| style="background-color: #EEE"|Shows a dropdown box from which to pick one value.
| style="background-color: #EEE"|The selected value
|}
[[ru:Resource:Editor/EDF]]

PT-BR/Resource:Editor-Plugins

2020-03-07T00:03:14Z

IDannz:

{{PT-BR/Recursos}}
{{BR/Warning|Este artigo necessita de revisão, pois está '''incompleto'''.|true}}
== Introdução ==
O editor oferece funções e comandos para interagir com recursos externos. Normalmente ao criar um elemento ou realizar ações fora do editor não permitem que isso possa ser gerenciado por ele. É como se o Editor fosse cego e o elemento ali criado não fosse visto por ele - portanto, não clicável. Entretanto, ao importar elementos, o editor os fazem compatíveis com ele e assim poderão ser manipulados pelo usuário através de sua interface - além de salva-los no arquivo .map. Na prática isso significa desenvolvimento de ''plugins'' ou extensões.

== Comandos ==
O comando "import" foi criado pelo editor para permitir usuários importarem elementos de um recurso especificado:

<syntaxhighlight lang="lua">import <nome-do-recurso></syntaxhighlight>
* '''nome-do-recurso:''' É o nome do qual você deseja importar.

Assim, os elementos do recurso serão importados. Um exemplo disso seria importar modelos customizados. Enquanto o editor não é capaz de realizar esta ação sozinho, seu recurso pode fazer isso por ele, e importar as coordenadas desse objeto - criando um mapa mais customizado ainda. Um exemplo prático abaixo seria fazer isso com o mapa ''sth-aztec'':

* Inicie o editor
* Inicie (mas não abra no Editor) o sth-aztec. Isso irá iniciar o mapa e carregar automaticamente os modelos customizados, pois no script dele já contém as instruções para isso.
* Digite "import sth-aztec" e os objetos do mapa serão importados ao editor
* Agora o mapa com os objetos customizados carregarão

<!--
== Functions ==
The '''editor''' resource also exports an ''import'' function. This replicates the command, but also allows importing element datatypes. Essentially this allows resources to have control over importing without having to have permission from the editor itself..

<syntaxhighlight lang="lua">bool import ( element rootElement/resource resourceToImportFrom )</syntaxhighlight>
* '''rootElement:''' The root element of which you wish to import (The root itself and all children will be imported)
<p>'''OR:'''
* '''resourceToImportFrom:''' The resource pointer of which you wish to import.

== Editor plugins ==
====Editor Loop Generator====
[[Image:LoopGenerator.jpg|thumb|Loop generator working with the editor.|400x250px]]
An example use for this is the loop generator plugin, adapted from Offroader23's work on ''offedit''.

This resource adds custom gui which can be used to create perfect loops out of standard objects. After perfoming this, it uses the exported ''import'' function and allows the editor to manipulate them.

Download no longer available, hosted site closed.

====Editor racemap loader====
This plugin will load objects from your race maps without the need for conversion.

Download no longer available, hosted site closed.

====Roller Coaster Generator====
With this plugin, you can create easily roller coaster like maps.
[[Roller Coaster Generator|Learn more by clicking here.]]
[[ru:Resource:Editor/Plugins]]

====Object Movement Generator====
An attempt to help some people create moving objects (using moveObject function) more easily.

Download [http://community.mtasa.com/index.php?p=resources&s=details&id=1224 here]

Template:Client element functions

2020-03-06T18:21:57Z

IDannz:

*[[attachElements]]
*[[createElement]]
*[[destroyElement]]
*[[detachElements]]
*[[getAttachedElements]]
*[[getElementAlpha]]
*[[getElementAttachedOffsets]]
*[[getElementAttachedTo]]
*[[getElementBoundingBox]]
*[[getElementByID]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementColShape]]
*[[getElementCollisionsEnabled]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementDistanceFromCentreOfMassToBaseOfModel]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementModel]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRadius]]
*[[getElementRotation]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getElementsByType]]
*[[getElementsWithinColShape]]
{{New items|3.0156|1.5.5|
*[[getElementsWithinRange]]
|13823}}
*[[getLowLODElement]]
*[[getRootElement]]
*[[isElement]]
*[[isElementAttached]]
*[[isElementCallPropagationEnabled]]
*[[isElementCollidableWith]]
*[[isElementDoubleSided]]
*[[isElementFrozen]]
*[[isElementInWater]]
*[[isElementLocal]]
*[[isElementLowLOD]]
*[[isElementOnScreen]]
*[[isElementStreamable]]
*[[isElementStreamedIn]]
*[[isElementSyncer]]
*[[isElementWaitingForGroundToLoad]]
*[[isElementWithinColShape]]
*[[setElementAlpha]]
{{New items|3.0156|1.5.5|
* [[setElementAngularVelocity]]
* [[getElementAngularVelocity]]
|14165}}
*[[setElementAttachedOffsets]]
*[[setElementCallPropagationEnabled]]
*[[setElementCollidableWith]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementDoubleSided]]
*[[setElementFrozen]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementInterior]]
*[[setElementMatrix]]
*[[setElementModel]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementRotation]]
*[[setElementStreamable]]
*[[setElementVelocity]]
*[[setLowLODElement]]
<noinclude>[[Category:Functions templates]]</noinclude>

SetElementMatrix

2020-03-06T17:56:42Z

IDannz:

{{Shared function}}
{{Needs_Example}}
__NOTOC__
This function sets matrix to element.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementMatrix ( element theElement, table theMatrix )
</syntaxhighlight>
{{OOP||[[element]]:setMatrix|matrix|getElementMatrix}}

===Required Arguments===
*'''theElement:''' The element which you set matrix
*'''theMatrix:''' The matrix.

===Returns===
Returns ''true'' if the matrix was set succesfully, ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04485|}}

==See Also==
{{Client_element_functions}}

GetNearestVehicle

2020-03-03T17:56:18Z

IDannz: /* Code */

{{Useful Function}}
==Syntax==
<syntaxhighlight lang="lua">vehicle getNearestVehicle( element thePlayer )</syntaxhighlight>
===Required Arguments===
* '''thePlayer''': The player you want to get the nearest vehicle of.

===Returns===
Return a vehicle element if success, false if there's no vehicles in a 10meter circle..
==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestVehicle(player,distance)
local lastMinDis = distance-0.0001
local nearestVeh = false
local px,py,pz = getElementPosition(player)
local pint = getElementInterior(player)
local pdim = getElementDimension(player)

for _,v in pairs(getElementsByType("vehicle")) do
local vint,vdim = getElementInterior(v),getElementDimension(v)
if vint == pint and vdim == pdim then
local vx,vy,vz = getElementPosition(v)
local dis = getDistanceBetweenPoints3D(px,py,pz,vx,vy,vz)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestVeh = v
end
end
end
end
return nearestVeh
end

</syntaxhighlight></section>

{{Useful_Functions}}

AclGetGroup

2019-12-07T15:53:52Z

IDannz: /* Returns */

__NOTOC__
{{Server function}}

This function is used to get the ACL group with the given name. If you need most of the groups you should consider using [[aclGroupList]] instead to get a table containing them all.

==Syntax==

<syntaxhighlight lang="lua">
aclgroup aclGetGroup ( string groupName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the ACL Group class.|[[aclgroup|ACLGroup]].get||}}
===Required Arguments===

*'''groupName:''' The name to get the ACL group from

===Returns===

Returns the ACL group if it could be found. Returns false/nil if it did not exist or failed for some reason.

==Example==

'''Example 1:''' This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group.
<syntaxhighlight lang="lua">
function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
if accountName then --if there was an accountName entered then
aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
else --else output an error message and the correct syntax of the command to the player who entered it
outputChatBox ("No account name specified.", playerSource)
outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it
</syntaxhighlight>

'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
<syntaxhighlight lang="lua">
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
</syntaxhighlight>

==See Also==

{{ACL_functions}}

AclGetGroup

2019-12-07T15:53:37Z

IDannz: /* Returns */

__NOTOC__
{{Server function}}

This function is used to get the ACL group with the given name. If you need most of the groups you should consider using [[aclGroupList]] instead to get a table containing them all.

==Syntax==

<syntaxhighlight lang="lua">
aclgroup aclGetGroup ( string groupName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the ACL Group class.|[[aclgroup|ACLGroup]].get||}}
===Required Arguments===

*'''groupName:''' The name to get the ACL group from

===Returns===

Returns the ACL group if it could be found. Returns 'false'/'nil' if it did not exist or failed for some reason.

==Example==

'''Example 1:''' This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group.
<syntaxhighlight lang="lua">
function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
if accountName then --if there was an accountName entered then
aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
else --else output an error message and the correct syntax of the command to the player who entered it
outputChatBox ("No account name specified.", playerSource)
outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it
</syntaxhighlight>

'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
<syntaxhighlight lang="lua">
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
</syntaxhighlight>

==See Also==

{{ACL_functions}}

AclGetGroup

2019-12-07T15:53:16Z

IDannz: /* Returns */

__NOTOC__
{{Server function}}

This function is used to get the ACL group with the given name. If you need most of the groups you should consider using [[aclGroupList]] instead to get a table containing them all.

==Syntax==

<syntaxhighlight lang="lua">
aclgroup aclGetGroup ( string groupName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the ACL Group class.|[[aclgroup|ACLGroup]].get||}}
===Required Arguments===

*'''groupName:''' The name to get the ACL group from

===Returns===

Returns the ACL group if it could be found. Returns ''false'' / ''nil'' if it did not exist or failed for some reason.

==Example==

'''Example 1:''' This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group.
<syntaxhighlight lang="lua">
function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
if accountName then --if there was an accountName entered then
aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
else --else output an error message and the correct syntax of the command to the player who entered it
outputChatBox ("No account name specified.", playerSource)
outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it
</syntaxhighlight>

'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
<syntaxhighlight lang="lua">
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
</syntaxhighlight>

==See Also==

{{ACL_functions}}

SetCursorPosition

2019-11-27T14:31:15Z

IDannz: /* Example */

{{Client function}}
__NOTOC__
This function sets the current position of the mouse cursor.

==Syntax==
<syntaxhighlight lang="lua">
bool setCursorPosition ( int cursorX, int cursorY )
</syntaxhighlight>

===Required Arguments===

*'''cursorX:''' Position over the X axis
*'''cursorY:''' Position over the Y axis

===Returns===

Returns ''true'' if the position has been successfully set, ''false'' otherwise.

==Example==
This example sets your cursor position to the center of your screen after using the command ''cursorpos''.
<syntaxhighlight lang="lua">
function centerCursorFunction()
local showing = isCursorShowing ()
if showing then -- if the cursor is showing
local screenX, screenY = guiGetScreenSize () --get the screen size in pixels
setCursorPosition (screenX/2, screenY/2) --set the cursor position to the center of the screen
else
outputChatBox( "Your cursor is not showing." )
end
end
addCommandHandler( "cursorpos", centerCursorFunction )
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|8941|setCursorPosition [fixed]}}
}}

==See Also==
{{Client_input_functions}}

[[hu:setCursorPosition]]

CEF Tutorial

2019-10-22T01:50:35Z

IDannz: /* HTML */

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 requsted 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="lua">[javascript]
mta.triggerEvent(string event, var parameter1, var parameter2, var parameter3, ...)
</syntaxhighlight>
The source of this event is always the browser element which 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 a 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 which 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]]

IsElementLowLOD

2019-10-04T02:22:11Z

IDannz:

__NOTOC__
{{Server client function}}
This function reveals if an element is low LOD.

==Syntax==
<syntaxhighlight lang="lua">
bool isElementLowLOD ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:isLowLOD||}}

===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD status we want to get.

===Returns===
Returns ''true'' if the element is low LOD, ''false'' otherwise.

<section name="Clientside" class="client" show="true">
This example will show how many low lods objects is around you.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object",root,true)) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",255,255,0)
end)
</syntaxhighlight>
</section>

<section name="Serverside" class="server" show="false">
This example will show how many low lods objects is around all the world.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object")) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",root,255,255,0)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

IsElementLowLOD

2019-10-04T02:21:04Z

IDannz: /* Returns */

__NOTOC__
{{Server client function}}
{{Needs_Example}}
This function reveals if an element is low LOD.

==Syntax==
<syntaxhighlight lang="lua">
bool isElementLowLOD ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:isLowLOD||}}

===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD status we want to get.

===Returns===
Returns ''true'' if the element is low LOD, ''false'' otherwise.

<section name="Clientside" class="client" show="true">
This example will show how many low lods objects is around you.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object",root,true)) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",255,255,0)
end)
</syntaxhighlight>
</section>

<section name="Serverside" class="server" show="false">
This example will show how many low lods objects is around all the world.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object")) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",root,255,255,0)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

IsElementLowLOD

2019-10-04T02:20:11Z

IDannz: /* Example */

__NOTOC__
{{Server client function}}
{{Needs_Example}}
This function reveals if an element is low LOD.

==Syntax==
<syntaxhighlight lang="lua">
bool isElementLowLOD ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:isLowLOD||}}

===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD status we want to get.

===Returns===
Returns ''true'' if the element is low LOD, ''false'' otherwise.

<section name="Clientside" class="client" show="true">
This example will show how many low lods objects is around you.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object",root,true)) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",255,255,0)
end)
</syntaxhighlight>
</section>

<section name="Serverside" class="server" show="false">
This example will show how many low lods objects is around all the world.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object")) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",255,255,0)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

IsVehicleNitroRecharging

2019-10-04T02:11:01Z

IDannz: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0132|1.3.1|4993|
This function checks if nitro is recharging on the [[vehicle]].
}}
{{Warning|Only works if the vehicle is steamed in}}
==Syntax==
<syntaxhighlight lang="lua">bool isVehicleNitroRecharging ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle''' The [[vehicle]], which you want to check for recharging.

===Returns===
Returns ''true'' if the nitro is currently recharging on the vehicle, ''false'' otherwise.

==Example==
This example will print if vehicle's nitro is already recharging
<syntaxhighlight lang="lua">
addCommandHandler("checknitro",function ()
local pedVeh = getPedOccupiedVehicle(localPlayer)
if pedVeh then
if isVehicleNitroRecharging(pedVeh) then
outputChatBox("Your vehicle's nitro is recharging.",255,255,0)
end
end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.1-9.04993|}}

==See Also==
{{Client_vehicle_functions}}

RemoveHex

2019-09-09T21:14:19Z

IDannz: /* Syntax */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function is used to remove hexadecimal numbers (expressed as ''#XXXXXX'') from strings.

==Syntax==
<syntaxhighlight lang="lua">string removeHex ( string text [, int digits = math.huge ] )</syntaxhighlight>

===Required Arguments===
* '''text''': The text from which you want to remove the hexadecimal numbers.

===Optional Arguments===
* '''digits''': The number of digits the hexadecimal numbers you want to remove have. If not specified, the function will remove every hexadecimal digit which follows a number sign (#).

===Returns===
Returns the modified string if the conversion was successful, ''false'' otherwise.

==Code==
This code can remove a hex code with a number of characters lower or equal to the '''digits''' parameter.
<section name="Code 1" class="both" show="true">
<syntaxhighlight lang="lua">
function removeHex (text, digits)
assert (type (text) == "string", "Bad argument 1 @ removeHex [String expected, got "..tostring(text).."]")
assert (digits == nil or (type (digits) == "number" and digits > 0), "Bad argument 2 @ removeHex [Number greater than zero expected, got "..tostring (digits).."]")
return string.gsub (text, "#"..(digits and string.rep("%x", digits) or "%x+"), "")
end
</syntaxhighlight>
</section>
The following code can remove hex codes inside a hex code. Ex: #fff#000000fffPlayerName >> PlayerName
<section name="Code 2" class="both" show="true">
<syntaxhighlight lang="lua">
function removeHex (s)
if type (s) == "string" then
while (s ~= s:gsub ("#%x%x%x%x%x%x", "")) do
s = s:gsub ("#%x%x%x%x%x%x", "")
end
end
return s or false
end
</syntaxhighlight>
</section>
The following code also removes the hex codes, but if there's a hex code inside a hex code, the outer code will remain. Same result as '''Code 1'''. Ex: #fff#000000fffPlayerName >> #ffffffPlayerName
<section name="Code 3" class="both" show="true">
<syntaxhighlight lang="lua">
function removeHex (s)
return s:gsub ("#%x%x%x%x%x%x", "") or false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example removes colors from player nicknames when they join the server.
<syntaxhighlight lang="lua">
function removeColorsFromNick()
local name = getPlayerName(source)
local new = removeHex(name, 6) -- RGB colors are 6 digits long
if (new ~= name) then
setPlayerName(source, new)
end
end
addEventHandler("onPlayerJoin", root, removeColorsFromNick)
</syntaxhighlight>
</section>
Author: Walid (modified by Ares)
==See Also==
{{Useful_Functions}}

SetVehicleWheelStates

2019-09-09T20:54:23Z

IDannz: /* Example */

__NOTOC__
{{Server client function}}
This function sets the state of wheels on the vehicle.

Internally, no vehicles have more than 4 wheels. If they appear to, they will be duplicating other wheels.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleWheelStates ( vehicle theVehicle, int frontLeft, [ int rearLeft = -1, int frontRight = -1, int rearRight = -1 ])</syntaxhighlight>
{{OOP||[[vehicle]]:setWheelStates||getVehicleWheelStates}}
==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the wheel states of.
*'''frontLeft:''' A whole number representing the wheel state (-1 for no change)

==Optional Arguments==
*'''rearLeft:''' A whole number representing the wheel state (-1 for no change)
*'''frontRight:''' A whole number representing the wheel state (-1 for no change)
*'''rearRight:''' A whole number representing the wheel state (-1 for no change)

==Wheel-State values==
* '''0:''' Inflated
* '''1:''' Flat
* '''2:''' Fallen off
* '''3:''' Collisionless

==Returns==
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.

==Example==
<section name="Server" class="server" show="true">
This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.
<syntaxhighlight lang="lua">
function scriptWheelStates ( thePlayer, command, newFLeft, newRLeft, newFRight, newRRight )
local theVehicle = getPedOccupiedVehicle ( thePlayer )
if ( theVehicle ) then -- check if the player is in a car
if ( newFLeft ) then -- if there's at least one argument passed, we change the wheel states
if not setVehicleWheelStates ( theVehicle, newFLeft, newRLeft, newFRight, newRRight ) then
outputChatBox ( "Bad arguments." )
end
end
local states = { [0]="inflated", [1]="flat", [2]="fallen off" } -- we store the states in a table
local frontLeft, rearLeft, frontRight, rearRight = getVehicleWheelStates ( theVehicle )
outputChatBox ( "Your vehicle's wheel states:", thePlayer ) -- output them in the chatbox
outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ] ..
", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ], thePlayer )
else
outputChatBox ( "You have to be in a vehicle to use this command.", thePlayer )
end
end
addCommandHandler ( "wheelstates", scriptWheelStates )</syntaxhighlight>
</section>
<section name="Client" class="client" >
This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.
<syntaxhighlight lang="lua">
function scriptWheelStates (command, newFLeft, newRLeft, newFRight, newRRight )
local theVehicle = getPedOccupiedVehicle ( localPlayer )
if ( theVehicle ) then -- check if the player is in a car
if ( newFLeft ) then -- if there's at least one argument passed, we change the wheel states
if not setVehicleWheelStates ( theVehicle, newFLeft, newRLeft, newFRight, newRRight ) then
outputChatBox ( "Bad arguments." )
end
end
local states = { [0]="inflated", [1]="flat", [2]="fallen off" } -- we store the states in a table
local frontLeft, rearLeft, frontRight, rearRight = getVehicleWheelStates ( theVehicle )
outputChatBox ( "Your vehicle's wheel states:") -- output them in the chatbox
outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ] ..
", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ])
else
outputChatBox ( "You have to be in a vehicle to use this command.")
end
end
addCommandHandler ( "wheelstates", scriptWheelStates )</syntaxhighlight>
</section>

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

Resource:Object preview

2019-08-25T15:56:34Z

IDannz:

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX, rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the object be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should the object be drawin to second render target.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget()</syntaxhighlight>
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Example==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.object_preview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

Of course when you want to use these functions in your resources you have to include
the object_preview resource in meta.

==See Also==

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=11836 Object Preview resource on community]

Female Skins

2019-08-24T21:19:48Z

IDannz: