Multi Theft Auto: Wiki - User contributions [en]

Server mtaserver.conf

2025-01-29T07:54:27Z

Mtaowner:

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

==Settings==

====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.

====rule====
:''<rule name="NAME_HERE" value="VALUE_HERE"/>''
:The rule parameters are optional. There can be as many as you want in the config file. They contain information for the Server Browser/List. [[Server_Browser_Rules|Read this article for more information]].

====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.

====httpthreadcount====
:''<httpthreadcount>8</httpthreadcount>
:Number of HTTP server threads.
:Available range: 1 to 20. default value: 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]]

====hideac====
:''<hideac>0</hideac>
:When this parameter is enabled client won't get any info about Anticheat settings when connecting to server.
:Values: 0 - disabled , 1 - enabled ; default value: 0. Optional parameter.

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

====net_auto_filter====
:''<net_auto_filter>1</net_auto_filter>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:Net auto filter.
:Values: 0 - disabled, 1 - enabled. default value: 1

====update_cycle_datagrams_limit====
:''<update_cycle_datagrams_limit>4</update_cycle_datagrams_limit>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:Send datagrams limit.
:Available range: 1 to 100. default value: 4

====update_cycle_messages_limit====
:''<update_cycle_messages_limit>50</update_cycle_messages_limit>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:Send messages limit.
:Available range: 10 to 1000. default value: 50

====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 when the ped is near the player.
: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_far_sync_interval====
:''<ped_far_sync_interval>2000</ped_far_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets when the ped is far away from the player.
:Available range: 50 - 4000; default value: 2000
: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]]

====donkey_work_interval====
:''<donkey_work_interval>100</donkey_work_interval>
:Update near list interval in milliseconds.
:Available range: 50 to 4000. default value: 100

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

{{Added feature/item|1.6.1|1.6.0|22430|
====vehicle_contact_sync_radius====
:''<vehicle_contact_sync_radius>30</vehicle_contact_sync_radius>
:This parameter specifies the radius in which any contact with a vehicle will turn the player into its syncer.
:Changing this setting to 0 will cause vehicles to not pick a new syncer based on which player is touching the vehicle.
:Available range: 0 to 130. Default - 30
: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>74</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 32767. Default: 74. You can also use 0 for uncapped fps.
: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

====server_logic_fps_limit====
:''<server_logic_fps_limit>0</server_logic_fps_limit>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:Server logic FPS limit.
:Available range: 0 to 100. default value: 0

====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
:See [[Authorized Serial Account Protection]] for more information.

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

{{New items|6.0160|1.6.0-22790|
====elementdata_whitelisted====
:''<elementdata_whitelisted>0</elementdata_whitelisted>
:Enables extra protection for [[SetElementData|element data]].
:When this option is enabled, the server ignores element data sync packets from the client, except for allowed keys.
:Values: 0 - Off, 1 - Enabled. Default - 0
}}

====player_triggered_event_interval====
:''<player_triggered_event_interval>1000</player_triggered_event_interval>
:Time interval for counting max (see below: max_player_triggered_events_per_interval) triggered events (via triggerServerEvent), exceeding this will call [[onPlayerTriggerEventThreshold]]
:Values: 50-5000; default: 1000 (in ms)

====max_player_triggered_events_per_interval====
:''<max_player_triggered_events_per_interval>100</max_player_triggered_events_per_interval>
:Max triggered amount of events (via triggerServerEvent) within interval above (player_triggered_event_interval), exceeding this will call [[onPlayerTriggerEventThreshold]]
:Values: 1-1000; default: 100

{{Added feature/item|1.6.1|1.6.0|22930|
====player_teleport_alert====
:''<player_teleport_alert>100</player_teleport_alert>
:Defines the maximum allowed unexpected position change (in units). If a player's position changes by more than this value without using [[setElementPosition]], the event [[onPlayerTeleport]] will be triggered.
:Values: 5-500; default: 100
}}

====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_client_file_checks====

:''<resource_client_file_checks>1</resource_client_file_checks>
:If enabled, the server will perform checks on files in resources (listed in [[meta.xml]]) with PNG, TXD and DFF extensions, checking if they are corrupted. When the system finds a non-valid file of these types, it outputs a warning to the server console.
:You may want to disable thse checks when storing different/non-conforming data in files with these extensions (e.g. encrypted data).
:Values: 0 - Off, 1 - Enabled. Default - 1

====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.

====busy_sleep_time====
:''<busy_sleep_time>-1</busy_sleep_time>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - This parameter configures the server's sleep duration in milliseconds during busy processing, affecting CPU usage and responsiveness.
:Available range: -1 to 50; default value: -1
:-1 sets the server to automatically determine the optimal value based on workload.
:Setting it to 0 is recommended for achieving the best performance but may result in higher CPU usage.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]].

====idle_sleep_time====
:''<idle_sleep_time>-1</idle_sleep_time>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - This parameter configures the server's sleep duration in milliseconds during idle periods, affecting CPU usage and responsiveness.
:Available range: -1 to 50; default value: -1
:-1 sets the server to automatically determine the optimal value based on workload.
:Setting it to 10 is recommended for achieving the best performance while balancing CPU usage.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]].

==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.

====httpautoclientfiles====

:''<httpautoclientfiles>1</httpautoclientfiles>

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

Server mtaserver.conf

2025-01-29T07:43:53Z

Mtaowner:

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

==Settings==

====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.

====rule====
:''<rule name="NAME_HERE" value="VALUE_HERE"/>''
:The rule parameters are optional. There can be as many as you want in the config file. They contain information for the Server Browser/List. [[Server_Browser_Rules|Read this article for more information]].

====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.

====httpthreadcount====
:''<httpthreadcount>8</httpthreadcount>
:Number of HTTP server threads.
:Available range: 1 to 20. default value: 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]]

====hideac====
:''<hideac>0</hideac>
:When this parameter is enabled client won't get any info about Anticheat settings when connecting to server.
:Values: 0 - disabled , 1 - enabled ; default value: 0. Optional parameter.

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

====net_auto_filter====
:''<net_auto_filter>1</net_auto_filter>
:Net auto filter.
:Values: 0 - disabled, 1 - enabled. default value: 1

====update_cycle_datagrams_limit====
:''<update_cycle_datagrams_limit>4</update_cycle_datagrams_limit>
:Send datagrams limit.
:Available range: 1 to 100. default value: 4

====update_cycle_messages_limit====
:''<update_cycle_messages_limit>4</update_cycle_messages_limit>
:Send messages limit.
:Available range: 10 to 1000. default value: 50

====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 when the ped is near the player.
: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_far_sync_interval====
:''<ped_far_sync_interval>2000</ped_far_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets when the ped is far away from the player.
:Available range: 50 - 4000; default value: 2000
: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]]

====donkey_work_interval====
:''<donkey_work_interval>100</donkey_work_interval>
:Update near list interval.
:Available range: 50 to 4000. default value: 100

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

{{Added feature/item|1.6.1|1.6.0|22430|
====vehicle_contact_sync_radius====
:''<vehicle_contact_sync_radius>30</vehicle_contact_sync_radius>
:This parameter specifies the radius in which any contact with a vehicle will turn the player into its syncer.
:Changing this setting to 0 will cause vehicles to not pick a new syncer based on which player is touching the vehicle.
:Available range: 0 to 130. Default - 30
: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>74</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 32767. Default: 74. You can also use 0 for uncapped fps.
: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

====server_logic_fps_limit====
:''<server_logic_fps_limit>0</server_logic_fps_limit>
:Server logic FPS limit.
:Available range: 0 to 100. default value: 0

====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
:See [[Authorized Serial Account Protection]] for more information.

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

{{New items|6.0160|1.6.0-22790|
====elementdata_whitelisted====
:''<elementdata_whitelisted>0</elementdata_whitelisted>
:Enables extra protection for [[SetElementData|element data]].
:When this option is enabled, the server ignores element data sync packets from the client, except for allowed keys.
:Values: 0 - Off, 1 - Enabled. Default - 0
}}

====player_triggered_event_interval====
:''<player_triggered_event_interval>1000</player_triggered_event_interval>
:Time interval for counting max (see below: max_player_triggered_events_per_interval) triggered events (via triggerServerEvent), exceeding this will call [[onPlayerTriggerEventThreshold]]
:Values: 50-5000; default: 1000 (in ms)

====max_player_triggered_events_per_interval====
:''<max_player_triggered_events_per_interval>100</max_player_triggered_events_per_interval>
:Max triggered amount of events (via triggerServerEvent) within interval above (player_triggered_event_interval), exceeding this will call [[onPlayerTriggerEventThreshold]]
:Values: 1-1000; default: 100

====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_client_file_checks====

:''<resource_client_file_checks>1</resource_client_file_checks>
:If enabled, the server will perform checks on files in resources (listed in [[meta.xml]]) with PNG, TXD and DFF extensions, checking if they are corrupted. When the system finds a non-valid file of these types, it outputs a warning to the server console.
:You may want to disable thse checks when storing different/non-conforming data in files with these extensions (e.g. encrypted data).
:Values: 0 - Off, 1 - Enabled. Default - 1

====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.

====busy_sleep_time====
:''<busy_sleep_time>-1</busy_sleep_time>
:This parameter configures the server's sleep duration in milliseconds during busy processing, affecting CPU usage and responsiveness.
:Available range: -1 to 50; default value: -1
:-1 sets the server to automatically determine the optimal value based on workload.
:Setting it to 0 is recommended for achieving the best performance but may result in higher CPU usage.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]].

====idle_sleep_time====
:''<idle_sleep_time>-1</idle_sleep_time>
:This parameter configures the server's sleep duration in milliseconds during idle periods, affecting CPU usage and responsiveness.
:Available range: -1 to 50; default value: -1
:-1 sets the server to automatically determine the optimal value based on workload.
:Setting it to 10 is recommended for achieving the best performance while balancing CPU usage.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]].

==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.

====httpautoclientfiles====

:''<httpautoclientfiles>1</httpautoclientfiles>

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

Element/Pickup

2024-02-26T11:40:30Z

Mtaowner: /* XML syntax */

__NOTOC__
The pickup class represents weapon, health, or armor pickups in the GTA world. Pickups can be picked up by players when they are walked over. Players will not be given health or armor pickups if their health or armor is already full.

The element type of this class is '''"pickup"'''.

==XML syntax==
<syntaxhighlight lang="xml">
<pickup posX="" posY="" posZ="" type="" amount="" respawn="" model=""/>
</syntaxhighlight>

===Required Attributes===
* '''posX''': A float representing the X position of the pickup.
* '''posY''': A float representing the Y position of the pickup.
* '''posZ''': A float representing the Z position of the pickup.
* '''type''': A string indicating the type of the pickup. This can either be "health", "armor", "custom", or an integer representing the [[Weapon|weapon ID]] of the pickup..

===Optional Attributes===
* '''amount''': An integer representing a the amount in a pickup. For health or armor, this represents the number of hit points for the pickup. For weapons, this represents the amount of ammo
* '''respawn''': An integer representing the number of milliseconds until the pickup reappears after it has been picked up (default: 30000).
* '''model''': If the pickup is a custom model, this is the model id to use.

==Related scripting functions==
{{Pickup functions}}
[[Category:Element Types]]

[[en:Element/Pickup]]
[[ru:Element/Pickup]]
[[hu:Element/Pickup]]

RemoveHex

2024-02-11T05:23:55Z

Mtaowner: /* Code */

{{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)
local g, c = string.gsub, 0
repeat
s, c = g(s, '#%x%x%x%x%x%x', '')
until c == 0
return s
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}}

SetPedAnimationSpeed

2023-12-17T06:55:50Z

Mtaowner: /* Example */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0156|1.5.5|14219|
Sets the speed of a currently running animation for a particular player or ped.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimationSpeed ( ped thePed [, string anim = "", float speed = 1.0 ] )
</syntaxhighlight>
{{OOP||[[ped]]:setAnimationSpeed}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to change animation speed of.

===Optional Arguments===
*'''anim:''' the animation name it will affect.
*'''speed:''' a [[float]] containing the speed between 0.0–1.0 you want to apply to the animation. ''This limitation may be adjusted in the future, so do not provide speeds outside this boundary.'' {{New feature/item|3.0158|1.5.7|20395|The limit is now 0.0 to 10.0.}} {{Warning|Setting '''speed''' higher than '''1''' can cause issues with some animations.}}

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
In this example we give the animation of dancing to the player and after 5 seconds it becomes 0.2s slower.
<syntaxhighlight lang="lua">
addCommandHandler('dance',
function( player, cmd )
setPedAnimation( player, 'DANCING', 'DAN_Down_A', -1 )
setTimer(function(plr)
if isElement(plr) then setPedAnimationSpeed( plr, 'DAN_Down_A', 0.2 ) end
end,5000,1,player)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}

GetPickupAmount

2023-12-15T09:57:38Z

Mtaowner: /* Example */

__NOTOC__
{{Server client function}}
This function retrieves the amount of health or armor given from a pickup.

==Syntax==
<syntaxhighlight lang="lua">
int getPickupAmount ( pickup thePickup )
</syntaxhighlight>

===Required Arguments===
*'''thePickup:''' The pickup you wish to retrieve the amount from.

===Returns===
Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid, 0 if it's no health or amor pickup.

==Example==
This example outputs the amount of health a player picked up.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function onPickupHitFunction ( thePlayer )
if getPickupType ( source ) == 0 then -- check the type of pickup, if it is a health pickup then
amount = getPickupAmount ( source )
outputChatBox ( "You picked up " .. amount .. " health", thePlayer)
end
end
addEventHandler ( "onPickupHit", root, onPickupHitFunction ) -- add an event handler for onPickupHit
</syntaxhighlight>
</section>

==See Also==
{{Pickup functions}}

User:Mtaowner

2023-11-24T05:17:47Z

Mtaowner: Created blank page

Template:Useful Functions

2023-11-24T03:04:31Z

Mtaowner: /* Utility */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.flip]] » This function returns the table from the last value to the first value, such as reflection.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[getPlayerFromAccountName]] » This function is used to obtain a player by the name of his account.

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.

=== Colshape functions ===
*[[createGarageColShape]] » This function creates a collision shape from the specified garage.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.
*[[setCursorCenteredOnRectangle]] » This functions will center the cursor inside a rectangle.

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawEditbox]] » This function draws a edit box across the screen - rendered for one frame. This should be used in conjunction with '''onClientRender''' in order to display continuously.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxFade]] » This function fade-in or fade-out any dxDraw by gradually changing its alpha value.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.
*[[setScreenFlash]] » This function will make the screen flash(like a screenshot).

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getElementZoneFullName]] » This function allows you to retrieve the zone full name of a element.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInAir]] » This function checks if an element is in air or not.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]] » This function checks if an element is moving.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[isElementWithinAColShape]] » This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[getPositionInFrontOfElement]] » This function returns position in provided distance away from element, including element's rotation.

=== Events ===
*[[onClientPlayerTimeChange]] » This code implements an event that is triggered when the player's real time change.
*[[onPlayerZoneChange]] » This code implements an event that is triggered when the player enters a new area on the map.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[formatDate]] » This function formats a date on the basis of a format string and returns it.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenElements]] » Returns the distance between two elements.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getElementRelatedAngle]] » This function returns the related angle between one element to another. This is useful to check which side an element is to another.
*[[getFreeDimension]] » This function get free dimension.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRealMonth]] » This function returns the current month name
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[gradientString]] » This function transforms a string in a new coloured gradient string.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[RGBToDecimal]] » This function convert RGB to Decimal color.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[splitMultiple]] » This function improves the split function so that multiple characters can be used as the split at character.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[guiSetStaticImageMovable]] » This function allows you to move a static image like a gui window.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
*[[isMouseOnGuiElement]] » This function allows you to check whether or not your mouse is over a specific gui element, this is especially useful if the gui element has a parent. 
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.

=====Gridlists=====
*[[convertGridListToText]] » This function converts grid list contents to text.
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[guiGridListGetColumnIDFromTitle]] » This function gets a gridlist's column ID from the column title.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListSetColumnNonSortable]] » This function makes a gridlist column become non-sortable.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=====Labels=====
*[[guiLabelAddEffect]] » This function add an effects to the gui-label like (shadow, outline).

=== Marker functions ===
*[[createMarkerAttachedTo]] » This function creates a marker that is attached to an element.

=== Math functions ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.
*[[math.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.
*[[math.average]] » This function returns the simple arithmetic mean of multiple numbers.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

=== Ped functions ===
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedNearbyWall]] » This function checks if player/ped is nearby a objects like buildings or walls.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]] » This function make a table of players within certain range.
*[[isPlayerActuallyInVehicle]] » This function checks if a player is actually in a vehicle instead of just in the process of entering.
*[[isPlayerHitByVehicle]] » This function cancels event when a element is hit by a vehicle.

=== Resource functions ===
*[[getFilesInResourceFolder]] » This function gets a list of files that are inside a folder of a resource.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceSize]] » This function returns the size of a specified resource in kB(kilobyte)
*[[refreshResource]] » This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] » This function set resource download priority group.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isSoundPlaying]] » This function checks if a sound element is playing or not.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== Browser functions ===
*[[playVideo]] » This function plays a video on the screen.

=== Team functions ===
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.

=== Vehicle functions ===
*[[findEmptyCarSeat]] » This function finds you the first empty seat in a vehicle.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleOnFire]] » This function checks if the vehicle is on fire or not.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[isVehicleUpgraded]] » This function checks is vehicle upgraded by upgrade ID.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[setVehicleTurnVelocityCenterOfMass]] » This function sets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleHandlingFromText]] » This function sets a vehicle's handling from text.
*[[setVehicleWheelModel]] » This function changes the wheel model of the informed vehicle.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== XML functions ===
*[[getXMLNodes]] » This function returns all children of a XML node.

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[checkPassiveTimer]] » This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[compact]] » This function create table containing variables and their values.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[isLastExecuteInTimer]] » This function check if the execute is the last execute in the timer.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[svgCreateRoundedRectangle]] » This function creates a rectangle with rounded edges.
*[[debounce]] » This function is removing unwanted input noise.

<noinclude>[[Category:Useful Functions]]</noinclude>

Template:Useful Functions

2023-11-21T14:31:20Z

Mtaowner: /* Utility */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.flip]] » This function returns the table from the last value to the first value, such as reflection.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[getPlayerFromAccountName]] » This function is used to obtain a player by the name of his account.

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.

=== Colshape functions ===
*[[createGarageColShape]] » This function creates a collision shape from the specified garage.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.
*[[setCursorCenteredOnRectangle]] » This functions will center the cursor inside a rectangle.

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawEditbox]] » This function draws a edit box across the screen - rendered for one frame. This should be used in conjunction with '''onClientRender''' in order to display continuously.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxFade]] » This function fade-in or fade-out any dxDraw by gradually changing its alpha value.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.
*[[setScreenFlash]] » This function will make the screen flash(like a screenshot).

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getElementZoneFullName]] » This function allows you to retrieve the zone full name of a element.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInAir]] » This function checks if an element is in air or not.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]] » This function checks if an element is moving.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[isElementWithinAColShape]] » This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[getPositionInFrontOfElement]] » This function returns position in provided distance away from element, including element's rotation.

=== Events ===
*[[onClientPlayerTimeChange]] » This code implements an event that is triggered when the player's real time change.
*[[onPlayerZoneChange]] » This code implements an event that is triggered when the player enters a new area on the map.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[formatDate]] » This function formats a date on the basis of a format string and returns it.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenElements]] » Returns the distance between two elements.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getElementRelatedAngle]] » This function returns the related angle between one element to another. This is useful to check which side an element is to another.
*[[getFreeDimension]] » This function get free dimension.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRealMonth]] » This function returns the current month name
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[gradientString]] » This function transforms a string in a new coloured gradient string.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[RGBToDecimal]] » This function convert RGB to Decimal color.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[splitMultiple]] » This function improves the split function so that multiple characters can be used as the split at character.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[guiSetStaticImageMovable]] » This function allows you to move a static image like a gui window.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
*[[isMouseOnGuiElement]] » This function allows you to check whether or not your mouse is over a specific gui element, this is especially useful if the gui element has a parent. 
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.

=====Gridlists=====
*[[convertGridListToText]] » This function converts grid list contents to text.
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[guiGridListGetColumnIDFromTitle]] » This function gets a gridlist's column ID from the column title.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListSetColumnNonSortable]] » This function makes a gridlist column become non-sortable.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=====Labels=====
*[[guiLabelAddEffect]] » This function add an effects to the gui-label like (shadow, outline).

=== Marker functions ===
*[[createMarkerAttachedTo]] » This function creates a marker that is attached to an element.

=== Math functions ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.
*[[math.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.
*[[math.average]] » This function returns the simple arithmetic mean of multiple numbers.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

=== Ped functions ===
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedNearbyWall]] » This function checks if player/ped is nearby a objects like buildings or walls.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]] » This function make a table of players within certain range.
*[[isPlayerActuallyInVehicle]] » This function checks if a player is actually in a vehicle instead of just in the process of entering.
*[[isPlayerHitByVehicle]] » This function cancels event when a element is hit by a vehicle.

=== Resource functions ===
*[[getFilesInResourceFolder]] » This function gets a list of files that are inside a folder of a resource.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceSize]] » This function returns the size of a specified resource in kB(kilobyte)
*[[refreshResource]] » This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] » This function set resource download priority group.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isSoundPlaying]] » This function checks if a sound element is playing or not.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== Browser functions ===
*[[playVideo]] » This function plays a video on the screen.

=== Team functions ===
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.

=== Vehicle functions ===
*[[findEmptyCarSeat]] » This function finds you the first empty seat in a vehicle.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleOnFire]] » This function checks if the vehicle is on fire or not.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[isVehicleUpgraded]] » This function checks is vehicle upgraded by upgrade ID.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[setVehicleTurnVelocityCenterOfMass]] » This function sets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleHandlingFromText]] » This function sets a vehicle's handling from text.
*[[setVehicleWheelModel]] » This function changes the wheel model of the informed vehicle.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== XML functions ===
*[[getXMLNodes]] » This function returns all children of a XML node.

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[checkPassiveTimer]] » This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[compact]] » This function create table containing variables and their values.
*[[fingerprint]] » This function calculates a fingerprint unique to each computer.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[isLastExecuteInTimer]] » This function check if the execute is the last execute in the timer.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[svgCreateRoundedRectangle]] » This function creates a rectangle with rounded edges.
*[[debounce]] » This function is removing unwanted input noise.

<noinclude>[[Category:Useful Functions]]</noinclude>

Fingerprint

2023-11-21T14:31:08Z

Mtaowner: Created page with "{{Useful Function}} __NOTOC__ This function calculates a fingerprint unique to each computer. ==Syntax== <syntaxhighlight lang="lua"> void fingerprint ( function callback ) </syntaxhighlight> ===Required arguments=== *'''callback''': a callback function with syntax as described below ====Callback syntax==== <syntaxhighlight lang="lua"> function ( int value ) </syntaxhighlight> ==Code== <section name="Code" class="client" show="true"> <syntaxhighlight lang="lua"> func..."

{{Useful Function}}
__NOTOC__
This function calculates a fingerprint unique to each computer.

==Syntax==
<syntaxhighlight lang="lua">
void fingerprint ( function callback )
</syntaxhighlight>

===Required arguments===
*'''callback''': a callback function with syntax as described below

====Callback syntax====
<syntaxhighlight lang="lua">
function ( int value )
</syntaxhighlight>

==Code==
<section name="Code" class="client" show="true">
<syntaxhighlight lang="lua">
function fingerprint(callback)
assert(type(callback) == 'function', 'Bad argument @ fingerprint [Expected function at argument 1, got '..type(callback)..']')
local browser = createBrowser(1, 1, true, true)
addEventHandler('onClientBrowserDocumentReady', browser, function()
local num = tonumber(getBrowserTitle(browser) or 0) or 0
destroyElement(browser)
callback(num)
end)
addEventHandler('onClientBrowserLoadingFailed', browser, function()
destroyElement(browser)
callback(0)
end)
addEventHandler('onClientBrowserCreated', browser, function()
loadBrowserURL(browser, 'http://mta/local/')
executeBrowserJavascript(browser, [[for(canvas=document.createElement("canvas"),ctx=canvas.getContext("2d"),txt="i9asdm..$#po((^@KbXrww!~cz",ctx.textBaseline="top",ctx.font="16px 'Arial'",ctx.textBaseline="alphabetic",ctx.rotate(.05),ctx.fillStyle="#f60",ctx.fillRect(125,1,62,20),ctx.fillStyle="#069",ctx.fillText(txt,2,15),ctx.fillStyle="rgba(102, 200, 0, 0.7)",ctx.fillText(txt,4,17),ctx.shadowBlur=10,ctx.shadowColor="blue",ctx.fillRect(-20,10,234,5),ctx.fillStyle="rgb(255,0,253)",ctx.beginPath(),ctx.rect(20.00000000000001,20.9999999999899,151.50000158115816,100.5445545401),ctx.fill(),ctx.stroke(),ctx.closePath(),ctx.beginPath(),ctx.fillStyle="rgb(0,254.66666666666,255)",ctx.arc(50.87401107072145,50.74810746,50.01010101,0,.1111111*Math.PI,!0),ctx.fill(),ctx.stroke(),ctx.closePath(),txt="abz190#$%^@£éú",ctx.textBaseline="top",ctx.font='17px "Arial 17"',ctx.textBaseline="alphabetic",ctx.fillStyle="rgb(255,5.5555555,5)",ctx.rotate(.03),ctx.fillText(txt,4,17),ctx.fillStyle="rgb(155,255,5)",ctx.shadowBlur=8,ctx.shadowColor="red",ctx.fillRect(20,12.987654321,100.123456789,5),src=canvas.toDataURL(),hash=0,i=0;i<src.length;i++)char=src.charCodeAt(i),hash=(hash<<5)-hash+char,hash&=hash;document.title=hash;]])
end)
end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
fingerprint(function(num)
outputChatBox('fingerprint: '..num)
setElementData(localPlayer, 'fingerprint', num)
end)
end, false)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

Server Commands

2023-11-21T09:21:23Z

Mtaowner: /* whois */

This page lists all built in commands that the server can process. All these commands can be entered via the server console or the client console depending upon permissions unless otherwise stated.

==Resource commands==
====check====
:<ins>Server console only</ins>
:Usage: check [ ''all'' | ''<resource-name>'' ] 
:Checks which files would be changed with [[Server_Commands#upgrade|upgrade]] command. Does not modify anything.
====info====
:<ins>Server console only</ins>
:Usage: info ''<resource-name>'' 
:Get info for a resource eg: info admin
====list====
:<ins>Server console only</ins>
:Shows a list of resources
====refresh====
:Refresh resource list to find new resources
====refreshall====
:Refresh resources and restart any changed resources
====restart====
:Usage: restart ''<resource-name>'' 
:Restarts a running resource eg: restart admin

====start====
:Usage: start ''<resource-name>'' 
:Start a loaded resource eg: start admin
====stop====
:Usage: stop ''<resource-name>'' 
:Stop a resource eg: stop admin
====stopall====
:Stop all running resources
====upgrade====
:<ins>Server console only</ins>
:Usage: upgrade [ ''all'' | ''<resource-name>'' ] 
:Perform a basic upgrade of all resources. The [[Server_Commands#check|check]] command shows the list of changes this command will make.
====aclrequest====
:Usage: aclrequest [ ''list'' | ''allow'' | ''deny'' ] ''<resource-name>'' [ ''<right>'' | ''all'' ] 
:Manage ACL requests from resources implementing <aclrequest> in their [[meta.xml]]
{{New feature/item|3.0156|1.5.5|11851|
====reloadacl====
:Perform a simple ACL reload.}}

==Account commands==
====aexec====
:Usage: aexec ''<nick>'' ''<command>'' 
:Force a player to execute a command eg: aexec playername say hello
====addaccount====
:Usage: addaccount ''<accountname>'' ''<password>'' 
:Add an account eg: addaccount accountname password
====chgpass====
:Usage: chgpass ''<accountname>'' ''<password>'' 
:Change an accounts password eg: chgpass account newpw
====delaccount====
:Usage: delaccount ''<accountname>'' 
:Delete an account eg: delaccount accountname
====reloadbans====
:Reloads all the bans from ''banlist.xml''.
====authserial====
:Usage: authserial <account-name> [list|removelast|httppass]
:Manage serial authentication for an account.

==Server commands==
====ase====
:<ins>Server console only</ins>
:See the amount of master server list queries
====debugdb====
:Usage: debugdb ''<''0-2''>'' 
:<ins>Server console only</ins>
:Set logging level for database functions. [0-Off  1-Errors only  2-All]
:By default, logging output is written to the file '''logs/db.log''' unless another file is declared in the [[Mtaserver.conf#dbfile|<dbfile> section of mtaserver.conf]]
====debugjoinflood====
:<ins>Server console only</ins>
:Shows debug information regarding the join flood mitigation feature.
====debuguptime====
:<ins>Server console only</ins>
:Shows how many days the server has been up and running.
====help====
:<ins>Server console only</ins>
:Displays these list of commands
====loadmodule====
:Usage: loadmodule ''<module-filename>'' 
:Load a module eg: loadmodule ml_sockets.dll

====unloadmodule====
:<ins>Server console only</ins>
:Usage: unloadmodule ''<module-filename>'' 
:Unload a module eg: unloadmodule ml_sockets.dll
====reloadmodule====
:<ins>Server console only</ins>
:Usage: reloadmodule ''<module-filename>'' 
:Reload a module eg: reloadmodule ml_sockets.dll
====openports====
:<ins>Server console only</ins>
:Test if server ports are open
====sfakelag====
{{Main|Command fakelag}}
:Usage: sfakelag ''<packet loss>'' ''<extra ping>'' ''<ping variance>'' [''<KBPS limit>'']
:'''Only available if enabled in the [[mtaserver.conf]] file.'''
:Adds artificial packet loss, ping, jitter and bandwidth limits to the server-client connections.
====shutdown====
:Usage: shutdown ''<reason>'' 
:Shutdown the server eg: shutdown put reason here
====sver====
:Get the server MTA version

==Other commands==
====say====
:Usage: say ''<text>'' 
:Show a message to all players on the server eg: say hello
====whois====
:Usage: whois ''<nick>'' 
:Get the IP of a player currently connected (use '''whowas''' for IP/serial/version)
{{Deprecated feature|3.0156|1.5.6|
====whowas====
:Usage: whowas ''<nick>'' 
:Get IP/Serial/username of a player that was previously connected to the server
}}

====ver====
:Get the MTA version

==Client relevant only==
====chgmypass====
:<ins>Client only</ins>
:Usage: chgmypass ''<oldpass>'' ''<newpass>'' 
:Change your password eg: chgmypass oldpw newpw
====debugscript====
:<ins>Client only</ins>
:Usage: debugscript ''<''0-3''>'' 
:Remove (This does not work "Incorrect client type for this command")
====login====
:<ins>Client only</ins>
:Usage: login ''<accountname>'' ''<password>'' 
:Login to an account eg: login accountname password

====logout====
:<ins>Client only</ins>
:Log out of the current account
====me====
:<ins>Client only</ins>
:Usage: me ''<text>'' 
:Show a message to all players on the server, with your nick prepended
====msg====
:<ins>Client only</ins>
:Usage: msg ''<nick>'' ''<text>'' 
:Send a message to a player eg: msg playername hello
====nick====
:<ins>Client only</ins>
:Usage: nick ''<old-nick>'' ''<new-nick>'' 
:Change your ingame nickname
====teamsay====
:<ins>Client only</ins>
:Usage: teamsay ''<test>'' 
:Send a message to all players on the same team

[[Category: Support]]

[[hu:Server Commands]]
[[ru:Server Commands]]

Server Commands

2023-11-21T09:20:37Z

Mtaowner: /* loadmodule */

This page lists all built in commands that the server can process. All these commands can be entered via the server console or the client console depending upon permissions unless otherwise stated.

==Resource commands==
====check====
:<ins>Server console only</ins>
:Usage: check [ ''all'' | ''<resource-name>'' ] 
:Checks which files would be changed with [[Server_Commands#upgrade|upgrade]] command. Does not modify anything.
====info====
:<ins>Server console only</ins>
:Usage: info ''<resource-name>'' 
:Get info for a resource eg: info admin
====list====
:<ins>Server console only</ins>
:Shows a list of resources
====refresh====
:Refresh resource list to find new resources
====refreshall====
:Refresh resources and restart any changed resources
====restart====
:Usage: restart ''<resource-name>'' 
:Restarts a running resource eg: restart admin

====start====
:Usage: start ''<resource-name>'' 
:Start a loaded resource eg: start admin
====stop====
:Usage: stop ''<resource-name>'' 
:Stop a resource eg: stop admin
====stopall====
:Stop all running resources
====upgrade====
:<ins>Server console only</ins>
:Usage: upgrade [ ''all'' | ''<resource-name>'' ] 
:Perform a basic upgrade of all resources. The [[Server_Commands#check|check]] command shows the list of changes this command will make.
====aclrequest====
:Usage: aclrequest [ ''list'' | ''allow'' | ''deny'' ] ''<resource-name>'' [ ''<right>'' | ''all'' ] 
:Manage ACL requests from resources implementing <aclrequest> in their [[meta.xml]]
{{New feature/item|3.0156|1.5.5|11851|
====reloadacl====
:Perform a simple ACL reload.}}

==Account commands==
====aexec====
:Usage: aexec ''<nick>'' ''<command>'' 
:Force a player to execute a command eg: aexec playername say hello
====addaccount====
:Usage: addaccount ''<accountname>'' ''<password>'' 
:Add an account eg: addaccount accountname password
====chgpass====
:Usage: chgpass ''<accountname>'' ''<password>'' 
:Change an accounts password eg: chgpass account newpw
====delaccount====
:Usage: delaccount ''<accountname>'' 
:Delete an account eg: delaccount accountname
====reloadbans====
:Reloads all the bans from ''banlist.xml''.
====authserial====
:Usage: authserial <account-name> [list|removelast|httppass]
:Manage serial authentication for an account.

==Server commands==
====ase====
:<ins>Server console only</ins>
:See the amount of master server list queries
====debugdb====
:Usage: debugdb ''<''0-2''>'' 
:<ins>Server console only</ins>
:Set logging level for database functions. [0-Off  1-Errors only  2-All]
:By default, logging output is written to the file '''logs/db.log''' unless another file is declared in the [[Mtaserver.conf#dbfile|<dbfile> section of mtaserver.conf]]
====debugjoinflood====
:<ins>Server console only</ins>
:Shows debug information regarding the join flood mitigation feature.
====debuguptime====
:<ins>Server console only</ins>
:Shows how many days the server has been up and running.
====help====
:<ins>Server console only</ins>
:Displays these list of commands
====loadmodule====
:Usage: loadmodule ''<module-filename>'' 
:Load a module eg: loadmodule ml_sockets.dll

====unloadmodule====
:<ins>Server console only</ins>
:Usage: unloadmodule ''<module-filename>'' 
:Unload a module eg: unloadmodule ml_sockets.dll
====reloadmodule====
:<ins>Server console only</ins>
:Usage: reloadmodule ''<module-filename>'' 
:Reload a module eg: reloadmodule ml_sockets.dll
====openports====
:<ins>Server console only</ins>
:Test if server ports are open
====sfakelag====
{{Main|Command fakelag}}
:Usage: sfakelag ''<packet loss>'' ''<extra ping>'' ''<ping variance>'' [''<KBPS limit>'']
:'''Only available if enabled in the [[mtaserver.conf]] file.'''
:Adds artificial packet loss, ping, jitter and bandwidth limits to the server-client connections.
====shutdown====
:Usage: shutdown ''<reason>'' 
:Shutdown the server eg: shutdown put reason here
====sver====
:Get the server MTA version

==Other commands==
====say====
:Usage: say ''<text>'' 
:Show a message to all players on the server eg: say hello
====whois====
:Usage: whois ''<nick>'' 
:Get the IP of a player currently connected (use whowas for IP/serial/version)
{{Deprecated feature|3.0156|1.5.6|
====whowas====
:Usage: whowas ''<nick>'' 
:Get IP/Serial/username of a player that was previously connected to the server
}}
====ver====
:Get the MTA version

==Client relevant only==
====chgmypass====
:<ins>Client only</ins>
:Usage: chgmypass ''<oldpass>'' ''<newpass>'' 
:Change your password eg: chgmypass oldpw newpw
====debugscript====
:<ins>Client only</ins>
:Usage: debugscript ''<''0-3''>'' 
:Remove (This does not work "Incorrect client type for this command")
====login====
:<ins>Client only</ins>
:Usage: login ''<accountname>'' ''<password>'' 
:Login to an account eg: login accountname password

====logout====
:<ins>Client only</ins>
:Log out of the current account
====me====
:<ins>Client only</ins>
:Usage: me ''<text>'' 
:Show a message to all players on the server, with your nick prepended
====msg====
:<ins>Client only</ins>
:Usage: msg ''<nick>'' ''<text>'' 
:Send a message to a player eg: msg playername hello
====nick====
:<ins>Client only</ins>
:Usage: nick ''<old-nick>'' ''<new-nick>'' 
:Change your ingame nickname
====teamsay====
:<ins>Client only</ins>
:Usage: teamsay ''<test>'' 
:Send a message to all players on the same team

[[Category: Support]]

[[hu:Server Commands]]
[[ru:Server Commands]]

GetPlayerName

2023-11-21T09:19:07Z

Mtaowner: /* Limits */

__NOTOC__
{{Server client function}}
This function returns a string containing the name of the specified player.

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerName ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getName|name|setPlayerName}}
===Required Arguments===
* '''thePlayer:''' the [[player]] you want to get the name of

===Returns===
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.

===Limits===
* Player name can consist of ASCII characters between 33 and 126 are allowed (basic latin):
<nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
* Minimal player name length is 1 character.
* Maximum player name length is 22 characters.
* Player names are case-insensitive. It is not possible to have two clients with same name but different character case.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function(playerSource)
outputChatBox("Your name: "..getPlayerName(playerSource), playerSource)
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example outputs the local player name to the chatbox.
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function()
local localPlayerName = getPlayerName(getLocalPlayer())
--and we output it to the chatbox
outputChatBox(localPlayerName)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client player functions}}
[[es:getPlayerName]]
[[pt-br:getPlayerName]]

GetPlayerName

2023-11-21T09:18:13Z

Mtaowner: /* Limits */

OnPlayerProjectileCreation

2023-11-19T11:55:32Z

Mtaowner: /* Example */

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22293|This event is triggered every time a projectile is created by a [[player]] - either through a weapon, a vehicle weapon or [[createProjectile]].}}
==Parameters==
<syntaxhighlight lang="lua">
int weaponType, float x, float y, float z, float force, element target, float rotX, float rotY, float rotZ, float velX, float velY, float velZ
</syntaxhighlight>
*'''weaponType:''' ID, see below
{{Projectiles}}
*'''x:''' X coordinate of where the projectile was created
*'''y:''' Y coordinate of where the projectile was created
*'''z:''' Z coordinate of where the projectile was created
*'''force:''' force of thrown projectile. Valid for ID 16, 17, 18, 39.
*'''target:''' [[element]] the projectile is targeting. Valid for ID 19, 20.
*'''rotX:''' X rotation. Valid for ID 19, 20.
*'''rotY:''' Y rotation. Valid for ID 19, 20.
*'''rotZ:''' Z rotation. Valid for ID 19, 20.
*'''velX:''' X axis velocity. Valid for ID 16, 17, 18, 19, 20, 39.
*'''velY:''' Y axis velocity. Valid for ID 16, 17, 18, 19, 20, 39.
*'''velZ:''' Z axis velocity. Valid for ID 16, 17, 18, 19, 20, 39.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who created the projectile.

===Canceling===
If this event is [[Event system #Canceling|canceled]], the projectile will not be created for other players on the server.

==Example==
<syntaxhighlight lang="lua">
local projectileNames = {
[16]='Grenade',
[17]='Tear Gas Grenade',
[18]='Molotov',
[19]='Rocket (simple)',
[20]='Rocket (heat seeking)',
[21]='Air Bomb',
[39]='Satchel Charge',
[58]='Hydra flare'
}

addEventHandler('onPlayerProjectileCreation', root,
function(weaponType)
cancelEvent()

local weaponName = projectileNames[weaponType] or 'Unknown'
outputServerLog('* '..getPlayerName(source)..' created projectile ('..weaponName..')! most likely he is cheater, event canceled')
end
)
</syntaxhighlight>
{{See also/Server event|Player events}}