Multi Theft Auto: Wiki - User contributions [en]

HandlingSetPercentSubmerged

2025-08-17T09:21:01Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|getVehicleHandling}}
Sets what percentage of the vehicle will be submerged if it enters water. A percentage of 0 means that it will stand on top of the water surface, a value of 100 means that it will immediately sink.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetPercentSubmerged ( handling theHandling, float percentage )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the submersion percentage.
*'''percentage:''' the submersion percentage, a value from 0-100.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

SetVehicleRotorState

2025-07-26T09:52:46Z

Danzy:

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22862|
Turns the rotor on/off for an plane or helicopter. A vehicle with the rotor turned off cannot hover in the air.}}

{{Note|The function should not be confused with [[setVehicleEngineState]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleRotorState(vehicle theVehicle, bool state [, bool stopRotor = true ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:setRotorState|rotorState|getVehicleRotorState}}

===Required Arguments===
*'''theVehicle:''' The vehicle (helicopter or plane) whose rotor you want to toggle.
*'''state:''' The rotor state, which determines whether it should be on ('''true''') or off ('''false''').

===Optional Arguments===
*'''stopRotor:''' Specifies whether the rotor should be stopped after being turned off. If false, the rotor will continue spinning at a constant speed (it won't slow down or accelerate). It will also not be able to lift off the ground. You can also use [[setVehicleRotorSpeed]] to manage the rotor speed.

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

==Example==
<section name="Client" class="client" show="true">
This example code will add a command called '/rotorstart' that will either shut your vehicle's rotors off or start them up again. Do note that once rotors are stopped you will simply fall from the sky.
<syntaxhighlight lang="lua">
function rotorStartStop()
-- We need to check if the player is in a vehicle, and whether or not it is a plane or helicopter
local vehicle = getPedOccupiedVehicle(localPlayer)
if (not vehicle or (getVehicleType(vehicle) ~= "Helicopter" and getVehicleType(vehicle) ~= "Plane")) then
outputChatBox("You are not in a plane or helicopter!", 255, 0, 0)
return false
end
-- Set the rotor state depending on previous state and give a message
local rotorState = getVehicleRotorState(vehicle)
if (rotorState) then
setVehicleRotorState(vehicle, false)
outputChatBox("Your vehicle's rotor has been stopped, you will now drop out of the sky!", 255, 0, 0)
else
setVehicleRotorState(vehicle, true)
outputChatBox("Your vehicle's rotor has been started up, fly away!", 0, 255, 0)
end
end
addCommandHandler("rotorstart", rotorStartStop) -- Add our command handler
</syntaxhighlight>
</section>
==See Also==
{{Client vehicle functions}}

HandlingSetTractionMultiplier

2025-07-26T09:43:06Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete}}
{{Deprecated|getVehicleHandling}}
Sets the traction multiplier of a handling element. Low values will result in slippery tires, high values give good grip.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetTractionMultiplier ( handling theHandling, float traction )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the traction multiplier.
*'''traction:''' the traction multiplier to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetSuspensionHighSpeedDamping

2025-07-26T09:42:43Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete}}
{{Deprecated|getVehicleHandling}}
Sets the high speed suspension force of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetSuspensionHighSpeedDamping ( handling theHandling, float damping )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the high speed suspension damping strength.
*'''damping:''' the high speed damping strength to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetSuspensionAntidiveMultiplier

2025-07-26T09:42:10Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete}}
{{Deprecated|getVehicleHandling}}
Sets the suspension antidive multiplier of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetSuspensionAntidiveMultiplier ( handling theHandling, float antidive )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the suspension antidive multiplier.
*'''antidive:''' the antidive multiplier to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetSuspensionDamping

2025-07-26T09:42:03Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete}}
{{Deprecated|getVehicleHandling}}
Sets the suspension damping strength of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetSuspensionDamping ( handling theHandling, float damping )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the suspension damping strength.
*'''damping:''' the damping strength to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetSuspensionDamping

2025-07-26T09:41:44Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Deprecated|getVehicleHandling}}
Sets the suspension damping strength of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetSuspensionDamping ( handling theHandling, float damping )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the suspension damping strength.
*'''damping:''' the damping strength to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetSuspensionAntidiveMultiplier

2025-07-26T09:41:02Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Deprecated|getVehicleHandling}}
Sets the suspension antidive multiplier of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetSuspensionAntidiveMultiplier ( handling theHandling, float antidive )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the suspension antidive multiplier.
*'''antidive:''' the antidive multiplier to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetPercentSubmerged

2025-07-26T09:38:10Z

Danzy:

HandlingSetDriveType

2025-07-26T09:37:35Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|setVehicleHandling}}
Sets the drive type of a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetDriveType ( handling theHandling, string driveType )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the drive type.
*'''driveType:''' one of the following strings:
**'''rwd''' - rear wheel driven
**'''fwd''' - front wheel driven
**'''awd''' - all wheel driven

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}
[[Category:Archived]]

HandlingSetABS

2025-07-26T09:37:25Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|setVehicleHandling}}
Turns ABS on or off for a handling element.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetABS ( handling theHandling, bool ABS )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to toggle the ABS.
*'''ABS:''' ''true'' to turn ABS on, ''false'' to turn it off.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
<syntaxhighlight lang="lua">
function turnABS(thePlayer)
local theVehicle = getPedOccupiedVehicle(thePlayer) -- Get thePlayer vehicle
if not theVehicle then return end -- if the player is not in the vehicle then cancel
local ABS = getVehicleHandlingProperty(theVehicle,"ABS") -- We will use the additional function that you will find under this one. That will be more convenient.
if ABS == true then -- Check, if ABS is turn on then turn its off.
setVehicleHandling(theVehicle,"ABS",false)
outputChatBox("You turn off ABS",thePlayer)
else -- ABS is off. Turn on this.
setVehicleHandling(theVehicle,"ABS",true)
outputChatBox("You turn on ABS",thePlayer)
end
end
addCommandHandler("ABS",turnABS)

function getVehicleHandlingProperty ( element, property )
if isElement ( element ) and getElementType ( element ) == "vehicle" and type ( property ) == "string" then -- Make sure there's a valid vehicle and a property string
local handlingTable = getVehicleHandling ( element ) -- Get the handling as table and save as handlingTable
local value = handlingTable[property] -- Get the value from the table

if value then -- If there's a value (valid property)
return value -- Return it
end
end

return false -- Not an element, not a vehicle or no valid property string. Return failure
end

</syntaxhighlight>

==See Also==
{{Handling_functions}}
[[Category:Archived]]

HandlingGetTractionBias

2025-07-26T09:37:12Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|getVehicleHandling}}
Returns the traction bias of a handling element or vehicle ID. This determines how the grip is distributed over the front and back tires.

==Syntax==
<syntaxhighlight lang="lua">
float handlingGetTractionBias ( handling theHandling )
float handlingGetTractionBias ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the traction bias, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the traction bias.

===Returns===
If you specified a handling element, returns its traction bias if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the traction bias that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

The traction bias is a number between 0 and 1. If it is 0, the back tires have all the grip and the front have none. If it is 1, only the front tires have grip. A value of 0.5 will give both tires the same amount of grip.

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

==See Also==
{{Handling_functions}}

HandlingGetSuspensionFrontRearBias

2025-07-26T09:36:36Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|getVehicleHandling}}
Returns the suspension bias of a handling element or vehicle ID.

==Syntax==
<syntaxhighlight lang="lua">
float handlingGetSuspensionFrontRearBias ( handling theHandling )
float handlingGetSuspensionFrontRearBias ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the suspension bias, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the suspension bias.

===Returns===
If you specified a handling element, returns its suspension bias if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the suspension bias that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

The suspension bias is a number between 0 and 1. If it's 0, the back tires have all the suspension and the front tires have none. If it's 1, the front tires have suspension and the back tires have none. If it's 0.5, front and back tires have the same suspension strength.

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

==See Also==
{{Handling_functions}}

HandlingGetCenterOfMass

2025-07-26T09:35:06Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|getVehicleHandling}}
Returns the center of mass of a handling element or vehicle ID. This is a 3D vector relative to the center of the mesh.

==Syntax==
<syntaxhighlight lang="lua">
float float float handlingGetCenterOfMass ( handling theHandling )
float float float handlingGetCenterOfMass ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you wish to get the center of mass, ''or''
*'''int vehicleID:''' the vehicle ID of which you want to get the center of mass.

===Returns===
If you specified a handling element, returns the x, y and z components of the center of mass vector of the handling element if it is set, or ''nil'' if not. If you specified a vehicle ID, returns the x, y, and z components of the center of mass that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}
[[Category:Archived]]

HandlingGetBrakeBias

2025-07-26T09:34:42Z

Danzy:

__NOTOC__
{{Server function}}
{{Disabled}}
{{Delete|Function has been removed}}
{{Deprecated|getVehicleHandling}}
Returns the brake bias of a handling element or vehicle ID (the distribution of the braking power over the front and back tires).

==Syntax==
<syntaxhighlight lang="lua">
float handlingGetBrakeBias ( handling theHandling )
float handlingGetBrakeBias ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the brake bias, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the brake bias.

===Returns===
If you specified a handling element, returns its brake bias if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the brake bias that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

The brake bias is a value between 0 and 1. 0 means the car only brakes on its back tires, 1 that it only brakes on the front tires. 0.5 means that front and back tires brake with the same strength.

==See Also==
{{Handling_functions}}
[[Category:Archived]]

EngineResetModelLODDistance

2025-07-26T09:32:54Z

Danzy:

{{Client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20383|This function resets the LOD distance for an object / model ID.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineResetModelLODDistance ( int model )
</syntaxhighlight>
{{OOP||Engine.resetModelLODDistance}}
===Required Arguments===
*'''model:''' The model / object ID number you want to reset the LOD distance of.

===Returns===
Returns ''true'' if the LOD distance was reset to default, or ''false'' if the model argument is incorrect, or the LOD distance hasn't been changed.

==Example==
<section name="Client" class="client" show="true">
This code will reset all script spawned objects' LOD distances. It also implements a counter which will show how many objects have been affected by this script.
<syntaxhighlight lang="lua">
function resetLODs()
local count = 0 -- We add a counter for debug message
for ind, obj in ipairs(getElementsByType("object")) do
-- Get model, and reset it's LOD distance
local model = getElementModel(obj)
engineResetModelLODDistance(model)
-- Add one to counter
count = count + 1
end
outputDebugString("Reset LOD model distance for "..count.." objects", 3)
end
addEventHandler("onClientResourceStart", resourceRoot, resetLODs) -- We run this only when this resource (re)starts
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

GetPlayerTargetStart

2025-07-25T22:06:04Z

Danzy:

__NOTOC__
{{Client function}}
{{Deprecated|getPedTargetStart|}}

This function allows retrieval of the position a player's target range begins, when he is aiming with a weapon.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPlayerTargetStart ( player targetingPlayer )
</syntaxhighlight>

===Required Arguments===
*'''targetingPlayer:''' The player whose target start you wish to retrieve

===Returns===
Returns three floats, x,y,z, representing the position where the player's target starts, or false if it was unsuccessful.

==Example==
This page does not have an example
<syntaxhighlight lang="lua">
-- todo
</syntaxhighlight>

==See Also==
{{Player_functions}}

GetVehicleRotorState

2025-07-25T22:04:50Z

Danzy:

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22862|This function returns a vehicle's (plane or helicopter) rotor state (on or off).}}

{{Note|The function should not be confused with [[getVehicleEngineState]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleRotorState ( vehicle theVehicle )
</syntaxhighlight>

{{OOP||[[vehicle]]:getRotorState|rotorState|setVehicleRotorState}}

===Required Arguments===
*'''theVehicle''': the [[vehicle]] you wish to get the engine state of.

===Returns===
Returns '''true''' if the vehicle's rotor is started, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This code adds a simple command that allows you to check a vehicle's rotor state keeping in mind you have to be in either a plane or helicopter.
<syntaxhighlight lang="lua">
function checkRotor()
-- We need to check if the player is in a vehicle, and whether or not it is a plane or helicopter
local vehicle = getPedOccupiedVehicle(localPlayer)
if (not vehicle or (getVehicleType(vehicle) ~= "Helicopter" and getVehicleType(vehicle) ~= "Plane")) then
outputChatBox("You are not in a plane or helicopter!", 255, 0, 0)
return false
end
-- And now we show rotor state using a neat ternary expression
local rotorState = getVehicleRotorState(vehicle)
outputChatBox("Your vehicle's rotor is "..(rotorState and "spinning" or "stopped").."!", 0, 255, 0)
end
addCommandHandler("rotor", checkRotor)
</syntaxhighlight>
</section>

==See Also==
{{Client vehicle functions}}

GetVersion

2025-07-25T21:53:51Z

Danzy:

__NOTOC__
{{Server client function}}

This function gives you various version information about MTA and the operating system.

MTA already has a built in command '/ver' which will show you your client version. Alongside that, there is also '/sver' which will show you the version of the server you are currently connected to. This function unlike [[getPlayerVersion]] shows a lot more information regarding MTA version.
{{Note|Clientside will return the version from the player, and the server-sided will return version from the server.}}
{{Note|Current MTA version: {{CurrentVersion}}}}

==Syntax==
<syntaxhighlight lang="lua">table getVersion ( )</syntaxhighlight>

===Returns===
Returns a table with version information. Specifically these keys are present in the table:
*'''number:''' the MTA server or client version (depending where the function was called) in pure numerical form, e.g. ''"256"''
*'''mta:''' the MTA server or client version (depending where the function was called) in textual form, e.g. ''"1.0"''
*'''name:''' the full MTA product name, either ''"MTA:SA Server"'' or ''"MTA:SA Client"''.
*'''netcode:''' the netcode version number.
*'''os:''' returns the operating system on which the server or client is running
*'''type:''' the type of build. can be:
**'''"Nightly rX"''' - A nightly development build. '''X''' represents the nightly build revision.
**'''"Custom"''' - A build compiled manually
**'''"Release"''' - A build that is publicly released (provisional).
*'''tag:''' the build tag (from 1.0.3 onwards). Contains infomation about the underlying version used. i.e. The final version of 1.0.3 has the build tag of "1.0.3 rc-9". (This can be confirmed by using the console command 'ver'.)
*'''sortable:''' a 15 character sortable version string (from 1.0.4 onwards). Format of the string is described in [[getPlayerVersion]].

==Example==
<section name="Server" class="server" show="true">
This piece of code shows how you can use a simple command and a for loop to dump the output into chatbox, whilst capitalizing 1st character for extra bonus.
<syntaxhighlight lang="lua">
function showVersion(player)
-- We use a for loop to dump the output into player chatbox
outputChatBox("Version information (Server):", player, 0, 255, 0)
for ind, dat in pairs(getVersion()) do
-- Uppercasing first letter too
outputChatBox(string.upper(string.sub(ind, 1, 1))..string.sub(ind, 2)..": "..dat, player, 0, 255, 0)
end
end
addCommandHandler("version", showVersion) -- Define our command handler
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This piece of code shows how you can use a simple command and a for loop to dump the output into chatbox, whilst capitalizing 1st character for extra bonus. Keep in mind that this is the client sided version of this command which will output version information of your client, whilst the example above outputs information of the server you are connected to.
<syntaxhighlight lang="lua">
function showVersion()
-- We use a for loop to dump the output into player chatbox
outputChatBox("Version information (Client):", 0, 255, 0)
for ind, dat in pairs(getVersion()) do
-- Uppercasing first letter too
outputChatBox(string.upper(string.sub(ind, 1, 1))..string.sub(ind, 2)..": "..dat, 0, 255, 0)
end
end
addCommandHandler("version", showVersion) -- Define our command handler
</syntaxhighlight>
</section>

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

Compatibility FAQ

2023-09-02T13:18:08Z

Danzy:

== Compatibility Comparison ==
{{Warning|Using the legacy build is not without risk, there are known security issues in the Chrome Embedded Framework (CEF) that MTA:SA 1.5.7 uses for Windows XP and Vista. It is recommended that you upgrade from XP or Vista to a supported Windows version. (Windows XP and Vista are no longer supported by MTA after September 2019.) |true}}
{| class="wikitable"
|-
! Operating System
! Service Pack/Version
! Release Date
! Supported by Microsoft<ref>https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet</ref>
! Does MTA:SA {{Current Version|full}} work?
! Chrome Embedded Framework
Updates
! Future MTA:SA
releases/updates
|-
| Windows XP
| Service Pack 3
| August 2001
| {{No}}
| {{No}}
| {{No}}
| {{No|1.5.7 was the last version}}
|-
| Windows Vista
| Service Pack 2
| November 2006
| {{No}}
| {{No}}
| {{No}}
| {{No|1.5.7 was the last version}}
|-
| Windows 7
| Service Pack 1
| July 2009
| {{No}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| Windows 8.0
| {{n/a}}
| August 2012
| {{No|No, upgrade to 8.1<ref>https://support.microsoft.com/en-us/help/15288/windows-8-update-to-windows-8-1</ref>}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| Windows 8.1
| {{n/a}}
| August 2013
| {{No|No, upgrade to 10}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
|rowspan=12 | Windows 10<ref>([https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet])</ref>
| 1507
| July 2015
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1511
| November 2015
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1607
| August 2016
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1703
| April 2017
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1709
| October 2017
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1803
| April 2018
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1809
| September 2018
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1903
| May 2019
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 1909
| November 2019
| {{No}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|-
| 2004
| May 2020
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| 20H2
| October 2020
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| 21H1
| May 2021
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
|rowspan=1 | Windows 11<ref>([https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet])</ref>
| 21H2
| {{n/a}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
| {{n/a}}
|}

* Please use a supported version of Windows 10 to run MTA.
* There are no guarantees that MTA will work on older not by Microsoft supported Windows 8 and 10 versions.

== FAQ - Frequently Asked Questions ==
=== Google is dropping XP/Vista support for Chrome browser? What does this even have to do with MTA:SA? ===
As you may know from our previous [https://forum.mtasa.com/topic/75559-mtasa-15-release-candidate-is-ready-for-testing/ news posts], MTA:SA uses CEF (Chrome Embedded Framework) components for providing some functionality for the mod since version 1.5. Being Chromium-based, CEF components are also being phased out for users of older Operating Systems and will simply not work on them.<ref>https://bitbucket.org/chromiumembedded/cef</ref>

=== Does MTA:SA 1.5.7 work fine on Windows XP and Windows Vista? ===
Yes, it works fine if you install it through the legacy build. We still can not really recommend using these systems anymore due to the reasons listed below.

CEF compatibility issue aside, these Operating Systems (XP especially) are really old nowadays. You are putting yourself at risk if you use them as they are either no longer supported by Microsoft (XP) or the support will be discontinued soon (April 2017 - Vista).

=== What will happen if I try to use the regular build of 1.5.7 on Windows XP/Vista? ===
MTA:SA installer will display an error and will not let you install the mod on such systems. You will be asked to download the legacy build from our website.

=== And what will happen if I try to use the legacy build of 1.5.7 on Windows 7 and above? ===
Similarly, MTA:SA installer will display an error and will not let you install the mod on such systems. You will be asked to download the regular build from our website.

=== Why couldn't you just stick to the older version of CEF then so that XP/Vista would be still supported? / What about releasing two versions of the mod? A regular one with newest CEF and a legacy one with the older CEF build that still works on XP/Vista? ===
Hey, but we actually do provide a legacy build for MTA:SA 1.5.7 for XP/Vista users with an older version of CEF components.

The problem with sticking with either of these options is that we would have to continue providing a version that is vulnerable to any present and future security exploits that exist in Chromium and are already widely used. We do not want to put our users at risk because of that. CEF developers themselves do not want to provide long-term security support for such a build either. <ref>http://www.magpcss.org/ceforum/viewtopic.php?f=6&t=14187</ref>

=== I am playing the mod on Windows 7/Windows 8/Windows 8.1/Windows 10 or newer. Am I affected by this? ===
No, you will not be affected at all. In fact, you will have a better experience with built-in web browser components than before due to security and performance fixes included in the newer CEF versions.

=== I am using Windows XP/Vista and I would still like to play future versions of MTA:SA. What can I do about it? ===
If you are using Windows XP or Windows Vista, you should upgrade your OS to a newer one. You will likely be required to do a clean install for that, so back up your stuff first. You should use these tools first to see if your PC is capable of upgrading to newer OS:

Windows 7: [https://www.microsoft.com/en-us/download/details.aspx?id=20 Windows 7 Upgrade Advisor]
Windows 8/10: [http://go.microsoft.com/fwlink?linkid=259439 Windows 8 Upgrade Assistant]

Is your PC toaster-tier which does not support Windows 8 or even 7? That means it is probably the right time to buy something more modern.

But fear not, if you are already using Windows 7 or newer, just install the newest build of MTA:SA 1.5.7 and you are set! And if you don't want to upgrade your OS or PC, well, we will keep offering the legacy build that works on XP/Vista for a while...

== Notes ==
<references />

== See also ==
* [https://forum.mtasa.com/topic/89685-mtasa-windows-xpvista-cef-components-and-you/ Topic about the compatibility changes]

ClearDebugBox

2021-10-12T09:35:10Z

Danzy: /* Example */

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20854|This function clears the debug box.}}

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

===Returns===
Always returns ''true''.

==Example==
<section name="Client" class="client" show="true">
This example clears the debug window when any new debug message is displayed:
<syntaxhighlight lang="lua">
addEventHandler ("onClientDebugMessage", root,
function ()
clearDebugBox ()
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.5.8-9.20854|}}

==See Also==
{{Client_output_functions}}

GetPlayerMapOpacity

2021-10-12T09:31:56Z

Danzy: /* Example */

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20945|This function allows to get the opacity of the radar map (F11).}}

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerMapOpacity ( )
</syntaxhighlight>
{{OOP||[[player]].getMapOpacity}}

===Returns===
Returns an [[integer]] with a value from 0 to 255, where 0 is fully transparent and 255 is fully opaque.

==Example==
<section name="Client" class="client" show="true">
This example implements a command that tells you what your current map opacity is.
<syntaxhighlight lang="lua">
function showMapOpacity()
-- We get the map opacity value
local mapOpacity = getPlayerMapOpacity()
-- We tell what the map opacity is to the player
outputChatBox("Your map's opacity is at "..mapOpacity, 0, 255, 0)
end
addCommandHandler("mapopacity", showMapOpacity)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.5.8-9.20945}}

==See Also==
{{Client_player_functions}}

ResetAmbientSounds

2018-12-21T22:48:57Z

Danzy:

__NOTOC__
{{Client function}}
This function is used to reset the background sounds to the default setting.

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

===Returns===
Returns true if the ambient sounds were reset, false otherwise.

==Example==
<syntaxhighlight lang="lua">
function resetAmbient()
resetAmbientSounds() --This will reset the Ambient Sounds of the game
end
addCommandHandler("resetambient", resetAmbient) -- If you use this command it would trigger the resetAmbient function
</syntaxhighlight>

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

OnElementClicked

2018-08-22T18:46:59Z

Danzy: /* Examples */

__NOTOC__
{{Server event}}
This event is triggered when an element is clicked on by the client. These events can only trigger when the client has its cursor enabled. It triggers for all three mousebuttons in both their up and down states.

==Parameters==
<syntaxhighlight lang="lua">
string mouseButton, string buttonState, player playerWhoClicked, float clickPosX, float clickPosY, float clickPosZ
</syntaxhighlight>

*'''mouseButton''': a [[string]] representing the mouse button that was clicked. This might be ''left'', ''middle'' or ''right''.
*'''buttonState''': a [[string]] representing what state the button clicked is in. This might be ''up'' or ''down''.
*'''playerWhoClicked''': the [[player]] that clicked on the [[element]].
*'''clickPosX''': the X position in the world the [[player]] clicked at.
*'''clickPosY''': the Y position in the world the [[player]] clicked at.
*'''clickPosZ''': the Z position in the world the [[player]] clicked at.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that got clicked by the player.

==Examples==
This example prints type of the element you clicked to chatbox when you click it.
<syntaxhighlight lang="lua">
function elementClicked( theButton, theState, thePlayer )
if theButton == "left" and theState == "down" then -- if left mouse button was pressed down
outputChatBox( "You clicked " .. getElementType( source ), thePlayer ) -- print the element type to players chatbox
end
end
addEventHandler( "onElementClicked", root, elementClicked ) -- add a handler function for the event
</syntaxhighlight>

This example check if the clicked element is a vehicle. If is, then repairs it.
<syntaxhighlight lang="lua">
function repairClickedVehicle( button, state, player ) -- Add the function
if button == "left" and state == "down" then
if getElementType( source ) == "vehicle" then -- If the clicked element is a vehicle...
local x, y, z = getElementPosition( player )
local x1, y1, z1 = getElementPosition( source )
local distance = getDistanceBetweenPoints3D( x, y, z, x1, y1, z1 ) -- Some distance calculations
if distance < 4 then -- Check if the player is near the vehicle
if getElementHealth( source ) < 1000 then
fixVehicle( source )
outputChatBox( "You have repaired a "..getVehicleNameFromModel( getElementModel( source ) ), player, 0, 255, 0 )
else
outputChatBox( "Vehicle is not damaged!", player, 255, 0, 0 )
end
end
end
end
end
addEventHandler( "onElementClicked", root, repairClickedVehicle ) -- Add the event handler
</syntaxhighlight>
{{See also/Server event|Element events}}

SetWeather

2018-08-21T19:09:00Z

Danzy: /* Example */

__NOTOC__
{{Server client function}}
This function sets the current [[weather]] to the given valid value. To change the weather gradually, see [[setWeatherBlended]].

==Syntax==
<syntaxhighlight lang="lua">
bool setWeather ( int weatherID )
</syntaxhighlight>

===Required Arguments===
*'''weatherID''': The ID of new [[weather]]. Valid values are 0 to 255 inclusive.

===Returns===
Returns ''true'' if the weather was set succesfully, ''false'' if an invalid ''weatherID'' was specified.

==Example==
This example will change the weather to foggy.
<syntaxhighlight lang="lua">
setWeather ( 9 )
outputChatBox ( "Weather changed to foggy!" )
</syntaxhighlight>

<section class="server" name="Server" show="true">
This example allows you to change weather with a command. (Anything above 255 resets, so 256 will be 0 and so on)
<syntaxhighlight lang="lua">
function changeWeather(player, command, weatherID)
if (not weatherID or not tonumber(weatherID)) then --Check if weatherID is a number
outputChatBox("You must enter a valid weather ID number", player, 255, 0, 0)
return false
end

setWeather(weatherID) --Set the weather and let the player know he did it
outputChatBox("Weather successfully changed to ID "..weatherID, player, 0, 255, 0)
end
addCommandHandler("weather", changeWeather)
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setWeather]]

SetWeather

2018-08-21T19:05:28Z

Danzy: /* Example */

__NOTOC__
{{Server client function}}
This function sets the current [[weather]] to the given valid value. To change the weather gradually, see [[setWeatherBlended]].

==Syntax==
<syntaxhighlight lang="lua">
bool setWeather ( int weatherID )
</syntaxhighlight>

===Required Arguments===
*'''weatherID''': The ID of new [[weather]]. Valid values are 0 to 255 inclusive.

===Returns===
Returns ''true'' if the weather was set succesfully, ''false'' if an invalid ''weatherID'' was specified.

==Example==
This example will change the weather to foggy.
<syntaxhighlight lang="lua">
setWeather ( 9 )
outputChatBox ( "Weather changed to foggy!" )
</syntaxhighlight>

This example allows you to change weather with a command. (Anything above 255 resets, so 256 will be 0 and so on)
<syntaxhighlight lang="lua">
function changeWeather(player, command, weatherID)
if (not weatherID or not tonumber(weatherID)) then --Check if weatherID is a number
outputChatBox("You must enter a valid weather ID number", player, 255, 0, 0)
return false
end

setWeather(weatherID) --Set the weather and let the player know he did it
outputChatBox("Weather successfully changed to ID "..weatherID, player, 0, 255, 0)
end
addCommandHandler("weather", changeWeather)
</syntaxhighlight>

==See Also==
{{World functions}}

[[ru:setWeather]]