Multi Theft Auto: Wiki - User contributions [en]

Server mtaserver.conf

2015-04-09T14:37:30Z

Rain Gloom: added AC guide link to SD as well

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

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

====serverip====
:''<serverip></serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:It is generally only needed for professional servers and should be left blank otherwise. This parameter specifies the IP to use for servers that have multiple IP addresses. If left blank, it will default to server's standard local IP address.
:SERVERIP SHOULD BE LEFT BLANK UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:People who set this and then ask for support will be the first ones against the wall when the revolution comes

====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 builtin http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

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

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

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

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

{{New feature/item|3.0136|1.3.5|6301|
====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
}}

====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|Anti-cheat guide]]

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

====enablesd====
:''<enablesd></enablesd>
:Comma seperated 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 special detections, but most servers should leave this setting blank.
:e.g. To enable special detection #12 (disallow custom D3D9.DLL) use: 12
:More information: [[Anti-cheat_guide|Anti-cheat guide]]

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

====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 [[http://nightly.mtasa.com/ver highest available]].'''

{{New feature/item|3.0136|1.3.4|6023|
====minclientversion_auto_update====
:''<minclientversion_auto_update></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 recommened 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 [[http://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 ingame server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

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

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

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

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

====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 - 40000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

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

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

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

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

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

====bullet_sync====
:''<bullet_sync>0</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:'''It only works on server build 4247 or later, and when enabled, connecting clients will be auto-updated if required.'''
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
: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 expermental.
:'''It only works on server build 4456 or later.'''
: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.
:'''It only works on server build 4456 or later.'''
: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.

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

{{New feature/item|3.0136|1.3.4|5809|
====loadstringfile====
:''
: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.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:This parameter can be 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

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

{{New feature/item|3.0136|1.3.4|5950|
====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented. Details: http://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1
}}

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

====resource====
:''<resource src="admin" startup="1" protected="0"/>
:''<resource src="defaultstats" startup="1" protected="0"/>
:''<resource src="helpmanager" startup="1" protected="0"/>
:''<resource src="joinquit" startup="1" protected="0"/>
:''<resource src="mapcycler" startup="1" protected="0"/>
:''<resource src="mapmanager" startup="1" protected="0"/>
:''<resource src="parachute" startup="1" protected="0"/>
:''<resource src="resourcebrowser" startup="1" protected="1" default="true"/>
:''<resource src="resourcemanager" startup="1" protected="1"/>
:''<resource src="scoreboard" startup="1" protected="0"/>
:''<resource src="spawnmanager" startup="1" protected="0"/>
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0"/>
:''<resource src="webadmin" startup="1" protected="0"/>
:Specifies resources that are loaded when the server starts and/or which are protected from being stopped. To specify several resources, add more <resource> parameter(s).

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

Client on Linux Manual

2015-04-09T03:55:16Z

Rain Gloom: MSVC++ incompatibilities with Ubuntu's default Wine version

{{Warning|This page is for Linux players '''ONLY''', for Windows go [[Client Manual|here]].|true}}
==Before you start==

First of all, please ensure your computer fits the requirements needed.
Read the [[Client_Manual|Client Manual]] page for further informations, or join us on IRC @ irc://irc.multitheftauto.com/mta

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

Or get the zip archive with the 3 fonts here: [http://www.4shared.com/zip/IsErUbQAba/wine_mta_fonts.html wine_mta_fonts.zip]

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

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

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

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

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

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

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

== See Also ==
* [http://nightly.mtasa.com/ nightly.mtasa.com] - For nightly builds.

[[Category:Support]]
[[ru:Client on Linux Manual]]
[[hu:Client on Linux Manual]]

Client on Linux Manual

2015-04-08T22:01:27Z

Rain Gloom: added note about default wineprefix

{{Warning|This page is for Linux players '''ONLY''', for Windows go [[Client Manual|here]].|true}}
==Before you start==

First of all, please ensure your computer fits the requirements needed.
Read the [[Client_Manual|Client Manual]] page for further informations, or join us on IRC @ irc://irc.multitheftauto.com/mta

===Requirements===
The hardware requirements for Multi Theft Auto: San Andreas are the same than on Windows.
For software requirements, you need:
* Wine (get it on your package manager (synaptic, apt, pacman, yum etc.); click [http://tinyurl.com/installWine1-3 here] if you're using Ubuntu
* Windows fonts installed:
** tahoma.ttf
** tahomabd.ttf
** verdana.ttf
Get them on the Internet, e.g. [http://fontonic.com/ fontonic.com]

Or get the zip archive with the 3 fonts here: [http://www.4shared.com/zip/IsErUbQAba/wine_mta_fonts.html wine_mta_fonts.zip]

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

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

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

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

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

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

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

== See Also ==
* [http://nightly.mtasa.com/ nightly.mtasa.com] - For nightly builds.

[[Category:Support]]
[[ru:Client on Linux Manual]]
[[hu:Client on Linux Manual]]

Easing

2015-04-08T10:18:13Z

Rain Gloom:

Easing functions describe functions that control the way an interpolation between 0 and 1 is done.

The most basic easing function, linear, is just a linear interpolation at constant speed. Other more advanced easing functions can have acceleration at the beginning, the end or both or deceleration, or even bouncing or elastic effects.

= Preliminary note =

In the functions using easing, there are usually 3 optional parameters. Most functions don't need them at all, the ones needing one or more parameters are listed in the table below. When providing optional parameters, all the parameters before a given parameter must be filled, even if the easing function you intend to use doesn't require such a parameter. In this case, simply use 0 for the parameters you don't need.
Examples:
* ''"Linear"'' can be used simply with ''getEasingValue( fProgress, "Linear" )''
* ''"OutElastic"'' can define ''fEasingPeriod'' and ''fEasingAmplitude'' so it can be used with ''getEasingValue( fProgress, "OutElastic", 0.3, 1.0 )''
* ''"InBack"'' can define ''fEasingOvershoot'', but since it comes after ''fEasingPeriod'' and ''fEasingAmplitude'' in the order of parameters, 0 must be used for the others with ''getEasingValue( fProgress, "InBack", 0, 0, 1.7015 )''

= Easing functions =
<syntaxhighlight lang="lua">
--List of builtin easing functions
builtins={ "Linear", "InQuad", "OutQuad", "InOutQuad", "OutInQuad", "InElastic", "OutElastic", "InOutElastic", "OutInElastic", "InBack", "OutBack", "InOutBack", "OutInBack", "InBounce", "OutBounce", "InOutBounce", "OutInBounce", "SineCurve", "CosineCurve" }
</syntaxhighlight>
Default values are (when a function can use a parameter but it's not defined by the user):
* ''fEasingPeriod:'' 0.3
* ''fEasingAmplitude :'' 1.0
* ''fEasingOvershoot:'' 1.701

<table border="1" class="unnamed1">
<tr>
<th align="center">Easing function</th>
<th align="center">Function profile</th>
<th align="center">Uses fEasingPeriod</th>
<th align="center">Uses fEasingAmplitude</th>
<th align="center">Uses fEasingOvershoot</th>
<th>Comments</th>
</tr>

<tr>
<td align="center">Linear</td>
<td align="center">[[File:Qeasingcurve-linear.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">InQuad</td>
<td align="center">[[File:Qeasingcurve-inquad.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">OutQuad</td>
<td align="center">[[File:Qeasingcurve-outquad.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">InOutQuad</td>
<td align="center">[[File:Qeasingcurve-inoutquad.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">OutInQuad</td>
<td align="center">[[File:Qeasingcurve-outinquad.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">InElastic</td>
<td align="center">[[File:Qeasingcurve-inelastic.png]]</td>
<td align="center">yes</td><td align="center">yes</td><td align="center"></td><td>Due to the elastic effect, this easing function produces some values < 0</td>
</tr>
<tr>
<td align="center">OutElastic</td>
<td align="center">[[File:Qeasingcurve-outelastic.png]]</td>
<td align="center">yes</td><td align="center">yes</td><td align="center"></td><td>Due to the elastic effect, this easing function produces some values > 1</td>
</tr>
<tr>
<td align="center">InOutElastic</td>
<td align="center">[[File:Qeasingcurve-inoutelastic.png]]</td>
<td align="center">yes</td><td align="center">yes</td><td align="center"></td><td>Due to the elastic effect, this easing function produces some values < 0 and > 1</td>
</tr>
<tr>
<td align="center">OutInElastic</td>
<td align="center">[[File:Qeasingcurve-outinelastic.png]]</td>
<td align="center">yes</td><td align="center">yes</td><td align="center"></td><td>Due to the elastic effect, this easing function produces some values < 0 and > 1</td>
</tr>
<tr>
<td align="center">InBack</td>
<td align="center">[[File:Qeasingcurve-inback.png]]</td>
<td align="center"></td><td align="center"></td><td align="center">yes</td><td>Due to overshoot, this easing function produces some values < 0</td>
</tr>
<tr>
<td align="center">OutBack</td>
<td align="center">[[File:Qeasingcurve-outback.png]]</td>
<td align="center"></td><td align="center"></td><td align="center">yes</td><td>Due to overshoot, this easing function produces some values > 1</td>
</tr>
<tr>
<td align="center">InOutBack</td>
<td align="center">[[File:Qeasingcurve-inoutback.png]]</td>
<td align="center"></td><td align="center"></td><td align="center">yes</td><td>Due to overshoot, this easing function produces some values <0 and > 1</td>
</tr>
<tr>
<td align="center">OutInBack</td>
<td align="center">[[File:Qeasingcurve-outinback.png]]</td>
<td align="center"></td><td align="center"></td><td align="center">yes</td><td></td>
</tr>
<tr>
<td align="center">InBounce</td>
<td align="center">[[File:Qeasingcurve-inbounce.png]]</td>
<td align="center"></td><td align="center">yes</td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">OutBounce</td>
<td align="center">[[File:Qeasingcurve-outbounce.png]]</td>
<td align="center"></td><td align="center">yes</td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">InOutBounce</td>
<td align="center">[[File:Qeasingcurve-inoutbounce.png]]</td>
<td align="center"></td><td align="center">yes</td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">OutInBounce</td>
<td align="center">[[File:Qeasingcurve-outinbounce.png]]</td>
<td align="center"></td><td align="center">yes</td><td align="center"></td><td></td>
</tr>
<tr>
<td align="center">SineCurve</td>
<td align="center">[[File:Qeasingcurve-sincurve.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td>This easing function doesn't end at 1 but goes back to 0. In this case, for interpolation, the target value is just an edge but doesn't represent the stop value.</td>
</tr>
<tr>
<td align="center">CosineCurve</td>
<td align="center">[[File:Qeasingcurve-coscurve.png]]</td>
<td align="center"></td><td align="center"></td><td align="center"></td><td>This easing function both starts and stops at 0.5, going first to 1 then 0. In this case, for interpolation, the source and target values are just the edges but don't represent the start/stop values.</td>
</tr>

</table>

==Examples ==
<section show="true">
'''Example 1:''' This example move gate with easing.
<syntaxhighlight lang="lua">
local x,y,z = 2096.3, 1721, 12.7
local easing = "OutBounce"
local time = 2000
local gate = createObject(980, x,y,z, 0, 0, 63)
local marker = createMarker(x,y,z, "cylinder", 12, 0, 0, 0, 0)

function moveGate(hitPlayer, matchingDimension)
moveObject(gate, time, x+4.9, y+9.6, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerHit", marker, moveGate)

function moveBack()
moveObject(gate, time, x, y, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerLeave", marker, moveBack)
</syntaxhighlight>
</section>

= Source =

The naming conventions of the functions below, available in [[moveObject]], [[interpolateBetween]], or [[getEasingValue]] have been extracted from [http://doc.qt.nokia.com/latest/qeasingcurve.html Qt documentation]. Only a subset of those functions is available in MTA since some of them are a bit redundant (only the profile of the acceleration/deceleration changes).
The pictures of the easing functions are directly extracted from Qt documentation, © 2008-2010 Nokia Corporation and/or its subsidiaries.

GetEasingValue

2014-08-31T13:40:54Z

Rain Gloom: fixed some grammar mistakes

__NOTOC__
{{Server client function}}

Used for custom Lua based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and an [[Easing|easing function]].
In most cases, either [[moveObject]] or [[interpolateBetween]] can do the job. getEasingValue is only provided in case you want to do your own custom interpolation based on easing.

==Syntax==
<syntaxhighlight lang="lua">float getEasingValue( float fProgress, string strEasingType [, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot] )</syntaxhighlight>

===Required Arguments===
*'''fProgress:''' float between 0 and 1 indicating the interpolation progress (0 at the beginning of the interpolation, 1 at the end).
*'''strEasingType:''' the [[Easing|easing function]] to use for the interpolation

===Optional Arguments===
*'''fEasingPeriod:''' the period of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingAmplitude:''' the amplitude of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingOvershoot:''' the overshoot of the [[Easing|easing function]] (only some easing functions use this parameter)

===Returns===
Returns ''fAnimationTime '' the animation time given by the easing function (can be < 0 or > 1 since some [[Easing|easing functions]] have overshoot or bounce/spring effects, ''false'' otherwise (error in parameters).

== Example ==
The examples below are only clientside ones, even though the functions can be used on both sides. Indeed it makes more sense to use them with onClientRender/onClientPreRender but the freedom is given to use it in any other context.
<section name="Client" class="client" show="true">
This clientside example uses getEasingValue to make a custom camera fade.
The command to test it is "/fade".
The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.
In this example [[interpolateBetween]] could have been used directly to interpolate the alpha between 0 and 255 and then 255 and 0 but is example is just to illustrate the use of getEasingValue by itself.
<syntaxhighlight lang="lua">
local g_Fade = nil
addCommandHandler("fade",
function ()
if g_Fade then return end
g_Fade = {}
g_Fade.startTime = getTickCount()
g_Fade.endTime = g_Fade.startTime + 2000
g_Fade.easingFunction = "InQuad" --Slow at first and accelerating
addEventHandler("onClientRender", getRootElement(), fadeCameraOut)
end)

function fadeCameraOut()
local now = getTickCount()
local elapsedTime = now - g_Fade.startTime
local duration = g_Fade.endTime - g_Fade.startTime
local progress = elapsedTime / duration

local fAnimationTime = getEasingValue(progress, g_Fade.easingFunction)

local alpha = fAnimationTime*255
local width, height = guiGetScreenSize()
dxDrawRectangle(0, 0, width, height, tocolor(0, 0, 0, alpha), true)

if now > g_Fade.endTime then
removeEventHandler("onClientRender", getRootElement(), fadeCameraOut)
g_Fade.startTime = getTickCount()
g_Fade.endTime = g_Fade.startTime + 2000
g_Fade.easingFunction = "OutQuad" --Fast at first then decelerating
addEventHandler("onClientRender", getRootElement(), fadeCameraIn)
end
end

function fadeCameraIn()
local now = getTickCount()
local elapsedTime = now - g_Fade.startTime
local duration = g_Fade.endTime - g_Fade.startTime
local progress = elapsedTime / duration

local fAnimationTime = getEasingValue(progress, g_Fade.easingFunction)

local alpha = (1-fAnimationTime)*255
local width, height = guiGetScreenSize()
dxDrawRectangle(0, 0, width, height, tocolor(0, 0, 0, alpha), true)

if now > g_Fade.endTime then
removeEventHandler("onClientRender", getRootElement(), fadeCameraIn)
g_Fade = nil
end
end
</syntaxhighlight>
</section>

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

Element/Effect

2014-07-08T14:00:58Z

Rain Gloom: Fixed a typo in the Lua list

{{New items|3.0140|1.4|
The Effect class represents custom effect elements in the game world such as smoke, sparks, fire etc.

The element type of this class is '''"effect"'''.
}}

__TOC__
== Effects list ==
There are 82 effects.
<syntaxhighlight lang="lua">--An array containing all effect names.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke","explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium","explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower","fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame","overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke","prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2","prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m","smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2","water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end","water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|bloody explosion
|-
|boat_prop
|a surf
|-
|camflash
|small flare
|-
|carwashspray
|steam, as on a carwash
|-
|cement
|cement
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|a pouring water
|-
|cigarette_smoke
|a smoke from a cigarette
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|a smoke with sparks
|-
|exhale
|a small smoke
|-
|explosion_fuel_car
|explosion, as from the machine
|-
|explosion_large
|the large explosion
|-
|explosion_medium
|average explosion
|-
|explosion_molotov
|explosion, as from a movotov cocktail
|-
|explosion_small
|small explosion
|-
|explosion_tiny
|very small explosion
|-
|extinguisher
|foam of the fire extinguisher
|-
|flame
|small fire
|-
|fire
|fire
|-
|fire_med
|average fire
|-
|fire_large
|large fire
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|a smoke from a gun
|-
|insects
|insects
|-
|heli_dust
|a dust, as from the helicopter
|-
|jetpack
|a jetpacks fire
|-
|jetthrust
|fire from the muffler of the machine, as during use of nitrogen
|-
|nitro
|nitro
|-
|molotov_flame
|fire from a Molotov Cocktail
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|spark? maybe meant to be a mini red blood splash
|-
|prt_boatsplash
|foam
|-
|prt_bubble
|bubble
|-
|prt_cardebris
|splinters from a box
|-
|prt_collisionsmoke
|a dense white smoke
|-
|prt_glass
|a crashing glass
|-
|prt_gunshell
|shells
|-
|prt_sand
|sand, which was scattered
|-
|prt_sand2
|there is less sand, than in previous animation
|-
|prt_smokeII_3_expand
|a grey smoke
|-
|prt_smoke_huge
|there is a lot of grey smoke
|-
|prt_spark
|of a spark
|-
|prt_spark_2
|the large sparks
|-
|prt_splash
|burst
|-
|prt_wake
|a wave
|-
|prt_watersplash
|sparks
|-
|prt_wheeldirt
|sparks from wheels of the car
|-
|petrolcan
|a jet
|-
|puke
|belch
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|circles on water
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|water of a fountain
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|smoke
|}

==Related scripting functions==
===Client===
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[setEffectDensity]]

[[Category:Element Types]]

Element/Effect

2014-07-08T13:07:18Z

Rain Gloom: Added list of effect names as an array for easier testing.

{{New items|3.0140|1.4|
The Effect class represents custom effect elements in the game world such as smoke, sparks, fire etc.

The element type of this class is '''"effect"'''.
}}

__TOC__
== Effects list ==
There are 82 effects.
<syntaxhighlight lang="lua">--An array containing all effect names.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke","explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium","explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower","fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame","overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke","prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2","prt_splash","prt_wake","prt_watersplash","prt_wheeldirt""petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m","smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2","water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end","water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|bloody explosion
|-
|boat_prop
|a surf
|-
|camflash
|small flare
|-
|carwashspray
|steam, as on a carwash
|-
|cement
|cement
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|a pouring water
|-
|cigarette_smoke
|a smoke from a cigarette
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|a smoke with sparks
|-
|exhale
|a small smoke
|-
|explosion_fuel_car
|explosion, as from the machine
|-
|explosion_large
|the large explosion
|-
|explosion_medium
|average explosion
|-
|explosion_molotov
|explosion, as from a movotov cocktail
|-
|explosion_small
|small explosion
|-
|explosion_tiny
|very small explosion
|-
|extinguisher
|foam of the fire extinguisher
|-
|flame
|small fire
|-
|fire
|fire
|-
|fire_med
|average fire
|-
|fire_large
|large fire
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|a smoke from a gun
|-
|insects
|insects
|-
|heli_dust
|a dust, as from the helicopter
|-
|jetpack
|a jetpacks fire
|-
|jetthrust
|fire from the muffler of the machine, as during use of nitrogen
|-
|nitro
|nitro
|-
|molotov_flame
|fire from a Molotov Cocktail
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|spark? maybe meant to be a mini red blood splash
|-
|prt_boatsplash
|foam
|-
|prt_bubble
|bubble
|-
|prt_cardebris
|splinters from a box
|-
|prt_collisionsmoke
|a dense white smoke
|-
|prt_glass
|a crashing glass
|-
|prt_gunshell
|shells
|-
|prt_sand
|sand, which was scattered
|-
|prt_sand2
|there is less sand, than in previous animation
|-
|prt_smokeII_3_expand
|a grey smoke
|-
|prt_smoke_huge
|there is a lot of grey smoke
|-
|prt_spark
|of a spark
|-
|prt_spark_2
|the large sparks
|-
|prt_splash
|burst
|-
|prt_wake
|a wave
|-
|prt_watersplash
|sparks
|-
|prt_wheeldirt
|sparks from wheels of the car
|-
|petrolcan
|a jet
|-
|puke
|belch
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|circles on water
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|water of a fountain
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|smoke
|}

==Related scripting functions==
===Client===
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[setEffectDensity]]

[[Category:Element Types]]