Multi Theft Auto: Wiki - User contributions [en]

EngineStreamingRestoreMemorySize

2026-01-19T21:58:42Z

Qaisjp:

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6.0|21874|Restores the maximum amount of RAM [in bytes] that can be used for streaming to the default value}}
{{Tip|The function to manipulate the memory size is [[engineStreamingSetMemorySize]]}}

==Syntax==
<syntaxhighlight lang="lua">
nil engineStreamingRestoreMemorySize()
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:restoreMemorySize||}}

==Example==
This example adds a command that can be used to change the streaming memory size, and display the previous value.
<syntaxhighlight lang="lua">
addCommandHandler("rsms", function()
local prevMB = math.floor(engineStreamingGetMemorySize() / 1024 / 1024)
engineStreamingRestoreMemorySize()
outputChatBox("The maximum streaming memory available has been restored to the original value of " .. math.floor(engineGetStreamingMemorySize() / 1024 / 1024) .. " MB [Was " .. prevMB .. " MB]")
end, false, false)
</syntaxhighlight>

==See Also==
{{Engine functions}}

EngineStreamingRestoreMemorySize

2026-01-19T21:58:27Z

Qaisjp:

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6.0|21874|Restores the maximum amount of RAM [in bytes] that can be used for streaming to the default value}}
{{Tip|The function to manipulate the memory size is [[engineStreamingSetMemorySize]]}}

==Syntax==
<syntaxhighlight lang="lua">
nil engineStreamingRestoreMemorySize()
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:restoreMemorySize||}}

==Example==
This example adds a command that can be used to change the streaming memory size, and display the previous value.
<syntaxhighlight lang="lua">
addCommandHandler("rsms", function()
local prevMB = math.floor(engineGetStreamingMemorySize() / 1024 / 1024)
engineStreamingRestoreMemorySize()
outputChatBox("The maximum streaming memory available has been restored to the original value of " .. math.floor(engineGetStreamingMemorySize() / 1024 / 1024) .. " MB [Was " .. prevMB .. " MB]")
end, false, false)
</syntaxhighlight>

==See Also==
{{Engine functions}}

EngineStreamingRestoreMemorySize

2026-01-19T21:58:13Z

Qaisjp:

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6.0|21874|Restores the maximum amount of RAM [in bytes] that can be used for streaming to the default value}}
{{Tip|The function to manipulate the memory size is [[engineStreamingSetMemorySize]]}}

==Syntax==
<syntaxhighlight lang="lua">
nil engineStreamingRestoreMemorySize()
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:restoreMemorySize||}}

==Example==
This example adds a command that can be used to change the streaming memory size, and display the previous value.
<syntaxhighlight lang="lua">
addCommandHandler("rsms", function()
local prevMB = math.floor(engineGetStreamingMemorySize() / 1024 / 1024)
engineStreamingRestoreMemorySize()
outputChatbox("The maximum streaming memory available has been restored to the original value of " .. math.floor(engineGetStreamingMemorySize() / 1024 / 1024) .. " MB [Was " .. prevMB .. " MB]")
end, false, false)
</syntaxhighlight>

==See Also==
{{Engine functions}}

SetPedEnterVehicle

2026-01-06T00:49:43Z

Qaisjp:

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20740|This function makes a [[ped]] enter a [[vehicle]], similar to the enter_exit control state.}}
{{Note|This function only works on synced peds and vehicles (ie. created serverside).}}
{{Note|This function only works within the following limits:
* If forced to enter as a passenger, it doesn't work if all passenger seats are occupied. Only the driver seat can be jacked.
* If forced to enter as a driver, the ped can carjack the current driver.
** If the driver's door is blocked by something, the ped can use the opposite front door to reach the driver's seat, jacking the passenger in the process.
* If a vehicle is not specified:
** The ped will search for a vehicle door within 20 m.
** If the vehicle has a driver, the limit becomes 10 m.
* If a vehicle is specified:
** The vehicle has to be within 50 m. The doors aren't taken into account. It means that it doesn't work if the vehicle's door is in range but the vehicle itself is not.
** If the vehicle has a driver, the limit becomes 10 m.
* When entering, the ped will run toward a vehicle if it is less than 50 m away.
* The ped reserves the seat it is trying to use. It means nobody can enter the respective seat while the ped is running toward it.
** Exception: If the ped is forced to enter as a passenger and is going to use the front door, the ped can wait if someone is using it to go the driver seat.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedEnterVehicle ( ped thePed [, vehicle theVehicle = nil, bool passenger = false ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[player]] or [[ped]] to enter the vehicle.
**''Note: The player must be the local player.''
**''Note: The ped must be synced by the client. Use [[isElementSyncer]] clientside to check if the client is syncing. Use [[setElementSyncer]] serverside to change the syncer manually.''
*'''vehicle:''' The [[vehicle]] to enter. If no vehicle is set, the ped will enter the nearest vehicle within 20 m.
*'''passenger:''' If set to ''true'', the ped will enter as passenger in the nearest available seat, otherwise he will enter as driver.

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

When this function returns ''true'', the client will ask server for permission to enter a vehicle. Actually entering can still fail in the following cases
*Another player or ped is already entering, exiting or jacking the same vehicle and seat.
*Movement input or damage can interrupt the task. Use [[getPedTask]] to monitor what the ped is doing.

This function returns ''false'' in the following cases
*Invalid arguments were parsed.
*Time passed since last enter/exit for this ped is less than 1500 ms.
*[[onClientVehicleStartEnter]] was cancelled by a script.
*The ped has an active TASK_PRIMARY [[task]]. Use [[getPedTask]] to monitor what the ped is doing.

==Example==
Make [[ped]] Sweet enter his car:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local sweet = createPed (270, 0, 0, 3)
setElementID (sweet, "sweet")

local sweetscar = createVehicle (492, 3, 0, 3)
setElementID (sweetscar, "sweetscar")
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- Code works only if client is syncing ped Sweet
addCommandHandler ("sweetentercar",
function()
local sweet = getElementByID ("sweet")

if isElementSyncer (sweet) then
setPedEnterVehicle (sweet, getElementByID("sweetscar"), true)
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Client ped functions}}

ResetMapInfo

2026-01-06T00:38:33Z

Qaisjp: fix gender

{{Server function}}
__NOTOC__
This function is used to reset the state of a player. It is intended to restore a player to their default state as if they had just joined the server, without any scripts affecting the player.

==Syntax==
<syntaxhighlight lang="lua">
bool resetMapInfo ( [ player thePlayer = root ] )
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''thePlayer:''' The specific player you wish to restore the state of. Not specifying this will result in all players map info being reset.

==Returns==
Returns ''true'' if the map info was reset successfully, otherwise ''false''.

==Example==
This will reset all map info when the resource is stopped.
<syntaxhighlight lang="lua">
function onResourceStop()
resetMapInfo()
end
addEventHandler("onResourceStop", resourceRoot, onResourceStop)
</syntaxhighlight>

==See Also==
{{Map_functions}}

Compiling MTASA

2026-01-03T23:17:49Z

Qaisjp: 2022 -> 2026

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

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

= [[File:Dialog-warning.svg|32px]] Prerequisites =

Compiling the Multi Theft Auto client & server is supported on Windows 10 and 11. On Linux, you can also compile the Multi Theft Auto server ([[Building MTASA Server on GNU Linux|check this article]]).

[[File:Emblem-important.svg|24px]] '''Skipping any prerequisite steps will lead to unexpected build failures. Read the sections below carefully to understand the entire developer workflow.'''

[[File:Process-stop.svg|24px]] '''There are solutions to common problems you may encounter in the [[#Error Troubleshooting]] section below.'''

Make sure you have the following software and SDKs installed:

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

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

== Microsoft DirectX SDK ==
[[File:DirectX_SDK.jpg|right|150px|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download and install Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''
* [https://archive.org/download/dxsdk_aug09/DXSDK_Aug09.exe Mirror 1 (archive.org)]
* [https://mega.nz/file/pQJCiAJY#jBcYT6ZP4DMBpnm12BLRto9EQ-RjjpP3BWkSPanpvLI Mirror 2 (mega.nz)]

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

See [[Compiling_MTASA/DXSDK_Aug09_Hashes|DXSDK Aug09 Hashes]] for file hashes of the installer.

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

If you would like to contribute to MTA, you should use Git. This will allow you to collaborate with us by creating branches and pushing changes to [https://github.com/multitheftauto/ GitHub].

[https://learn.microsoft.com/en-us/visualstudio/version-control/git-with-visual-studio '''Visual Studio''' comes with a Git client] that you can use to manage your local repository. You should fork the [https://github.com/multitheftauto/mtasa-blue mtasa-blue repository] and clone on your machine.

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

=[[File:Document-save.svg|32px]] Getting the latest source code=

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

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

=[[File:Media-floppy.svg|32px]] Compiling the code=

Follow these steps to successfully build the '''mtasa-blue''' project.

# Execute the script '''win-create-projects.bat'''. This installs dependencies and generates the Visual Studio project files that are mandatory to compile the code.
# Open the solution file '''MTASA.sln''' in the '''Build''' directory. If you are asked to upgrade the project, click '''Cancel'''.
# Select '''Debug''' - '''Win32''' configuration in Visual Studio, then press Build > Build Solution (may take some minutes).
# Alternatively, you may execute the script '''win-build.bat''', which runs the previous mentioned steps, without the need to open Visual Studio.
# Finally, execute the script '''win-install-data.bat'''. This copies important files to the Bin directory that are required for MTA to function. It gives you the option to '''Install the official resources''', which you can read about in the [[#Running the dedicated server]] section below.

=[[File:Input-gaming.svg|40px]] Running the software=

This section contains information on how to run the Multi Theft Auto client and server separately.

== Running the client ==

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

== Running the dedicated server ==

If you already have run '''win-install-data.bat''' and selected "''Install resources''" then you can go to [[#Starting the server]].

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the official resources. This default package includes resources that implmenent the most basic functionality (e.g. spawning players) in order to play.

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

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

= [[File:Preferences-system.svg|32px]] Debugging =
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build. 
To compile in '''Release''', click on the '''Debug''' list and switch to '''Release'''. 
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio. 
[[File:Local_Windows_Debugger.PNG]]

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

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

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

= [[File:System-users.svg|32px]] Getting involved =
Please see our [[Coding guidelines]] for information on the coding practice.

= [[File:Mail-reply-all.svg|32px]] Additional information =
If you need more information, try our [https://github.com/multitheftauto/mtasa-blue/issues bug tracker] or [https://discord.com/invite/mtasa Discord].

= Error Troubleshooting =

==Cannot open include file 'afxres.h'==
This error is caused by your incomplete Visual Studio configuration. Use the Visual Studio Installer to enable Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''.

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

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

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

==Cannot open source file "xxx.h" after upgrading to Visual Studio 2022==
If you've just upgraded to Visual Studio 2022 and were working on MTA using a previous version, you may receive errors about header files not being found (stdio.h, stddef.h, etc) when building the project.

Make sure you have the latest Windows 10 SDK installed (via the Visual Studio Installer) and restart your PC.

If that doesn't work - close Visual Studio, go into the `Build` folder (where your mtasa-blue is located) and delete the `.vs` folder. Start Visual Studio and everything should be fixed.

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

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

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

== ERROR: Loading network library (net_d.dll) failed! ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[pl:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]

[[Category: Development]]

Template:Vehicle functions

2020-12-29T14:40:12Z

Qaisjp: hide train functison

*[[addVehicleSirens]]
*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getModelHandling]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainPosition]]
*[[getTrainSpeed]]

*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
{{New items|3.0156|1.5.5|
*[[getVehicleRespawnPosition]]
*[[getVehicleRespawnRotation]]
|14053}}
*[[getVehicleSirenParams]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
{{Deprecated items|3.0156|1.5.6|
*[[getVehicleTurnVelocity]]
}}
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleUpgrades]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[getVehiclesOfType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
*[[removeVehicleSirens]]
*[[removeVehicleUpgrade]]
*[[resetVehicleExplosionTime]]
*[[resetVehicleIdleTime]]
*[[respawnVehicle]]
*[[setModelHandling]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainPosition]]
*[[setTrainSpeed]]

*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleHandling]]
*[[setVehicleHeadLightColor]]
*[[setVehicleIdleRespawnDelay]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleRespawnDelay]]
*[[setVehicleRespawnPosition]]
{{New items|3.0156|1.5.5|
*[[setVehicleRespawnRotation]]
|14280}}
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTaxiLightOn]]
*[[setVehicleTurretPosition]]
{{Deprecated items|3.0156|1.5.6|
*[[setVehicleTurnVelocity]]
}}
*[[setVehicleVariant]]
*[[setVehicleWheelStates]]
*[[spawnVehicle]]
*[[toggleVehicleRespawn]]

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

Coding guidelines

2020-12-22T16:43:15Z

Qaisjp: anchor link

= [https://github.com/multitheftauto/mtasa-blue/blob/master/CONTRIBUTING.md#contributors-guide These guidelines are now on GitHub] =

Coding guidelines

2020-12-22T16:42:29Z

Qaisjp: CONTRIBUTING.md has been merged and replaces this page

= [https://github.com/multitheftauto/mtasa-blue/blob/master/CONTRIBUTING.md These guidelines are now on GitHub] =

GetAnalogControlState

2020-11-20T21:49:31Z

Qaisjp: fix ver

__NOTOC__
{{Client function}}
This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.

To get the analog control state for a [[ped]], please use [[getPedAnalogControlState]].

==Syntax==
<syntaxhighlight lang="lua">float getAnalogControlState ( string control [, bool rawValue ] )</syntaxhighlight>

===Required Arguments===
*'''control:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.

===Optional Arguments===
{{New feature/item|3.0157|1.5.7|20383|
*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.
}}

===Returns===
Returns a [[float]] between 0 and 1 indicating the amount the control is pressed.

==Example==
This creates an ''/forwards'' command, which toggles your ''forwards'' control state between 0 and 1.
<syntaxhighlight lang="lua">
addCommandHandler( "forwards",
function( )
if ( getAnalogControlState( "forwards" ) == 0 ) then
setAnalogControlState( "forwards", 1 )
else
setAnalogControlState( "forwards", 0 )
end
end
)
</syntaxhighlight>

==See Also==
{{Client input functions}}

MacOS

2020-11-08T00:43:57Z

Qaisjp: make warning bigger for people that can't read

<div style="font-size: 2em; line-height: 1em;">{{Warning|This page is intended for developers. If you are here looking for instructions to install the client on macOS, [https://gist.github.com/qaisjp/778ed99ac8a8dcb93f797a28ba5f8303 please read this page!]}}</div>

This page is incomplete, and is still being updated by developers. If you are here to learn how to run MTA on OS X, you only need to read the first section "[[#Making_Your_Own_Wrapper|Making Your Own Wrapper]]".

Contact [[User:qaisjp]] if you need any help with anything on this page.

=== User Experience ===
This section outlines what our automated version will do.

A ''.dmg'' file will be distributed. EULAs can be embedded within ''.dmg'' files.

This file will contain a link to the Applications folder and the Multi Theft Auto application. The user is expected to transfer the application to the applications directory before running.

'''The application will''':
* confirm we are not running from an img file
* check if there is currently a valid GTA:SA directory
** if not, prompt for a directory.
** Wineskin does not support symbolic links. Once the directory has been chosen, we copy the gta_sa.exe file over and directory junction the rest of the files.
* start Multi Theft Auto for us automatically

== Making Your Own Wrapper ==
This section is written like a tutorial for public consumption, but is intended to serve as working documentation to aid the automated version in development. It is recommended that you read through this entire section (including the "Tips" section at the bottom) before following the tutorial, if you wish to build your own Wineskin wrapper. You do not need to read any other sections.

=== Grabbing the Winery===
* Grab the [http://wineskin.urgesoftware.com/tiki-index.php?page=Downloads Wineskin Winery]. At the time of writing, v1.7. This allows you to create your own wrapper.
* Open ''Wineskin Winery.app'', and [[Media:MacOS_wineskin_tut1.png|click "Update" underneath "No Wrapper Installed" to download the master wrapper.]].
* Now click the + plus button. This will bring up a new window titled "Add Engine".
* Select the latest engine (at the time of writing, WS9Wine1.9.15) and [[Media:MacOS_wineskin_tut2.png|click the blue "Download and Install" button]].
* Now you can [[Media:MacOS_wineskin_tut3.png|click "Create New Blank Wrapper" button at the bottom of the "Wineskin Winery" window]].
* Call the application whatever you like, "Multi Theft Auto" is a good name to use.
* [[Media:MacOS_wineskin_tut4.png|You may receive a firewall dialog.]] Press "Yes".
* Allow the wrapper to be created. This will take some time.
* A new wrapper will be generated in the Applications folder '''in your home folder'''. It will not appear in your main Applications folder (which resides in the root of your drive, for all the users).

Now we have generated an empty wrapper, we need to add GTA, install MTA, and configure some other settings.

=== Running San Andreas ===
Firstly, we will test out Grand Theft Auto: San Andreas. For the sake of this tutorial we will assume that you already have a folder containing your GTA:SA files (copied over from a Windows installation). You ''may'' need a no-cd version of the exe.

* Right click your main wrapper app (in my case, "MTASA.app") and press "Show package contents"
* [[Media:MacOS_wineskin_tut5.png|There should be three items inside here.]] Open the ''drive_c'' shortcut, open ''Program Files'', and create a folder called ''Rockstar Games''.
* Copy (or move) your ''GTA San Andreas'' folder here.
* [[Media:MacOS_wineskin_tut6.png|Your drive_c folder should now look a bit like this.]]
* Now select ''Wineskin.app'' (which inside our main app). [[Media:MacOS_wineskin_tut7.png|This application allows us to configure our wrapper.]]
* Select "Advanced" to bring up a window titled "Wineskin Advanced".
* Click the "Browse" button next to the "Windows EXE" field and navigate to ''gta_sa.exe''. [[Media:MacOS_wineskin_tut8.png|The window should now look like this.]]
* Press "Set Screen Options" at the bottom of the window, and make sure you deselect "Decorate windows", and select "Use Direct3D boost". [[Media:MacOS_wineskin_tut9.png|It should be configured like this.]] '''[http://wineskin.urgesoftware.com/tiki-view_blog_post.php?postId=87 High Sierra (and above) users must read these instructions.]'''
* Click Done. On the "Wineskin Advanced" window, press "Test Run" and San Andreas will begin to run. Note that it will take some time for it to run.
* After the two GTASA startup logos display, press any key to skip the splash screen.
* After you've tried the game a little, quit. You may close (press Cancel) the dialog box that asks you whether you want to view logs.

=== Running Multi Theft Auto ===
Now we need to install Multi Theft Auto.
* Some font files are required for MTA to run. Copy the font files (''.ttf'') from {{WineFonts}} and extract them to `drive_c/windows/fonts` (inside our wrapper). You may have to create the fonts folder yourself if it does not exist.
* Download the installer from [https://multitheftauto.com the homepage].
* Open Wineskin.app (inside our wrapper) and select "Install Software", and then select "Choose Setup Executable".
* Navigate to the ''.exe'' installer (that should be inside your Downloads folder) and allow Wineskin to load it.
* Proceed with the installer as usual. '''Do not change the Destination Folder for where MTA will be installed.'''
* The installer may encounter errors ''Unable to install Microsoft Visual Studio 20xx redistributable''. It is okay to ignore these.
* Deselect ''Run MTA'' when you have finished installing.
* Press "Advanced" on the Wineskin window, and now browse to the ''Multi Theft Auto.exe'' file.
* Perform a Test Run, and hopefully Multi Theft Auto should run!

=== Tips ===
* You can use the keybind Cmd+Opt+A at any time to switch between windowed & fullscreen. You may need to use this if you cmd+tab out of the app, and the app ends up moving to windowed mode.
* If you are asked at any time to install Gecko or Mono, simply press yes.
* If you receive the message "Warning: Could not detect anti-virus product" when starting MTA, simply check the box saying "I will not install an anti-virus", and press OK. This message occurs because MTA cannot detect OS X antiviruses.

[[Category:Development]]<lowercasetitle></lowercasetitle>

Anti-cheat guide

2020-10-31T04:29:37Z

Qaisjp: remove incorrect wiki syntax

This guide explains how you can fine-tune MTA's anti-cheat on your server using [[Server_mtaserver.conf|'''mtaserver.conf''']]. It does not allow players to modify their own AC settings.

An anti-cheat helper resource, '''acpanel''', is included as a default resource. This shows the current anti-cheat status of your server, along with an option to keep your clients up to date and a basic implementation of [[onPlayerModInfo]] to block modified img files.

You may want to fine-tune AC to prevent certain players have from having an unfair advantage or to ensure competitive integrity. The settings you provide depends entirely on the kind of server you run. Here are some examples on what can be achieved:

* '''Problem:''' Alice tries to ram the vehicle of Eve, and Alice can clearly see the collision, but Eve's vehicle is not really moving.
: '''Explanation:''' Eve has changed their vehicle model to a much smaller vehicle, or a model with a tiny hitbox or (nearly absent) collisions.
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Eve seems to be using wallhacks! She even seems to even be shooting through them!
: '''Explanation:''' Eve has replaced buildings so that they are either invisible (textures) or tiny (models).
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Mallory seems to be solving complex maths questions instantly! It should take at least a couple of seconds... for humans.
: '''Explanation:''' Mallory is injecting keyboard input via something like AutoHotkey
: '''Solution:''' Enable SD #31 to prevent users from injecting keyboard input. You can use SD #32 for injected mouse input (e.g. for scripts that require natural skill from mouse input)

* '''Problem:''' Mallory seems to be spamming my commands and GUI... and it lags my entire server!
: '''Explanation:''' You are running expensive user-initiated code without rate limiting players.
: '''Solution:''' You should write code that prevents players from spamming certain actions.
: '''Lazy Solution:''' Enable SD #31/#32 to make it more difficult for players to spam certain actions.

__TOC__

==<disableac></disableac>==
Comma separated list of disabled anti-cheats. This setting disables specific AC codes. If a detection is triggered and it's not disabled by the server, a player will get kicked and be shown the AC code corresponding to that detection. '''Note that the list is incomplete''' (it doesn't cover all AC codes that exist) because not all AC codes can be disabled for security reasons, e.g they are critical part of the anti-cheat and likewise we will also never provide information about what exactly they mean.

'''DISCLAIMER''':
Please note that disableac will only void the AC # kick for using GTA singleplayer cheats and some very basic, outdated and patched MP cheats (such as s0beit). Hacks & cheats designed for MTA or other general hacking tools may still trigger a Global ban or kick.
If you try to use a typical MTA cheat or hacktool under the belief using disableAC will save your day, and get banned for a while, it's your own fault, regardless of this setting being used to disable any of the AC classifications that it may fall under.

There is also a good chance that disabling certain detections won't enable your players to (even) use the majority of 'basic' GTA:SA trainers, but result in a kick only.
Due to the current state of MTA anti-cheat, and its advanced heuristics, it's simply not feasible to try and create a freehaven for cheaters. You can experiment, but we don't recommend using '''disableac''' for these reasons.

'''Note''': With '''trainer''', cheats (for MTA or GTA) or forbidden cheat tools are meant. This is especially true for AC #4.
Please note that getting kicked for anything listed here isn't neccesarily (intended) hacking, someone can open hacktools that they plan to use for another game, while both that game and MTA are opened, and be kicked.
It's also possible that someone isn't aware of certain software containing hack/tamper features (making it prohibited) when they run it and get kicked.
Basically, (the intent of) cheating on MTA or your server can never be proven by triggering these detections alone.

Available codes are:

{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"| Code for <disableac>
! scope="col" style="background:#d0d0d0;"| Displayed on detect
! scope="col" style="background:#d0d0d0;"| Required server version
! scope="col" style="background:#d0d0d0;"| Required <minclientversion>
! scope="col" style="background:#d0d0d0;"| Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''1'''
| style="background:#f0f0f0;" align="center"|AC #1
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Classic health/armour hack detector
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''2'''
| style="background:#f0f0f0;" align="center"|AC #2
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Corrupted dll files
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''4'''
| style="background:#f0f0f0;" align="center"|AC #4
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects presence of trainer. This is the most common AC code for attempted cheating, mostly with cheats designed for MTA.
Note: disabling this code is unlikely to produce expected results, in accordance with what is mentioned in the "DISCLAIMER" part.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''5'''
| style="background:#f0f0f0;" align="center"|AC #5
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''6'''
| style="background:#f0f0f0;" align="center"|VF #6
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer incl.: player movement, health/damage, weapons, money, gamespeed, game cheats, aimbot
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''7'''
| style="background:#f0f0f0;" align="center"|VF #7
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''8'''
| style="background:#f0f0f0;" align="center"|VF #8
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects unauthorized mods
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''11'''
| style="background:#f0f0f0;" align="center"|AC #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Dll injector / Trainer
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''13'''
| style="background:#f0f0f0;" align="center"|SD #13
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Data files issue
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''17'''
| style="background:#f0f0f0;" align="center"|VF #17
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Speed / wall hacks
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''21'''
| style="background:#f0f0f0;" align="center"|AC #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Custom gta_sa.exe
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''26'''
| style="background:#f0f0f0;" align="center"|SD #26
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.4-9.05858
| style="background:#f0f0f0;"| Anti-cheat component blocked
|}

==<enablesd></enablesd>==
Comma separated list of enabled Special Detections (SD #). A special detection is a type of anti-cheat for (usually) harmless game modifications. Competitive servers or servers dealing with a certain problem structurally may wish to enable special detections, but most servers should leave this setting blank. Available codes are:
{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"|Code for <enablesd>
! scope="col" style="background:#d0d0d0;"|Displayed on detect
! scope="col" style="background:#d0d0d0;"|Required server version
! scope="col" style="background:#d0d0d0;"|Required <minclientversion>
! scope="col" style="background:#d0d0d0;"|Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''12'''
| style="background:#f0f0f0;" align="center"|SD #12
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Disallow custom D3D9.DLL
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''14'''
| style="background:#f0f0f0;" align="center"|SD #14
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;"| Disallow virtual machines such as VMWare
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''15'''
| style="background:#f0f0f0;" align="center"|SD #15
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;"| Disallow disabled driver signing
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''16'''
| style="background:#f0f0f0;" align="center"|SD #16
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow disabled anti-cheat components. This is triggered when an anti-cheat component can not start. It is usually due to some problem with the PC and might be fixed by a reboot. Can also be triggered by a virus.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''20'''
| style="background:#f0f0f0;" align="center"|SD #20
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow non-standard gta3.img or gta_int.img (For servers not using [[onPlayerModInfo]])
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''22'''
| style="background:#f0f0f0;" align="center"|SD #22
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Lua script files)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''23'''
| style="background:#f0f0f0;" align="center"|SD #23
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.5.2-9.07911
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Non-Lua files e.g. png,dff)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''28'''
| style="background:#f0f0f0;" align="center"|SD #28
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow Linux Wine
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''31'''
| style="background:#f0f0f0;" align="center"|SD #31
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.3-9.11204
| style="background:#f0f0f0;"| Ignore injected keyboard inputs (e.g. from AutoHotkey, macro's and on screen keyboard)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''32'''
| style="background:#f0f0f0;" align="center"|SD #32
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.4-9.11528
| style="background:#f0f0f0;"| Ignore injected mouse button inputs and movement (this detection can prevent an ambigious type of aim hacks (bullet spread/recoil manipulation)
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''33'''
| style="background:#f0f0f0;" align="center"|SD #33
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow software of the category 'Net limiter' (ideal for lagswitching or causing structural lag, but may also be used for benign purposes)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''34'''
| style="background:#f0f0f0;" align="center"|SD #34
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow internet café users ('''only''' use as last resort to combat mass ban evasion using café PC's)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''35'''
| style="background:#f0f0f0;" align="center"|SD #35
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow certain software with "FPS locking" capabilities, for example Fraps recorder.

Particularly racing gamemodes are impacted by players that use FPS lock hotkey at times they need an unfair advantage (like, to drive through a loop faster) or a small speed boost.

'''Note''': it would be better if you use this SD in a custom implementation only (using [[onPlayerACInfo]]) instead of kick in mtaserver.conf. For example so that it would only kick when they approach a loop, or are playing a map sensitive to this abuse. Because you'll have to tread carefully, since Fraps is also a popular recording tool.
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''36'''
| style="background:#f0f0f0;" align="center"|SD #36
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;"| Disallow AutoHotKey base application (used to load .ahk files) and Ahk2Exe binaries with embedded scripts.

The possibilities for AutoHotKey are endless and it would be futile for the MTA anti-cheat or scripts to try to cover every case. MTA does not scan the content of .ahk files loaded into the AutoHotKey application, so this special detection allows server owners to stop all uses of AutoHotKey.

Most servers won't need this (cancelling the input sent into GTA with SD #31 and #32 would be sufficient), but some competitive servers have problems with AutoHotKey's interaction with Windows rather than with MTA (which is already ignored by the game). Examples of these toggling firewall rules for lag switching, or toggling of effects that can cause small freezes.

The abuse scripts currently in circulation are mostly AHK-based, so keep in mind that they can easily migrate to a different system. MTA isn't guaranteed to add an SD for that as well. If you're experiencing abuse that consists of lag switching, a scripted solution (such as [https://github.com/Lpsd/ConGuard ConGuard]) is the recommended approach.

Finally, remember that the AutoHotKey base application has many legitimate uses, so only use this when you have no other options for ensuring competitive balance.
|}

We are constantly working on keeping the definitions for above SD (special detections) up-to-date, so as to ensure all violating software or circumstances that you opt-in to disable gets detected once used. While we are pro-actively checking if new or unknown software/tools are still being detected under the same signature, it's possible that something slips through the cracks. Therefore, you can help us if you come across anything that should be detectable using SD # but is not currently; send a forum PM to Dutchman101 or ccw with your report.

==<client_file name="data/carmods.dat" verify="0"/>==
By default, clients may not join a server if they have customized GTA:SA data files. Adding one or more of the above lines excludes files from validation. The file names that can be used are:

* "anim/ped.ifp"
* "data/animgrp.dat"
* "data/ar_stats.dat"
* "data/carmods.dat"
* "data/clothes.dat"
* "data/default.dat"
* "data/default.ide"
* "data/furnitur.dat"
* "data/gta.dat"
* <strike>"data/handling.cfg"</strike> - this is unavailable because MTA always ignores this file so that [[setVehicleHandling]] works correctly. [[Handling.cfg|Click here]]'' if you want to load custom handling.cfg files.
* "data/maps" - this applies to all files within this folder
* "data/melee.dat"
* "data/object.dat"
* "data/peds.ide"
* "data/pedstats.dat"
* "data/plants.dat"
* "data/procobj.dat"
* "data/surface.dat"
* "data/surfinfo.dat"
* "data/timecyc.dat" - minimum server version 1.5.6-9.18322
* "data/txdcut.ide"
* "data/vehicles.ide"
* "data/water1.dat"
* "data/water.dat"
* "data/weapon.dat"
* "models/coll/weapons.col"

==<hideac></hideac>==

You can use this setting in mtaserver.conf to hide the AC info from the client, showing the following line upon join:
Server AC info: [Undisclosed]

Values: 0 - disabled, 1 - enabled; default value: 0.

=Client=
When joining a server, the server AC info is displayed in the client console (F8), for example:

Server AC Info: [Allowed client files: None] [Disabled AC: None] [Enabled SD: None]

''Disabled AC'' contains the contents of the server setting from <code><disableac></disableac></code>, and ''Enabled SD'' contains the contents of the server setting from <code><enablesd></enablesd></code>.

Allowed client files contains numbers to indicate which client files the server allows to be modified. The numbers represent these files:

*1 - "data/carmods.dat"
*2 - "data/animgrp.dat"
*4 - "data/ar_stats.dat"
*5 - "data/melee.dat"
*6 - "data/clothes.dat"
*7 - "data/object.dat"
*8 - "data/default.dat"
*9 - "data/surface.dat"
*10 - "data/default.ide"
*12 - "data/gta.dat"
*13 - "data/surfinfo.dat"
*14 - "data/peds.ide"
*15 - "data/vehicles.ide"
*16 - "data/pedstats.dat"
*17 - "data/water.dat"
*18 - "data/txdcut.ide"
*19 - "data/water1.dat"
*20 - "models/coll/weapons.col"
*21 - "data/weapon.dat"
*22 - "data/plants.dat"
*23 - "anim/ped.ifp"
*24 - "data/furnitur.dat"
*25 - "data/procobj.dat"
*26 - "data/maps"
*27 - "data/timecyc.dat"

'''''Note:''''' ''If the info is marked "Undisclosed", it means that the server has decided not to disclose the AC info to the client.''

===Using modified files===
If you want to use modified data files from your GTA:SA install directory, check this check box:

Settings -> Multiplayer -> Use customized GTA:SA files

The checkbox only appears if your GTA:SA data files are customized.

'''''Note:''''' ''This will restrict your access to some public servers as most do not allow customized data files.''

[[Category: Support]]
[[ru:Anti-cheat guide]]

Anti-cheat guide

2020-10-31T04:29:02Z

Qaisjp: improve grammar, clarity and english

This guide explains how you can fine-tune MTA's anti-cheat on your server using [[Server_mtaserver.conf|'''mtaserver.conf''']]. It does not allow players to modify their own AC settings.

An anti-cheat helper resource, '''acpanel''', is included as a default resource. This shows the current anti-cheat status of your server, along with an option to keep your clients up to date and a basic implementation of [[onPlayerModInfo]] to block modified img files.

You may want to fine-tune AC to prevent certain players have from having an unfair advantage or to ensure competitive integrity. The settings you provide depends entirely on the kind of server you run. Here are some examples on what can be achieved:

* '''Problem:''' Alice tries to ram the vehicle of Eve, and Alice can clearly see the collision, but Eve's vehicle is not really moving.
: '''Explanation:''' Eve has changed their vehicle model to a much smaller vehicle, or a model with a tiny hitbox or (nearly absent) collisions.
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Eve seems to be using wallhacks! She even seems to even be shooting through them!
: '''Explanation:''' Eve has replaced buildings so that they are either invisible (textures) or tiny (models).
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Mallory seems to be solving complex maths questions instantly! It should take at least a couple of seconds... for humans.
: '''Explanation:''' Mallory is injecting keyboard input via something like AutoHotkey
: '''Solution:''' Enable SD #31 to prevent users from injecting keyboard input. You can use SD #32 for injected mouse input (e.g. for scripts that require natural skill from mouse input)

* '''Problem:''' Mallory seems to be spamming my commands and GUI... and it lags my entire server!
: '''Explanation:''' You are running expensive user-initiated code without rate limiting players.
: '''Solution:''' You should write code that prevents players from spamming certain actions.
: '''Lazy Solution:''' Enable SD #31/#32 to make it more difficult for players to spam certain actions.

__TOC__

==<disableac></disableac>==
Comma separated list of disabled anti-cheats. This setting disables specific AC codes. If a detection is triggered and it's not disabled by the server, a player will get kicked and be shown the AC code corresponding to that detection. '''Note that the list is incomplete''' (it doesn't cover all AC codes that exist) because not all AC codes can be disabled for security reasons, e.g they are critical part of the anti-cheat and likewise we will also never provide information about what exactly they mean.

'''DISCLAIMER''':
Please note that disableac will only void the AC # kick for using GTA singleplayer cheats and some very basic, outdated and patched MP cheats (such as s0beit). Hacks & cheats designed for MTA or other general hacking tools may still trigger a Global ban or kick.
If you try to use a typical MTA cheat or hacktool under the belief using disableAC will save your day, and get banned for a while, it's your own fault, regardless of this setting being used to disable any of the AC classifications that it may fall under.

There is also a good chance that disabling certain detections won't enable your players to (even) use the majority of 'basic' GTA:SA trainers, but result in a kick only.
Due to the current state of MTA anti-cheat, and its advanced heuristics, it's simply not feasible to try and create a freehaven for cheaters. You can experiment, but we don't recommend using '''disableac''' for these reasons.

'''Note''': With '''trainer''', cheats (for MTA or GTA) or forbidden cheat tools are meant. This is especially true for AC #4.
Please note that getting kicked for anything listed here isn't neccesarily (intended) hacking, someone can open hacktools that they plan to use for another game, while both that game and MTA are opened, and be kicked.
It's also possible that someone isn't aware of certain software containing hack/tamper features (making it prohibited) when they run it and get kicked.
Basically, (the intent of) cheating on MTA or your server can never be proven by triggering these detections alone.

Available codes are:

{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"| Code for <disableac>
! scope="col" style="background:#d0d0d0;"| Displayed on detect
! scope="col" style="background:#d0d0d0;"| Required server version
! scope="col" style="background:#d0d0d0;"| Required <minclientversion>
! scope="col" style="background:#d0d0d0;"| Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''1'''
| style="background:#f0f0f0;" align="center"|AC #1
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Classic health/armour hack detector
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''2'''
| style="background:#f0f0f0;" align="center"|AC #2
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Corrupted dll files
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''4'''
| style="background:#f0f0f0;" align="center"|AC #4
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects presence of trainer. This is the most common AC code for attempted cheating, mostly with cheats designed for MTA.
Note: disabling this code is unlikely to produce expected results, in accordance with what is mentioned in the "DISCLAIMER" part.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''5'''
| style="background:#f0f0f0;" align="center"|AC #5
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''6'''
| style="background:#f0f0f0;" align="center"|VF #6
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer incl.: player movement, health/damage, weapons, money, gamespeed, game cheats, aimbot
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''7'''
| style="background:#f0f0f0;" align="center"|VF #7
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''8'''
| style="background:#f0f0f0;" align="center"|VF #8
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects unauthorized mods
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''11'''
| style="background:#f0f0f0;" align="center"|AC #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Dll injector / Trainer
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''13'''
| style="background:#f0f0f0;" align="center"|SD #13
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Data files issue
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''17'''
| style="background:#f0f0f0;" align="center"|VF #17
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Speed / wall hacks
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''21'''
| style="background:#f0f0f0;" align="center"|AC #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Custom gta_sa.exe
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''26'''
| style="background:#f0f0f0;" align="center"|SD #26
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.4-9.05858
| style="background:#f0f0f0;"| Anti-cheat component blocked
|}

==<enablesd></enablesd>==
Comma separated list of enabled Special Detections (SD #). A special detection is a type of anti-cheat for (usually) harmless game modifications. Competitive servers or servers dealing with a certain problem structurally may wish to enable special detections, but most servers should leave this setting blank. Available codes are:
{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"|Code for <enablesd>
! scope="col" style="background:#d0d0d0;"|Displayed on detect
! scope="col" style="background:#d0d0d0;"|Required server version
! scope="col" style="background:#d0d0d0;"|Required <minclientversion>
! scope="col" style="background:#d0d0d0;"|Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''12'''
| style="background:#f0f0f0;" align="center"|SD #12
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Disallow custom D3D9.DLL
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''14'''
| style="background:#f0f0f0;" align="center"|SD #14
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;"| Disallow virtual machines such as VMWare
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''15'''
| style="background:#f0f0f0;" align="center"|SD #15
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;"| Disallow disabled driver signing
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''16'''
| style="background:#f0f0f0;" align="center"|SD #16
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow disabled anti-cheat components. This is triggered when an anti-cheat component can not start. It is usually due to some problem with the PC and might be fixed by a reboot. Can also be triggered by a virus.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''20'''
| style="background:#f0f0f0;" align="center"|SD #20
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow non-standard gta3.img or gta_int.img (For servers not using [[onPlayerModInfo]])
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''22'''
| style="background:#f0f0f0;" align="center"|SD #22
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Lua script files)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''23'''
| style="background:#f0f0f0;" align="center"|SD #23
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.5.2-9.07911
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Non-Lua files e.g. png,dff)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''28'''
| style="background:#f0f0f0;" align="center"|SD #28
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow Linux Wine
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''31'''
| style="background:#f0f0f0;" align="center"|SD #31
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.3-9.11204
| style="background:#f0f0f0;"| Ignore injected keyboard inputs (e.g. from AutoHotkey, macro's and on screen keyboard)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''32'''
| style="background:#f0f0f0;" align="center"|SD #32
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.4-9.11528
| style="background:#f0f0f0;"| Ignore injected mouse button inputs and movement (this detection can prevent an ambigious type of aim hacks (bullet spread/recoil manipulation)
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''33'''
| style="background:#f0f0f0;" align="center"|SD #33
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow software of the category 'Net limiter' (ideal for lagswitching or causing structural lag, but may also be used for benign purposes)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''34'''
| style="background:#f0f0f0;" align="center"|SD #34
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow internet café users ('''only''' use as last resort to combat mass ban evasion using café PC's)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''35'''
| style="background:#f0f0f0;" align="center"|SD #35
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow certain software with "FPS locking" capabilities, for example Fraps recorder. 
Particularly racing gamemodes are impacted by players that use FPS lock hotkey at times they need an unfair advantage (like, to drive through a loop faster) or a small speed boost. 
 '''Note''': it would be better if you use this SD in a custom implementation only (using [[onPlayerACInfo]]) instead of kick in mtaserver.conf. For example so that it would only kick when they approach a loop, or are playing a map sensitive to this abuse. Because you'll have to tread carefully, since Fraps is also a popular recording tool. 
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''36'''
| style="background:#f0f0f0;" align="center"|SD #36
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;"| Disallow AutoHotKey base application (used to load .ahk files) and Ahk2Exe binaries with embedded scripts.

The possibilities for AutoHotKey are endless and it would be futile for the MTA anti-cheat or scripts to try to cover every case. MTA does not scan the content of .ahk files loaded into the AutoHotKey application, so this special detection allows server owners to stop all uses of AutoHotKey.

Most servers won't need this (cancelling the input sent into GTA with SD #31 and #32 would be sufficient), but some competitive servers have problems with AutoHotKey's interaction with Windows rather than with MTA (which is already ignored by the game). Examples of these toggling firewall rules for lag switching, or toggling of effects that can cause small freezes.

The abuse scripts currently in circulation are mostly AHK-based, so keep in mind that they can easily migrate to a different system. MTA isn't guaranteed to add an SD for that as well. If you're experiencing abuse that consists of lag switching, a scripted solution (such as [https://github.com/Lpsd/ConGuard ConGuard]) is the recommended approach.

Finally, remember that the AutoHotKey base application has many legitimate uses, so only use this when you have no other options for ensuring competitive balance.
|}

We are constantly working on keeping the definitions for above SD (special detections) up-to-date, so as to ensure all violating software or circumstances that you opt-in to disable gets detected once used. While we are pro-actively checking if new or unknown software/tools are still being detected under the same signature, it's possible that something slips through the cracks. Therefore, you can help us if you come across anything that should be detectable using SD # but is not currently; send a forum PM to Dutchman101 or ccw with your report.

==<client_file name="data/carmods.dat" verify="0"/>==
By default, clients may not join a server if they have customized GTA:SA data files. Adding one or more of the above lines excludes files from validation. The file names that can be used are:

* "anim/ped.ifp"
* "data/animgrp.dat"
* "data/ar_stats.dat"
* "data/carmods.dat"
* "data/clothes.dat"
* "data/default.dat"
* "data/default.ide"
* "data/furnitur.dat"
* "data/gta.dat"
* <strike>"data/handling.cfg"</strike> - this is unavailable because MTA always ignores this file so that [[setVehicleHandling]] works correctly. [[Handling.cfg|Click here]]'' if you want to load custom handling.cfg files.
* "data/maps" - this applies to all files within this folder
* "data/melee.dat"
* "data/object.dat"
* "data/peds.ide"
* "data/pedstats.dat"
* "data/plants.dat"
* "data/procobj.dat"
* "data/surface.dat"
* "data/surfinfo.dat"
* "data/timecyc.dat" - minimum server version 1.5.6-9.18322
* "data/txdcut.ide"
* "data/vehicles.ide"
* "data/water1.dat"
* "data/water.dat"
* "data/weapon.dat"
* "models/coll/weapons.col"

==<hideac></hideac>==

You can use this setting in mtaserver.conf to hide the AC info from the client, showing the following line upon join:
Server AC info: [Undisclosed]

Values: 0 - disabled, 1 - enabled; default value: 0.

=Client=
When joining a server, the server AC info is displayed in the client console (F8), for example:

Server AC Info: [Allowed client files: None] [Disabled AC: None] [Enabled SD: None]

''Disabled AC'' contains the contents of the server setting from <code><disableac></disableac></code>, and ''Enabled SD'' contains the contents of the server setting from <code><enablesd></enablesd></code>.

Allowed client files contains numbers to indicate which client files the server allows to be modified. The numbers represent these files:

*1 - "data/carmods.dat"
*2 - "data/animgrp.dat"
*4 - "data/ar_stats.dat"
*5 - "data/melee.dat"
*6 - "data/clothes.dat"
*7 - "data/object.dat"
*8 - "data/default.dat"
*9 - "data/surface.dat"
*10 - "data/default.ide"
*12 - "data/gta.dat"
*13 - "data/surfinfo.dat"
*14 - "data/peds.ide"
*15 - "data/vehicles.ide"
*16 - "data/pedstats.dat"
*17 - "data/water.dat"
*18 - "data/txdcut.ide"
*19 - "data/water1.dat"
*20 - "models/coll/weapons.col"
*21 - "data/weapon.dat"
*22 - "data/plants.dat"
*23 - "anim/ped.ifp"
*24 - "data/furnitur.dat"
*25 - "data/procobj.dat"
*26 - "data/maps"
*27 - "data/timecyc.dat"

'''''Note:''''' ''If the info is marked "Undisclosed", it means that the server has decided not to disclose the AC info to the client.''

===Using modified files===
If you want to use modified data files from your GTA:SA install directory, check this check box:

Settings -> Multiplayer -> Use customized GTA:SA files

The checkbox only appears if your GTA:SA data files are customized.

'''''Note:''''' ''This will restrict your access to some public servers as most do not allow customized data files.''

[[Category: Support]]
[[ru:Anti-cheat guide]]

GetKeyboardLayout

2020-10-18T11:23:34Z

Qaisjp: copy from https://docs.microsoft.com/en-us/windows/win32/intl/locale-ireadinglayout

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|18866|This function gets the player's keyboard layout settings, which they are currently (keyboard layout can be changed at any moment) using at the time of invocation.}}

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

===Returns===
Returns a ''table'' with keyboard layout properties:

{| class="wikitable" style="cellpadding: 10px;"
|-
! Property || Values and description
|-
| <code>readingLayout</code> ||
{| class="prettytable"
|-
| <code>"ltr"</code> || Left to right (English)
|-
| <code>"rtl"</code> || Right to left (Arabic, Hebrew)
|-
| <code>"ttb-rtl-ltr"</code> || Either read vertically from top to bottom with columns going from right to left, or read in horizontal rows from left to right, as for the Japanese (Japan) locale.
|-
| <code>"ttb-ltr"</code> || Read vertically from top to bottom with columns going from left to right, as for the Mongolian (Mongolian) locale.
|}
|}

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("layout", function()
outputConsole( inspect( getKeyboardLayout() ) )--output keyboard layout in console (F8)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client_utility_functions}}

Template:Drawing functions

2020-10-16T18:32:10Z

Qaisjp: fix ver

*[[dxConvertPixels]]
*[[dxCreateFont]]
*[[dxCreateRenderTarget]]
*[[dxCreateScreenSource]]
*[[dxCreateShader]]
*[[dxCreateTexture]]
{{New items|3.0156|1.5.5|
*[[dxDrawCircle]]
|13977}}
*[[dxDrawImage]]
*[[dxDrawImageSection]]
*[[dxDrawLine]]
*[[dxDrawLine3D]]
*[[dxDrawMaterialLine3D]]
{{New items|3.0157|1.5.6|
*[[dxDrawMaterialPrimitive]]
*[[dxDrawPrimitive]]
|14203}}
{{New items|3.0157|1.5.7|
*[[dxDrawMaterialPrimitive3D]]
*[[dxDrawPrimitive3D]]
|19626}}
*[[dxDrawMaterialSectionLine3D]]
*[[dxDrawRectangle]]
*[[dxDrawText]]
{{New items|3.0158|1.5.7|
*[[dxDrawWiredSphere]]
|20328}}
*[[dxGetBlendMode]]
*[[dxGetFontHeight]]
*[[dxGetMaterialSize]]
*[[dxGetPixelColor]]
*[[dxGetPixelsSize]]
*[[dxGetPixelsFormat]]
*[[dxGetStatus]]
{{New items|3.0158|1.5.7|
*[[dxGetTextSize]]
|20447}}
*[[dxGetTextWidth]]
*[[dxGetTexturePixels]]
*[[dxIsAspectRatioAdjustmentEnabled]]
*[[dxSetAspectRatioAdjustmentEnabled]]
*[[dxSetBlendMode]]
*[[dxSetPixelColor]]
*[[dxSetRenderTarget]]
*[[dxSetShaderValue]]
*[[dxSetShaderTessellation]]
*[[dxSetShaderTransform]]
*[[dxSetTestMode]]
*[[dxSetTextureEdge]]
*[[dxSetTexturePixels]]
*[[dxUpdateScreenSource]]
<noinclude>[[Category:Functions templates]]</noinclude>

SetAccountName

2020-10-16T16:44:19Z

Qaisjp: fix ver

{{Server function}}
__NOTOC__
{{New feature/item|3.0155|1.5.5|11747|
This function sets the name of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName|name|getAccountName}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns a ''true'' if the account name was set, ''false'' if an invalid argument was specified.

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccount(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

PlaySFX3D

2020-10-12T20:18:43Z

Qaisjp: fix typo

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound in the GTA world from GTA's big sound containers.
}}

{{Note|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}
{{Warning|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid audio files, this function returns ''false''.

It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
*'''bankId:''' The audio bank id
*'''soundId:''' The sound id within the audio bank
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped

==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

{{New feature/item|3.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX3D( string "radio", string radioStation, int trackId, float x, float y, float z [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped
==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
}}

==Example==
The following example plays a fire alarm sound near you (looped).
<syntaxhighlight lang="lua">
local x, y, z = getElementPosition(localPlayer)
if not playSFX3D("script", 7, 1, x + 10, y, z, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

[[hu:playSFX3D]]

AbortRemoteRequest

2020-10-10T19:52:12Z

Qaisjp: fix rev

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20307|
Aborts a [[FetchRemote|fetchRemote]] or [[CallRemote|callRemote]] request.
}}
==Syntax==
<syntaxhighlight lang="lua">
bool abortRemoteRequest( request theRequest )
</syntaxhighlight>

===Required Arguments===
* '''theRequest''': returned from [[FetchRemote|fetchRemote]], [[CallRemote|callRemote]] or [[GetRemoteRequests|getRemoteRequests]]

==Returns==
Returns true on success, false when invalid request was provided

==Example==
this example aborts all pending requests of currently running resource.
<syntaxhighlight lang="lua">
function CMD_abortRequests()
local requests = getRemoteRequests()

for _, request in ipairs(requests) do
abortRemoteRequest()
end
end

addCommandHandler("abortrequests", CMD_abortRequests)
</syntaxhighlight>

{{Requirements|1.5.7-9.20307|1.5.7-9.20307}}

==See Also==
{{Resource functions}}

GetRemoteRequestInfo

2020-10-10T19:52:02Z

Qaisjp: fix rev

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20307|
Gets informations of an [[FetchRemote|fetchRemote]] or [[CallRemote|callRemote]] request info.
}}
==Syntax==
<syntaxhighlight lang="lua">
table getRemoteRequestInfo ( request theRequest [, int postDataLength = 0 [, bool includeHeaders = false ] ] )
</syntaxhighlight>

===Required Arguments===
* '''theRequest''': returned from [[FetchRemote|fetchRemote]], [[CallRemote|callRemote]] or [[GetRemoteRequests|getRemoteRequests]]

==Returns==
Returns a table when valid, false otherwise
The table contains:
*'''bytesReceived:''' A number specifying the amount of data received so far. Zero means the download is queued
*'''bytesTotal:''' A number specifying the final download size. Will be zero if the remote HTTP server has not set the 'Content-Length' header
*'''currentAttempt:''' A number specifying the current connection attempt
*'''type:''' A string specifying either "fetch" or "call"
*'''url:''' A string specifying the URL
*'''resource:''' The resource which started the request, or false if the resource has since been stopped/restarted
*'''queue:''' A string specifying the queue name
*'''method:''' A string specifying the HTTP method. e.g. "GET" or "POST"
*'''connectionAttempts:''' A number specifying max number connection attempts as declared in the fetchRemote call
*'''connectionTimeout:''' A number specifying connection attempt timeout as declared in the fetchRemote call
*'''postData:''' A string containing the request post data as declared in the fetchRemote call
*'''headers:''' A table containing the request HTTP headers as declared in the fetchRemote call

==Example==
<section name="Server" class="server" show="true">
This example gets infos about all pending requests and prints them in debugscript
<syntaxhighlight lang="lua">
function CMD_requestInfo(player, _, resourceName)
local res = resourceName and getResourceFromName(resourceName) or not resourceName and nil

if(res == false) then
outputServerLog("There is no resource named '" .. resourceName .. "'")
return
elseif(res and getResourceState(res) ~= "running") then
outputServerLog("The provided resource '" .. resourceName .. "' is not running")
return
end

local requests = getRemoteRequests(res)

for _, request in ipairs(requests) do
local requestInfo = getRemoteRequestInfo(request)

if(requestInfo) then
iprint(requestInfo)
end
end
end

addCommandHandler("requestinfo", CMD_requestInfo)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This example gets infos about all pending requests and prints them in debugscript
<syntaxhighlight lang="lua">
function CMD_requestInfo(player, _, resourceName)
local res = resourceName and getResourceFromName(resourceName) or not resourceName and nil

if(res == false) then
outputChatBox("There is no resource named '" .. resourceName .. "'")
return
elseif(res and getResourceState(res) ~= "running") then
outputChatBox("The provided resource '" .. resourceName .. "' is not running")
return
end

local requests = getRemoteRequests(res)

for _, request in ipairs(requests) do
local requestInfo = getRemoteRequestInfo(request)

if(requestInfo) then
iprint(requestInfo)
end
end
end

addCommandHandler("requestinfo", CMD_requestInfo)
</syntaxhighlight>
</section>

{{Requirements|1.5.7-9.20307|1.5.7-9.20307}}

==See Also==
{{Resource functions}}

GetRemoteRequests

2020-10-10T19:51:53Z

Qaisjp: fix rev

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20307|
Gets all [[FetchRemote|fetchRemote]] and [[CallRemote|callRemote]] requests currently running.
}}
==Syntax==
<syntaxhighlight lang="lua">
table getRemoteRequests ( [ resource theResource = nil ] )
</syntaxhighlight>

===Optional Arguments===
* '''theResource''': the resource to get all requests from

==Returns==
Returns a table with all requests, false if an invalid resource was provided

==Example==
<section name="Server" class="server" show="true">
This example prints how many request are currently pending.
<syntaxhighlight lang="lua">
function CMD_requestInfo(player, _, resourceName)
local res = resourceName and getResourceFromName(resourceName) or not resourceName and nil

if(res == false) then
outputChatBox("There is no resource named '" .. resourceName .. "'", player)
return
elseif(res and getResourceState(res) ~= "running") then
outputChatBox("The provided resource '" .. resourceName .. "' is not running", player)
return
end

local requests = getRemoteRequests(res)

outputChatBox(("There are %d request%s running"):format(#requests, #requests == 1 and '' or 's'), player)
end

addCommandHandler("requestinfo", CMD_requestInfo)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This example prints how many request are currently pending.
<syntaxhighlight lang="lua">
function CMD_requestInfo(_, resourceName)
local res = resourceName and getResourceFromName(resourceName) or not resourceName and nil

if(res == false) then
outputChatBox("There is no resource named '" .. resourceName .. "'")
return
elseif(res and getResourceState(res) ~= "running") then
outputChatBox("The provided resource '" .. resourceName .. "' is not running")
return
end

local requests = getRemoteRequests(res)

outputChatBox(("There are %d request%s running"):format(#requests, #requests == 1 and '' or 's'))
end

addCommandHandler("requestinfo", CMD_requestInfo)
</syntaxhighlight>
</section>

{{Requirements|1.5.7-9.20307|1.5.7-9.20307}}

==See Also==
{{Resource functions}}

Template:Resource functions

2020-10-10T19:50:06Z

Qaisjp: ver

*[[addResourceConfig]]
*[[addResourceMap]]
*[[call]]
*[[callRemote]]
*[[copyResource]]
*[[createResource]]
*[[deleteResource]]
*[[fetchRemote]]
*[[getResourceACLRequests]]
*[[getResourceConfig]]
*[[getResourceDynamicElementRoot]]
*[[getResourceExportedFunctions]]
*[[getResourceFromName]]
*[[getResourceInfo]]
*[[getResourceLastStartTime]]
*[[getResourceLoadFailureReason]]
*[[getResourceLoadTime]]
*[[getResourceMapRootElement]]
*[[getResourceName]]
*[[getResourceOrganizationalPath]]
*[[getResourceRootElement]]
*[[getResourceState]]
*[[getResources]]
*[[getThisResource]]
*[[isResourceArchived]]
{{New items|3.0160|1.5.7|
* [[isResourceProtected]]
|20468}}
*[[refreshResources]]
*[[removeResourceFile]]
*[[renameResource]]
*[[restartResource]]
*[[setResourceInfo]]
*[[startResource]]
*[[stopResource]]
*[[updateResourceACLRequest]]
{{New items|3.0158|1.5.7|
*[[getRemoteRequests]]
*[[getRemoteRequestInfo]]
*[[abortRemoteRequest]]
|20307|}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Client resource functions

2020-10-10T19:45:21Z

Qaisjp: fix ver

*[[call]]
*[[fetchRemote]]
*[[getResourceConfig]]
*[[getResourceDynamicElementRoot]]
*[[getResourceExportedFunctions]]
*[[getResourceFromName]]
*[[getResourceGUIElement]]
*[[getResourceName]]
*[[getResourceRootElement]]
*[[getResourceState]]
*[[getThisResource]]
{{New items|3.0158|1.5.7|
*[[getRemoteRequests]]
*[[getRemoteRequestInfo]]
*[[abortRemoteRequest]]
|20307|}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Client resource functions

2020-10-10T19:45:12Z

Qaisjp: fix ver

*[[call]]
*[[fetchRemote]]
*[[getResourceConfig]]
*[[getResourceDynamicElementRoot]]
*[[getResourceExportedFunctions]]
*[[getResourceFromName]]
*[[getResourceGUIElement]]
*[[getResourceName]]
*[[getResourceRootElement]]
*[[getResourceState]]
*[[getThisResource]]
{{New items|3.0158|1.5.7|
*[[getRemoteRequests]]
*[[getRemoteRequestInfo]]
*[[abortRemoteRequest]]
20307|}}
<noinclude>[[Category:Functions templates]]</noinclude>

PlaySound

2020-10-10T19:33:31Z

Qaisjp: fix rev

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player. 
 
{{Note|
*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS (e.g. Webstream).
*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
{{New items|5.0157|1.5.7|
*'''soundPath:''' Can also be raw sound data.
|20460}}

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", localPlayer, wasted) --add the event handler
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[HU:playSound]]
[[AR:playSound]]
[[DE:playSound]]
[[RO:playSound]]

PlaySound3D

2020-10-10T19:33:17Z

Qaisjp: fix rev

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0. 
 
{{Note|
*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
*For performance reasons, when using playSound3D for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>
<syntaxhighlight lang="lua">element playSound3D ( string soundURL, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound|Sound3D]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] to the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
{{New items|5.0157|1.5.7|
*'''soundPath:''' Can also be raw sound data.
|20460}}
*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)
</syntaxhighlight>
</section>
This example play internet radio in groove street.
<section name="Example 2" class="client" show="true" >
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot,
function()
local uSound = playSound3D('http://977music.com/itunes/80s.pls', 2498, -1659, 12)
setSoundMaxDistance(uSound, 100)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[HU:playSound3D]]
[[AR:playSound3D]]
[[DE:playSound3D]]
[[RU:playSound3D]]

Template:Engine functions

2020-08-30T13:24:55Z

Qaisjp: comment out engine model visible time

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
{{New items|3.0158|1.5.7|
* [[engineGetModelPhysicalPropertiesGroup]]
* [[engineRestoreModelPhysicalPropertiesGroup]]
* [[engineSetModelPhysicalPropertiesGroup]]
* [[engineGetObjectGroupPhysicalProperty]]
* [[engineRestoreObjectGroupPhysicalProperties]]
* [[engineSetObjectGroupPhysicalProperty]]
|19626}}
{{New items|3.0158|1.5.7|
* [[engineRequestModel]]
* [[engineFreeModel]]
|20147}}
{{New items|3.0158|1.5.7|
* [[engineGetModelTextures]]
|20416}}
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadIFP]]
* [[engineLoadTXD]]
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceAnimation]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
{{New items|3.0158|1.5.7|
* [[engineResetModelLODDistance]]
|20383}}
* [[engineRestoreAnimation]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]
* [[engineSetSurfaceProperties]]
* [[engineGetSurfaceProperties]]
* [[engineResetSurfaceProperties]]
 
<noinclude>[[Category:Functions templates]]</noinclude>

Character Skins

2020-08-27T18:25:54Z

Qaisjp: clarify that the models are ephemeral

Skins that the player may use (pedestrian skins).

*[[All Skins Page]] - Not recommended for slow Internet
*[[Special Skins Page]] - New skins available after MTA 1.1
*[[Gang Skins]]
*[[Female Skins]]
*[[Male Skins]]

'''Skin tables:'''
----
<syntaxhighlight lang="lua">
-- a complete table
allSkins = getValidPedModels()
-- separate tables
maleSkins = {0, 1, 2, 7, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 57, 58, 59, 60, 61, 62, 66, 67, 68, 70, 71, 72, 73, 78, 79, 80, 81, 82, 83, 84, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 120, 121, 122, 123, 124, 125, 126, 127, 128, 132, 133, 134, 135, 136, 137, 142, 143, 144, 146, 147, 153, 154, 155, 156, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 170, 171, 173, 174, 175, 176, 177, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 200, 202, 203, 204, 206, 209, 210, 212, 213, 217, 220, 221, 222, 223, 227, 228, 229, 230, 234, 235, 236, 239, 240, 241, 242, 247, 248, 249, 250, 252, 253, 254, 255, 258, 259, 260, 261, 262, 264, 265, 266, 267, 268, 269, 270, 271, 272, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 290, 291, 292, 293, 294, 295, 296, 297, 299, 300, 301, 302, 303, 305, 306, 307, 308, 309, 310, 311, 312}
femaleSkins = {9, 10, 11, 12, 13, 31, 38, 39, 40, 41, 53, 54, 55, 56, 63, 64, 69, 75, 76, 77, 85, 87, 88, 89, 90, 91, 92, 93, 129, 130, 131, 138, 139, 140, 141, 145, 148, 150, 151, 152, 157, 169, 172, 178, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 201, 205, 207, 211, 214, 215, 216, 218, 219, 224, 225, 226, 231, 232, 233, 237, 238, 243, 244, 245, 246, 251, 256, 257, 263, 298, 304}
</syntaxhighlight>

{{New items|3.0160|1.5.7|
* The following ID's were unused by GTA:SA, so in MTA:SA using [[engineRequestModel]] it is ''possible'' to allocate the following IDs as character skins. This allows servers to apply skin mods to these new IDs. These are the new 236 ID's that ''can'' be used for new skins:
<syntaxhighlight lang="lua">
3, 4, 5, 6, 8, 42, 65, 74, 86, 119, 149, 208, 273, 289, 329, 340, 382, 383, 398, 399,
612, 613, 614, 662, 663, 665, 666, 667, 668, 699, 793, 794, 795, 796, 797, 798, 799, 907,
908, 909, 965, 999, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205,
1206, 1326, 1573, 1699, 2883, 2884, 3136, 3137, 3138, 3139, 3140, 3141, 3142, 3143, 3144,
3145, 3146, 3147, 3148, 3149, 3150, 3151, 3152, 3153, 3154, 3155, 3156, 3157, 3158, 3159,
3160, 3161, 3162, 3163, 3164, 3165, 3166, 3176, 3177, 3179, 3180, 3181, 3182, 3183,
3184, 3185, 3186, 3188, 3189, 3190, 3191, 3192, 3194, 3195, 3196, 3197, 3198, 3199, 3200,
3201, 3202, 3203, 3204, 3205, 3206, 3207, 3208, 3209, 3210, 3211, 3212, 3213, 3215,
3216, 3217, 3218, 3219, 3220, 3222, 3223, 3224, 3225, 3226, 3227, 3228, 3229, 3230, 3231,
3232, 3233, 3234, 3235, 3236, 3237, 3238, 3239, 3240, 3245, 3247, 3248, 3251, 3254,
3266, 3348, 3349, 3416, 3429, 3610, 3611, 3784, 3870, 3871, 3883, 3889, 3974, 4542, 4543,
4544, 4545, 4546, 4547, 4548, 4549, 4763, 4764, 4765, 4766, 4767, 4768, 4769, 4770, 4771,
4772, 4773, 4774, 4775, 4776, 4777, 4778, 4779, 4780, 4781, 4782, 4783, 4784, 4785, 4786,
4787, 4788, 4789, 4790, 4791, 4792, 4793, 4794, 4795, 4796, 4797, 4798, 4799, 4800, 4801,
4802, 4803, 4804, 4805, 5090, 5104, 5376, 5377, 5378, 5379, 5380, 5381, 5382, 5383,
5384, 5385, 5386, 5387, 5388, 5389
</syntaxhighlight>
* Note that [[engineRequestModel]] requires you specify which element type you would like to request an ID for. In the future it may be possible to request vehicle or object IDs, so [[engineRequestModel]] may return some of the above IDs for non-ped models. This means you should be careful about including the above IDs in your code and treating it as a list of valid skins, as those IDs '''are not guaranteed to be valid''' and '''can be reused as vehicle or object model IDs'''.
|20147}}

'''Sectioned Skin Pages:'''
----
*[[Skins Page 1]]: 7, 9-29
*[[Skins Page 2]]: 30-41, 43-52
*[[Skins Page 3]]: 53-64, 66-73, 75-76
*[[Skins Page 4]]: 77-85, 87-99
*[[Skins Page 5]]: 100-118, 120-122
*[[Skins Page 6]]: 123-144
*[[Skins Page 7]]: 145-148, 150-167
*[[Skins Page 8]]: 168-189
*[[Skins Page 9]]: 190-207, 209-212
*[[Skins Page 10]]: 213-234
*[[Skins Page 11]]: 235-238, 240-257
*[[Skins Page 12]]: 258-264, 274-288
*[[Skins Page 13]]: 290-312

==Notes:==
*Last valid skin ID: 312

*The following pairs of IDs produce same character (1st ID used in lists, 2nd disabled)
**118:119
**148:149

*Non-working IDs
**3 4 5 6 8 42 65 74 86 119 149 208 273 289

==Skin functions==
{{Template:Skin_functions}}

==See Also==
[[id|ID Lists]]

[[hu:Character Skins]]
[[uk:Character Skins]]
[[tr:Karakter Tipleri]]
[[it:Skin Personaggi]]
[[ru:Character Skins]]
[[es:Skins de Personajes]]
[[de:Charakterskins]]
[[zh-cn:角色皮肤]]

[[Category:ID Lists]]

User talk:Violence

2020-08-22T14:16:41Z

Qaisjp: /* Please stop translating pages in the main section (English) only to Turkish */ new section

== Please stop translating pages in the main section (English) only to Turkish ==

Please stop translating pages in the main section to Turkish. The main section is only intended for English.

For example, please do not do these changes in the main space:

* https://wiki.multitheftauto.com/index.php?title=Server_Scripting_Events&diff=prev&oldid=67287
* https://wiki.multitheftauto.com/index.php?title=Server_Scripting_Functions&diff=prev&oldid=67276
* https://wiki.multitheftauto.com/index.php?title=OnBan&diff=prev&oldid=67280
* https://wiki.multitheftauto.com/index.php?title=AddAccount&diff=prev&oldid=67277

If you'd like to translate things to Turkish, copy the page content. e.g. From <code>AddAccount</code> to <code>TR/AddAccount</code>, as shown here for Spanish:

* https://wiki.multitheftauto.com/wiki/AddAccount
* https://wiki.multitheftauto.com/wiki/ES/AddAccount

[[User:Qaisjp|- qaisjp]] ([[User talk:Qaisjp|talk]]) 14:16, 22 August 2020 (UTC)

User talk:Violence

2020-08-22T14:16:33Z

Qaisjp: Blanked the page

User talk:Violence

2020-08-22T14:16:16Z

Qaisjp: Created page with "= Please stop translating pages in the main section (English) only to Turkish= Please stop translating pages in the main section to Turkish. The main section is only intended..."

= Please stop translating pages in the main section (English) only to Turkish=

Please stop translating pages in the main section to Turkish. The main section is only intended for English.

For example, please do not do these changes in the main space:

* https://wiki.multitheftauto.com/index.php?title=Server_Scripting_Events&diff=prev&oldid=67287
* https://wiki.multitheftauto.com/index.php?title=Server_Scripting_Functions&diff=prev&oldid=67276
* https://wiki.multitheftauto.com/index.php?title=OnBan&diff=prev&oldid=67280
* https://wiki.multitheftauto.com/index.php?title=AddAccount&diff=prev&oldid=67277

If you'd like to translate things to Turkish, copy the page content. e.g. From <code>AddAccount</code> to <code>TR/AddAccount</code>, as shown here for Spanish:

* https://wiki.multitheftauto.com/wiki/AddAccount
* https://wiki.multitheftauto.com/wiki/ES/AddAccount

[[User:Qaisjp|- qaisjp]] ([[User talk:Qaisjp|talk]]) 14:16, 22 August 2020 (UTC)

OnBan

2020-08-22T14:11:19Z

Qaisjp: Reverted edits by Violence (talk) to last revision by Botder

__NOTOC__
{{Server event}}
This event is triggered when an IP address or serial is banned from the server.

==Parameters==
<syntaxhighlight lang="lua">
ban theBan
</syntaxhighlight>

*'''theBan''': the [[ban]] which was added.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that was responsible for the banning. If no responsible was specified, the source is the global root element.

==Cancel effect==
This event cannot be canceled.

==Example==
This example outputs a simple message to all players when a player added a ban.
<syntaxhighlight lang="lua">
function announceBan( theBan )
if ( isElement( source ) ) and ( getElementType( source ) == "player" ) then -- Check if the element responsible for the ban is a player element
outputChatBox( getPlayerName( source ) .. " banned " .. ( getBanSerial( theBan ) or getBanIP( theBan ) ) ) -- Output to the chatbox saying the player has banned the IP/Serial
end
end
addEventHandler( "onBan", root, announceBan ) -- Adds the event handler for "onBan" and must be bound to root
</syntaxhighlight>

{{See also/Server event|Server events}}

Server Scripting Events

2020-08-22T14:11:12Z

Qaisjp: Reverted edits by Violence (talk) to last revision by Qaisjp

<pageclass class="server"></pageclass>
This page lists all '''server-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Client-side scripting events can be found here: [[Client Scripting Events]]

==Account events==
{{Account_events}}

==Client events==
{{Client_events}}

==Colshape events==
{{Colshape_events}}

==Element events==
{{Element_events}}

==Marker events==
{{Marker_events}}

==Pickup events==
{{Pickup_events}}

==Player events==
{{Player_events}}

==Ped events==
{{Ped_events}}

==Resource events==
{{Resource_events}}

==Server events==
{{Server_events}}

==Vehicle events==
{{Vehicle_events}}

==Weapon events==
{{Weapon_events}}

[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]
[[ar:Server Scripting Events]]

AddAccount

2020-08-22T14:11:01Z

Qaisjp: Reverted edits by Violence (talk) to last revision by Danilo

{{Server function}}
__NOTOC__
This function adds an [[account]] to the list of registered accounts of the current server.

==Syntax==
<syntaxhighlight lang="lua">account addAccount ( string name, string pass [, bool allowCaseVariations = false ] )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|[[Account]].add ||}}
===Required Arguments===
*'''name:''' The name of the account you wish to make, this normally is the player's name.
*'''pass:''' The password to set for this account for future logins.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns an [[account]] or ''false'' if the account already exists or an error occured.

===Limits===
*'''name:'''
** Minimal account name length is 1 character.
** Account names are case-sensitive if allowCaseVariations is ''true''.
** Account name can not be equal to "*****"
*'''pass:'''
** Minimal account password length is 1 character.
** Maximum account password length is 30 characters.
** Account password can not be equal to "*****"

==Example==
'''Example 1:''' This enables players to register on your server by using /register <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" and password ~= nil ) then
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Tell the user all is done
outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source )
else
-- There was an error making the account, tell the user
outputChatBox ( "Error creating account, contact the server admin", source )
end
else
-- There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''This code differs by allowing the user to change their username that they wish to use.'''

'''Example 2:''' This enables players to register on your server by using /register <username> <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''Example 3:''' This code differs again so the user can only register once /register <username> <password>.
<syntaxhighlight lang="lua">
bRegisteredOnce = {}

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and not bRegisteredOnce[source]) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
bRegisteredOnce[source] = true
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
if bRegisteredOnce[source] == true then
outputChatBox("You already registered on this server!",source)
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
end
</syntaxhighlight>

==See Also==

{{Account_functions}}

[[ar:addAcount]]
[[es:addAcount]]
[[pl:addAccount]]
[[ru:addAccount]]

Server Scripting Events

2020-08-22T14:10:37Z

Qaisjp: Reverted edits by Violence (talk) to last revision by A7MeDx666

Server Scripting Functions

2020-08-22T14:10:34Z

Qaisjp: Reverted edits by Violence (talk) to last revision by Botder

<pageclass class="server"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function or event, use [[Requested Functions and Events]] or https://bugs.mtasa.com.

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.

For more functions, check the [[Useful_Functions|useful functions page]].

'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''
__TOC__

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera_functions}}

==Clothes and body functions==
{{Clothes_and_body_functions}}

==Collision shape functions==
{{Collision_shape_functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element_functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker_functions}}

==Matrix functions==
{{Shared_matrix_functions}}

==Module functions==
{{Module_functions}}

==Object functions==
{{Object_functions}}

==Output functions==
{{Output_functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup_functions}}

==Player functions==
{{Player_functions}}

==Projectile functions==
{{Projectile_functions}}

==Radar area functions==
{{Radar_area_functions}}

==Resource functions==
{{Resource_functions}}

==Server functions==
{{Server_functions}}

==Settings registry functions==
{{Settings_registry_functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team_functions}}

==Text functions==
{{Text_functions}}

==Utility functions==
{{Utility_functions}}

==UTF8 Library==
{{UTF8_functions}}

==Vehicle functions==
{{Vehicle_functions}}

==Water functions==
{{Water_functions}}

==Weapon functions==
{{Weapon_functions}}

==World functions==
{{World_functions}}

==XML functions==
{{XML_functions}}

[[hu:Server Scripting Functions]]
[[ar:Server Scripting Functions]]
[[de:Server-Seitige Scripting Funktionen]]
[[es:Funciones_del_Server]]
[[pl:Server Scripting Functions]]
[[pt-br:Funções de Scripting do Servidor]]
[[ru:Server Scripting Functions]]
[[tr:Server Scripting Functions]]

Anti-cheat guide

2020-07-20T21:15:08Z

Qaisjp: Replace with a blank line / remove unnecessary newlines

This guide explains how you can fine-tune MTA's anti-cheat on your server using [[Server_mtaserver.conf|'''mtaserver.conf''']]. It does not allow players to modify their own AC settings.

An anti-cheat helper resource, '''acpanel''', is included as a default resource. This shows the current anti-cheat status of your server, along with an option to keep your clients up to date and a basic implementation of [[onPlayerModInfo]] to block modified img files.

You may want to fine-tune AC to prevent certain players have from having an unfair advantage or to ensure competitive integrity. The settings you provide depends entirely on the kind of server you run. Here are some examples on what can be achieved:

* '''Problem:''' Alice tries to ram the vehicle of Eve, and Alice can clearly see the collision, but Eve's vehicle is not really moving.
: '''Explanation:''' Eve has changed their vehicle model to a much smaller vehicle, or a model with a tiny hitbox or (nearly absent) collisions.
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Eve seems to be using wallhacks! She even seems to even be shooting through them!
: '''Explanation:''' Eve has replaced buildings so that they are either invisible (textures) or tiny (models).
: '''Solution:''' Disallow non-standard gta3.img

* '''Problem:''' Mallory seems to be solving complex maths questions instantly! It should take at least a couple of seconds... for humans.
: '''Explanation:''' Mallory is injecting keyboard input via something like AutoHotkey
: '''Solution:''' Enable SD #31 to prevent users from injecting keyboard input. You can use SD #32 for injected mouse input (e.g. for scripts that require natural skill from mouse input)

* '''Problem:''' Mallory seems to be spamming my commands and GUI... and it lags my entire server!
: '''Explanation:''' You are running expensive user-initiated code without rate limiting players.
: '''Solution:''' You should write code that prevents players from spamming certain actions.
: '''Lazy Solution:''' Enable SD #31/#32 to make it more difficult for players to spam certain actions.

__TOC__

==<disableac></disableac>==
Comma separated list of disabled anti-cheats. This setting disables specific AC codes. If a detection is triggered and it's not disabled by the server, a player will get kicked and be shown the AC code corresponding to that detection. '''Note that the list is incomplete''' (it doesn't cover all AC codes that exist) because not all AC codes can be disabled for security reasons, e.g they are critical part of the anti-cheat and likewise we will also never provide information about what exactly they mean.

'''DISCLAIMER''':
Please note that disableac will only void the AC # kick for using GTA singleplayer cheats and some very basic, outdated and patched MP cheats (such as s0beit). Hacks & cheats designed for MTA or other general hacking tools may still trigger a Global ban or kick.
If you try to use a typical MTA cheat or hacktool under the belief using disableAC will save your day, and get banned for a while, it's your own fault, regardless of this setting being used to disable any of the AC classifications that it may fall under.

There is also a good chance that disabling certain detections won't enable your players to (even) use the majority of 'basic' GTA:SA trainers, but result in a kick only.
Due to the current state of MTA anti-cheat, and its advanced heuristics, it's simply not feasible to try and create a freehaven for cheaters. You can experiment, but we don't recommend using '''disableac''' for these reasons.

'''Note''': With '''trainer''', cheats (for MTA or GTA) or forbidden cheat tools are meant. This is especially true for AC #4.
Please note that getting kicked for anything listed here isn't neccesarily (intended) hacking, someone can open hacktools that they plan to use for another game, while both that game and MTA are opened, and be kicked.
It's also possible that someone isn't aware of certain software containing hack/tamper features (making it prohibited) when they run it and get kicked.
Basically, (the intent of) cheating on MTA or your server can never be proven by triggering these detections alone.

Available codes are:

{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"| Code for <disableac>
! scope="col" style="background:#d0d0d0;"| Displayed on detect
! scope="col" style="background:#d0d0d0;"| Required server version
! scope="col" style="background:#d0d0d0;"| Required <minclientversion>
! scope="col" style="background:#d0d0d0;"| Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''1'''
| style="background:#f0f0f0;" align="center"|AC #1
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Classic health/armour hack detector
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''2'''
| style="background:#f0f0f0;" align="center"|AC #2
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Corrupted dll files
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''4'''
| style="background:#f0f0f0;" align="center"|AC #4
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects presence of trainer. This is the most common AC code for attempted cheating, mostly with cheats designed for MTA.
Note: disabling this code is unlikely to produce expected results, in accordance with what is mentioned in the "DISCLAIMER" part.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''5'''
| style="background:#f0f0f0;" align="center"|AC #5
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''6'''
| style="background:#f0f0f0;" align="center"|VF #6
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer incl.: player movement, health/damage, weapons, money, gamespeed, game cheats, aimbot
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''7'''
| style="background:#f0f0f0;" align="center"|VF #7
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects use of trainer.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''8'''
| style="background:#f0f0f0;" align="center"|VF #8
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Detects unauthorized mods
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''11'''
| style="background:#f0f0f0;" align="center"|AC #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #11
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Dll injector / Trainer
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''13'''
| style="background:#f0f0f0;" align="center"|SD #13
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Data files issue
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''17'''
| style="background:#f0f0f0;" align="center"|VF #17
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Speed / wall hacks
|-
| scope="row" style="background:#e0e0e0;" align="center" rowspan="2"|'''21'''
| style="background:#f0f0f0;" align="center"|AC #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| More trainers
|-
| style="background:#f0f0f0;" align="center"|VF #21
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Custom gta_sa.exe
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''26'''
| style="background:#f0f0f0;" align="center"|SD #26
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;" align="center"|1.3.4-9.05858
| style="background:#f0f0f0;"| Anti-cheat component blocked
|}

==<enablesd></enablesd>==
Comma separated list of enabled Special Detections (SD #). A special detection is a type of anti-cheat for (usually) harmless game modifications. Competitive servers or servers dealing with a certain problem structurally may wish to enable special detections, but most servers should leave this setting blank. Available codes are:
{| border="0" cellpadding="1" cellspacing="2"
|-
! scope="col" style="background:#d0d0d0;"|Code for <enablesd>
! scope="col" style="background:#d0d0d0;"|Displayed on detect
! scope="col" style="background:#d0d0d0;"|Required server version
! scope="col" style="background:#d0d0d0;"|Required <minclientversion>
! scope="col" style="background:#d0d0d0;"|Notes
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''12'''
| style="background:#f0f0f0;" align="center"|SD #12
| style="background:#f0f0f0;" align="center"|any
| style="background:#f0f0f0;"|
| style="background:#f0f0f0;"| Disallow custom D3D9.DLL
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''14'''
| style="background:#f0f0f0;" align="center"|SD #14
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;" align="center"|1.3.1-9.04605
| style="background:#f0f0f0;"| Disallow virtual machines such as VMWare
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''15'''
| style="background:#f0f0f0;" align="center"|SD #15
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;" align="center"|1.3.1-9.04791
| style="background:#f0f0f0;"| Disallow disabled driver signing
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''16'''
| style="background:#f0f0f0;" align="center"|SD #16
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow disabled anti-cheat components. This is triggered when an anti-cheat component can not start. It is usually due to some problem with the PC and might be fixed by a reboot. Can also be triggered by a virus.
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''20'''
| style="background:#f0f0f0;" align="center"|SD #20
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;" align="center"|1.3.1-9.05097
| style="background:#f0f0f0;"| Disallow non-standard gta3.img or gta_int.img (For servers not using [[onPlayerModInfo]])
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''22'''
| style="background:#f0f0f0;" align="center"|SD #22
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Lua script files)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''23'''
| style="background:#f0f0f0;" align="center"|SD #23
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.5.2-9.07911
| style="background:#f0f0f0;"| Disallow resource download errors/corruption (Non-Lua files e.g. png,dff)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''28'''
| style="background:#f0f0f0;" align="center"|SD #28
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;" align="center"|1.3.4-9.05884
| style="background:#f0f0f0;"| Disallow Linux Wine
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''31'''
| style="background:#f0f0f0;" align="center"|SD #31
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.3-9.11204
| style="background:#f0f0f0;"| Ignore injected keyboard inputs (e.g. from AutoHotkey, macro's and on screen keyboard)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''32'''
| style="background:#f0f0f0;" align="center"|SD #32
| style="background:#f0f0f0;" align="center"|1.5.3
| style="background:#f0f0f0;" align="center"|1.5.4-9.11528
| style="background:#f0f0f0;"| Ignore injected mouse button inputs and movement (this detection can prevent an ambigious type of aim hacks (bullet spread/recoil manipulation)
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''33'''
| style="background:#f0f0f0;" align="center"|SD #33
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow software of the category 'Net limiter' (ideal for lagswitching or causing structural lag, but may also be used for benign purposes)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''34'''
| style="background:#f0f0f0;" align="center"|SD #34
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow internet café users ('''only''' use as last resort to combat mass ban evasion using café PC's)
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''35'''
| style="background:#f0f0f0;" align="center"|SD #35
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;" align="center"|1.5.6
| style="background:#f0f0f0;"| Disallow certain software with "FPS locking" capabilities, for example Fraps recorder. 
Particularly racing gamemodes are impacted by players that use FPS lock hotkey at times they need an unfair advantage (like, to drive through a loop faster) or a small speed boost. 
 '''Note''': it would be better if you use this SD in a custom implementation only (using [[onPlayerACInfo]]) instead of kick in mtaserver.conf. For example so that it would only kick when they approach a loop, or are playing a map sensitive to this abuse. Because you'll have to tread carefully, since Fraps is also a popular recording tool. 
|
|-
| scope="row" style="background:#e0e0e0;" align="center"|'''36'''
| style="background:#f0f0f0;" align="center"|SD #36
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;" align="center"|1.5.7
| style="background:#f0f0f0;"| Disallow AutoHotKey base application (used to load .ahk files) and Ahk2Exe binaries with embedded scripts 
Most servers won't need this (cancelling the input sent into GTA with SD #31 and #32 would be sufficient), but some competitive servers have problems with AutoHotKey interfacing with Windows rather than MTA (which would get ignored by the game), for example toggling firewall rules for lag switching, and pure hotkey toggling of effects that give unfair advantage (e.g causing small freezes). As you can see, the possibilities are endless (including things MTA or scripting can't be expected to stop from the roots). 
MTA won't scan the content of .ahk files loaded into the AutoHotKey application (and invididual signatures for abusive ones would be too much work for MTA), so with SD #36 server owners are still in power should they decide to stop it this way. If the abuse consists of lag switching, a scripted solution (example: https://github.com/Lpsd/ConGuard) would still be the recommended approach. 
Because note that, while the currently circulating abuse scripts are mostly AHK-based, they can easily migrate (and MTA isn't guaranteed to add SD # for that as well).
 
Also, remember that the AutoHotKey base application can have legitimate uses, so only use when you have no other options for competitive balance
|}

We are constantly working on keeping the definitions for above SD (special detections) up-to-date, so as to ensure all violating software or circumstances that you opt-in to disable gets detected once used. While we are pro-actively checking if new or unknown software/tools are still being detected under the same signature, it's possible that something slips through the cracks. Therefore, you can help us if you come across anything that should be detectable using SD # but is not currently; send a forum PM to Dutchman101 or ccw with your report.

==<client_file name="data/carmods.dat" verify="0"/>==
By default, clients may not join a server if they have customized GTA:SA data files. Adding one or more of the above lines excludes files from validation. The file names that can be used are:

* "anim/ped.ifp"
* "data/animgrp.dat"
* "data/ar_stats.dat"
* "data/carmods.dat"
* "data/clothes.dat"
* "data/default.dat"
* "data/default.ide"
* "data/furnitur.dat"
* "data/gta.dat"
* <strike>"data/handling.cfg"</strike> - this is unavailable because MTA always ignores this file so that [[setVehicleHandling]] works correctly. [[Handling.cfg|Click here]]'' if you want to load custom handling.cfg files.
* "data/maps" - this applies to all files within this folder
* "data/melee.dat"
* "data/object.dat"
* "data/peds.ide"
* "data/pedstats.dat"
* "data/plants.dat"
* "data/procobj.dat"
* "data/surface.dat"
* "data/surfinfo.dat"
* "data/timecyc.dat" - minimum server version 1.5.6-9.18322
* "data/txdcut.ide"
* "data/vehicles.ide"
* "data/water1.dat"
* "data/water.dat"
* "data/weapon.dat"
* "models/coll/weapons.col"

==<hideac></hideac>==

You can use this setting in mtaserver.conf to hide the AC info from the client, showing the following line upon join:
Server AC info: [Undisclosed]

Values: 0 - disabled, 1 - enabled; default value: 0.

=Client=
When joining a server, the server AC info is displayed in the client console (F8), for example:

Server AC Info: [Allowed client files: None] [Disabled AC: None] [Enabled SD: None]

''Disabled AC'' contains the contents of the server setting from <code><disableac></disableac></code>, and ''Enabled SD'' contains the contents of the server setting from <code><enablesd></enablesd></code>.

Allowed client files contains numbers to indicate which client files the server allows to be modified. The numbers represent these files:

*1 - "data/carmods.dat"
*2 - "data/animgrp.dat"
*4 - "data/ar_stats.dat"
*5 - "data/melee.dat"
*6 - "data/clothes.dat"
*7 - "data/object.dat"
*8 - "data/default.dat"
*9 - "data/surface.dat"
*10 - "data/default.ide"
*12 - "data/gta.dat"
*13 - "data/surfinfo.dat"
*14 - "data/peds.ide"
*15 - "data/vehicles.ide"
*16 - "data/pedstats.dat"
*17 - "data/water.dat"
*18 - "data/txdcut.ide"
*19 - "data/water1.dat"
*20 - "models/coll/weapons.col"
*21 - "data/weapon.dat"
*22 - "data/plants.dat"
*23 - "anim/ped.ifp"
*24 - "data/furnitur.dat"
*25 - "data/procobj.dat"
*26 - "data/maps"
*27 - "data/timecyc.dat"

'''''Note:''''' ''If the info is marked "Undisclosed", it means that the server has decided not to disclose the AC info to the client.''

===Using modified files===
If you want to use modified data files from your GTA:SA install directory, check this check box:

Settings -> Multiplayer -> Use customized GTA:SA files

The checkbox only appears if your GTA:SA data files are customized.

'''''Note:''''' ''This will restrict your access to some public servers as most do not allow customized data files.''

[[Category: Support]]
[[ru:Anti-cheat guide]]

IsLineOfSightClear

2020-06-14T09:57:41Z

Qaisjp: fix unnecessary line break

__NOTOC__
{{Client function}}
This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements. Use [[processLineOfSight]] if you want more information about what the ray hits.

{{Note|This function does currently NOT support collisions with the "shootthrough" flag enabled. That means: isLineOfSightClear will never collide with such collisions and this can lead to unreliabilities. The "shootthrough" flag is used by many beach/sand/underwater objects.}}

==Syntax==
<syntaxhighlight lang="lua">
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPeds = true,
bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The first point's world X coordinate.
*'''startY:''' The first point's world Y coordinate.
*'''startZ:''' The first point's world Z coordinate.
*'''endX:''' The second point's world X coordinate.
*'''endY:''' The second point's world Y coordinate.
*'''endZ:''' The second point's world Z coordinate.

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences). This flag originally allows some objects to be walked on but you can shoot throug them.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
Returns ''true'' if the line between the specified points is clear, ''false'' if there's an obstacle or if invalid parameters are passed.

==Example==
<section name="Client" class="client" show="false">
isLineOfSightClear is the economical way to cast a ray in the world.
This example demonstrates how you can easily implement basic NPC behaviour such as jumping obstacles. A 3D line is drawn connecting the two points in the ray.
<syntaxhighlight lang="lua">
local t_Data = {}

local function updateNPC ()
if (not isElement(t_Data.ped) or (getElementHealth(t_Data.ped) == 0)) then
return toggleNPCFollower ()
end

local t_PlayerPos = {getElementPosition(localPlayer)}
local t_PedPos = {getElementPosition(t_Data.ped)}

local intDistance = getDistanceBetweenPoints3D (t_PedPos[1], t_PedPos[2], t_PedPos[3], unpack(t_PlayerPos))
if (intDistance < 4) then
setPedControlState (t_Data.ped, 'forwards', false)
return true
end

-- Calculate the rotation between ped and player position
local intPedRot = -math.deg (math.atan2(t_PlayerPos[1] - t_PedPos[1], t_PlayerPos[2] - t_PedPos[2]))
if intPedRot < 0 then intPedRot = intPedRot + 360 end;

setElementRotation (t_Data.ped, 0, 0, intPedRot, 'default', true)
-- At this point we know that the ped needs to move it
setPedControlState (t_Data.ped, 'forwards', true)

local bPathClear = true
local t_Matrix = getElementMatrix (t_Data.ped)

-- Calculate a position 1m ahead of ped
local int_RayX = t_Matrix[2][1] + t_Matrix[4][1]
local int_RayY = t_Matrix[2][2] + t_Matrix[4][2]
local int_RayZ = t_Matrix[2][3] + t_Matrix[4][3]

-- We cast 10 rays 1m ahead of the ped
for i = 1, 10 do
local intSourceX, intSourceY, intSourceZ = t_PedPos[1], t_PedPos[2], t_PedPos[3]

-- The target position height is identical to the center of the ped (1m above ground)
-- We lower this value by 0.5m to detect short obstacles
local intTargetX, intTargetY, intTargetZ = int_RayX, int_RayY, int_RayZ - 0.5 + i*0.2

bPathClear = isLineOfSightClear (intSourceX, intSourceY, intSourceZ, intTargetX, intTargetY, intTargetZ, true, true, false, true)
dxDrawLine3D (intSourceX, intSourceY, intSourceZ, intTargetX, intTargetY, intTargetZ, bPathClear and tocolor(255,255,255,255) or tocolor(255,0,0,255))

if (not bPathClear) then
break
end
end

if (not bPathClear) then
setPedControlState (t_Data.ped, 'jump', true)
else
setPedControlState (t_Data.ped, 'jump', false)
end

if (intDistance > 15) then
setPedControlState (t_Data.ped, 'sprint', true)
else
setPedControlState (t_Data.ped, 'sprint', false)
end
end

function toggleNPCFollower ()
if (t_Data.ped) then
if (t_Data.updateNPCTimer) then
if (isTimer(t_Data.updateNPCTimer)) then
killTimer (t_Data.updateNPCTimer)
end
end
if (isElement(t_Data.ped)) then
destroyElement (t_Data.ped)
end
t_Data.ped = nil
return true
end

local intX, intY, intZ = getElementPosition (localPlayer)
local _, _, intRZ = getElementRotation (localPlayer)
local t_Matrix = getElementMatrix (localPlayer)

-- Calculate a position 4m behind local player
local intPedX = -4 * t_Matrix[2][1] + t_Matrix[4][1]
local intPedY = -4 * t_Matrix[2][2] + t_Matrix[4][2]
local intPedZ = -4 * t_Matrix[2][3] + t_Matrix[4][3]

t_Data.ped = createPed (0, intPedX, intPedY, intPedZ, intRZ)
t_Data.updateNPCTimer = setTimer (updateNPC, 50, 0)
end
addCommandHandler ('npc', toggleNPCFollower)
</syntaxhighlight>
</section>

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

RemoveWorldModel

2020-06-12T15:20:15Z

Qaisjp: Fix default interior value (documentation was wrong)

__NOTOC__
{{Server client function}}

This function is used to remove a world object.

==Syntax==
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = -1 ] )</syntaxhighlight>

===Required Arguments===
*'''modelID:''' A whole integer specifying the GTASA object model ID.
*'''radius:''' A floating point number representing the radius that will be eliminated.
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{New items|3.0132|1.3.2|
*'''interior:''' The interior ID to apply the removal to. Some objects in interior 13 show in all interiors so if you want to remove everything in interior 0 also remove everything in interior 13. A value of -1 here will affect all interiors.}}
===Returns===
Returns ''true'' if the [[object]] was removed, ''false'' if invalid arguments were passed.

==Requirements==
{{Requirements|1.2.0-9.03618|1.2.0-9.03618|}}

==Example==
This example will removes buildings on BigEar:
<syntaxhighlight lang="lua">
removeWorldModel(16617,1000,-300,1556,75) --lod
removeWorldModel(16616,1000,-300,1556,75) --lod
removeWorldModel(16615,1000,-300,1556,75) --lod
removeWorldModel(16138,1000,-300,1556,75) -- model
</syntaxhighlight>

This example removes CJ house:
<syntaxhighlight lang="lua">
for i=700,20000 do
removeWorldModel(i,10,2494,-1696,17)
end
</syntaxhighlight>

This server script example removes all models, everywhere:
<syntaxhighlight lang="lua">
for i=550,20000 do
removeWorldModel(i,10000,0,0,0)
end
setOcclusionsEnabled(false) -- Also disable occlusions when removing certain models
setWaterLevel(-5000) -- Also hide the default water as it will be full of holes
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04636|Added interior argument}}
{{ChangelogItem|1.3.1-9.04844|Everything streams out fine now.}}

==See Also==
{{Client_world_functions}}

Meta.xml

2020-06-02T07:55:20Z

Qaisjp: fix aclrequest docs

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
** '''gamemodes:''' The gamemodes to be compatible with the resource. It must be the name of the gamemode resource, not the gamemode name. If you want it to be compatible with multiple gamemodes, it must be in a comma-separated list without spaces. (e.g. gamemodes="test1,test2").
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".
**'''cache:''' When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. ''(Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)''
**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]].
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings />''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
** '''<setting />''' Resource settings can be accessed by resource and Admin panel, possible parameters are:
*** '''name:''' The setting name used by the scripts to get or set the setting value
*** '''value:''' The setting default value used by the scripts
*** '''friendlyname:''' A friendly name to the setting (optional)
*** '''accept:''' The values the setting could accept (optional)
*** '''examples:''' An Example of a value (optional)
*** '''desc:''' A description of the setting (optional)
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
** '''<right />''' an individual right
***'''name:''' The right name.
***'''access:''' Set to ''true'' to allow the resource to access this right. Set to ''false'' to deny the access to this right.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data for all resources. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data for all resources. (If '''false''' and '''true''' are set in different resources, true will have priority and all resources will transfer map element data)
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop />''' OOP - Please refer to [[OOP]] for documentation.
**'''false:''' Disable OOP.
**'''true:''' Enable OOP.
}}
{{New feature/item|3.0150|1.5.0|7308|
*'''<download_priority_group />''' If not set, the download priority group for a resource defaults to 0. If this is set higher than 0, then the resource will be downloaded and started on the client earlier than other resources. If set to less than 0, the resource will be downloaded and started on the client later than other resources.
}}

== Example ==
Here's an example of a meta file using some of the tags mentioned:
{{#tag:syntaxhighlight |
<meta>
<info author="Slothman" version="1.0.2" name="Stealth" description="Allow scripts to insert a ped that simulates combat with a real player" type="gamemode" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client" validate="true"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>

<map src="base.map" dimension="1"/>

<file src="riot_shield.txd" download="false" />
<file src="riot_shield.dff" download="false" />
<file src="riot_shield.col" download="false" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<config src="help.xml" type="client"/>

<export function="exampleExport1" type="server" />
<export function="exampleExport2" type="client" />
<export function="exampleExport3" type="shared" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="isAllowedToShoot" value="true" />
<setting name="admingroup" value="Admin,AdminPlus"
friendlyname="Admin group list"
group="_Advanced"
accept="*"
examples="Admin,Moderator,SuperModerator"
desc="To use this resource, the player must belong to one of the groups listed."
/> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>

<min_mta_version server="1.5.2-9.07903" client="1.5.2-9.07903" />

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>

<sync_map_element_data>false</sync_map_element_data>

<oop>false</oop>

<download_priority_group>0</download_priority_group>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[hu:Meta.xml]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

Changes in 1.5.8

2020-05-31T17:49:17Z

Qaisjp: use my username

<pageclass class="#4286f4" subcaption="Future release"></pageclass>
{{Changelogs}}
__NOTOC__
* GitHub commit log: https://github.com/multitheftauto/mtasa-blue/compare/1.5.7...master
* GitHub milestone: https://github.com/multitheftauto/mtasa-blue/milestone/2
* So far https://github.com/multitheftauto/mtasa-blue/compare/632130e...master

'''This changelog is partial and needs updating.'''

== Main Additions / Changes ==
<section show="true">
* Add [[dxDrawPrimitive3D]] and [[dxDrawMaterialPrimitive3D]] ([https://github.com/multitheftauto/mtasa-blue/pull/760 #760] by '''CrosRoad95''')
* Add functions to modify dynamic objects' behaviour ([https://github.com/multitheftauto/mtasa-blue/pull/784 #784] by '''forkerer''')
* Add dynamic ped ID allocating using [[engineRequestModel]] and [[engineFreeModel]] ([https://github.com/multitheftauto/mtasa-blue/commit/475544f1753ce1af24c4cdff7f0d0be48ede709b #349] by '''lopezloo''' + '''Neproify''' + '''Arran''' + '''qaisjp''')
</section>

== Statistics ==
<section show="false">
These are some statistics since the [[Changes in 1.5.7|previous release]].
* This is the '''25th''' 1.x.x release, planned to be released 6.6.2020
* '''{{date difference|2019|8|31}}''' days
* '''14''' new functions
* '''0''' new events
* '''0''' deprecations
* '''7''' bug fixes and changes
* '''111''' commits ([https://github.com/multitheftauto/mtasa-blue/compare/1.5.7...master see comparison])
* '''0''' new open Mantis issues
* '''0''' resolved Mantis issues
* '''5''' closed Mantis issues
* '''21''' new open GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+created%3A%3E%3D2019-08-31 see list])
* '''12''' resolved GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?utf8=%E2%9C%93&q=is%3Aclosed+is%3Aissue+milestone%3A1.5.8 see list])
* '''9''' closed GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?utf8=%E2%9C%93&q=is%3Aclosed+is%3Aissue+closed%3A%3E%3D2019-08-31+no%3Amilestone see list])
* '''4''' new open GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+created%3A%3E%3D2019-08-31 see list])
* '''15''' merged GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?q=is%3Apr+milestone%3A1.5.8+is%3Amerged see list])
* '''3''' closed GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aunmerged+closed%3A%3E%3D2019-08-31 see list])
* '''15''' contributors of which '''2''' are new ([https://github.com/multitheftauto/mtasa-blue/graphs/contributors?from=2019-08-31&to=2020-08-31&type=c see list])
* '''67+''' total contributors ([https://github.com/multitheftauto/mtasa-blue/graphs/contributors see list])
* '''2''' vendor updates


'''Note:''' Last update to these statistics was made
{{#ifeq: {{date difference|2019|10|9}} | 0 | today |
{{#ifeq: {{date difference|2019|10|9}} | 1 | yesterday |
{{date difference|2019|10|9}} days ago
}}
}}.
</section>

== Scripting ==
=== 5 Backwards Incompatible Changes ===
These changes will take effect in 1.6:
* [[callRemote]] callbacks currently set the error code to '''nil''' when there is no error. In 1.6, to be consistent with [[fetchRemote]], the error code reported will be '''0'''. See [https://github.com/multitheftauto/mtasa-blue/issues/294 GitHub #294].
* Since July 2016 if you provide an invalid string like '''"randomstring"''' when a function expects a number, the string will be treated as '''0''' and raise a script warning. In 1.6 this will be an error. You will still be able to provide strings containing numbers (e.g. '''"100"''' and '''"12.34"'''), this change only affects invalid strings. See [https://github.com/multitheftauto/mtasa-blue/issues/1043 GitHub #1043].
* When providing a width and height of (0, 0) to [[createBrowser]] or [[guiCreateBrowser]] you will encounter a script error instead of a warning. The warning was introduced Feb 2019. See [https://github.com/multitheftauto/mtasa-blue/issues/1069 GitHub #1069].
* Some functions expect only unsigned integers (positive numbers), and since Jan 2016 providing negative numbers would be a warning. This will now be an error. See [https://github.com/multitheftauto/mtasa-blue/issues/1070 GitHub #1070].
* Since Aug 2015, we replaced the custom '''mtalocal://''' URL scheme with '''http://mta/resourceName/blah.html'''. This '''mtalocal://''' URL scheme will now be removed. See [https://github.com/multitheftauto/mtasa-blue/issues/1071 GitHub #1071].

This list is inconclusive and we may introduce more changes later.

=== Client ===
<section show="true">
==== 11 New Functions ====
* Add [[setPedFightingStyle]] (previously available server-side only) ([https://github.com/multitheftauto/mtasa-blue/pull/810 #810] by '''StrixG''')
* Add [[setPedArmor]] (previously available server-side only) ([https://github.com/multitheftauto/mtasa-blue/pull/811 #811] by '''StrixG''')
* Add [[areVehicleLightsOn]] ([https://github.com/multitheftauto/mtasa-blue/pull/938 #938] by '''StrixG''')
* Add [[dxDrawPrimitive3D]] and [[dxDrawMaterialPrimitive3D]] ([https://github.com/multitheftauto/mtasa-blue/pull/760 #760] by '''CrosRoad95''')
* Add functions to modify dynamic objects' behaviour ([https://github.com/multitheftauto/mtasa-blue/pull/784 #784] by '''forkerer''')
** [[engineGetModelPhysicalPropertiesGroup]]
** [[engineRestoreModelPhysicalPropertiesGroup]]
** [[engineSetModelPhysicalPropertiesGroup]]
** [[engineGetObjectGroupPhysicalProperty]]
** [[engineRestoreObjectGroupPhysicalProperties]]
** [[engineSetObjectGroupPhysicalProperty]]
* Add dynamic ped ID allocating using [[engineRequestModel]] and [[engineFreeModel]] ([https://github.com/multitheftauto/mtasa-blue/commit/475544f1753ce1af24c4cdff7f0d0be48ede709b #349] by '''lopezloo''' + '''Neproify''' + '''Arran''' + '''qaisjp''')


</section>

=== Server ===
<section show="true">
==== 2 New Functions ====
* Add [[setPlayerScriptDebugLevel]] and [[getPlayerScriptDebugLevel]] ([https://github.com/multitheftauto/mtasa-blue/pull/826 #826] by '''knitz12''')


==== Bug Fixes & Changes ====

* Fix [[iprint]] to be able to read and output nil arguments properly ([https://github.com/multitheftauto/mtasa-blue/pull/1064 #1064] by '''TheNormalnij''')
</section>

=== Shared (''Client & Server side'') ===
<section show="true">
==== New Functions ====
* Add [[xmlLoadString]] ([https://github.com/multitheftauto/mtasa-blue/pull/809 #809] by '''LopSided''')

</section>

== Client ==
<section show="true">
=== 6 Bug Fixes & Changes ===
* Add new client setting to toggle external sounds ([https://github.com/multitheftauto/mtasa-blue/pull/834 #834] by '''patrikjuvonen''')
* Fix crash when attempting to stream out a sound that's not streamed in (See commit [https://github.com/multitheftauto/mtasa-blue/commit/e1b7c730448d12a5eeb452239e8053e86924294f e1b7c73] by '''sbx320''')
* Fix [[dxDrawCircle]] ''segments'' argument being wrongly offset by one ([https://github.com/multitheftauto/mtasa-blue/pull/1079 #1079] by '''ApeLsiN4eG''')
* Fix potential crash when moving objects (See commit [https://github.com/multitheftauto/mtasa-blue/commit/90895c221549893501f5f717af3ca56878e29b5d 90895c2] by '''botder''')
* Update credits (See commit [https://github.com/multitheftauto/mtasa-blue/commit/39227d795efafe940dc6c317c20b0162b1bd0bb3 39227d7] by '''qaisjp''')
* Don't apply damage to peds without a game entity (See commit [https://github.com/multitheftauto/mtasa-blue/commit/632130e36a96071290593fc3c677a536f7b19e1f 632130e] by '''botder''')
* Fix doors state with setElementModel ([https://github.com/multitheftauto/mtasa-blue/pull/599 #599] by '''FileEX''')

=== 2 Vendor Updates ===
* Update BASS libraries (See commit [https://github.com/multitheftauto/mtasa-blue/commit/e5ede83b936e0e3c59d3670969e72b9583c0a219 e5ede83] by '''Dutchman101''')
* Update CEF from 76.1.13+gf19c584 (Chromium 76.0.3809.132) to 77.1.12+gc63c001 ([https://chromereleases.googleblog.com/2019/09/stable-channel-update-for-desktop_18.html Chromium 77.0.3865.90]) (See commit [https://github.com/multitheftauto/mtasa-blue/commit/28ba1da86b604ecfe36af957995cbda2d771a9b8 28ba1da] by '''Jusonex''')
</section>


== Extra information ==
''More detailed information available on our GitHub repositories:
:* [https://github.com/multitheftauto/mtasa-blue MTA:SA Blue]
:* [https://github.com/multitheftauto/mtasa-resources MTA:SA Official Resources]

[[Category:Changelog]]
[[Category:Incomplete]]

IsResourceProtected

2020-05-31T17:31:01Z

Qaisjp: Created page with "__NOTOC__ {{Server function}}  {{New feature/item|3.0158|1.5.7|20468|..."

__NOTOC__
{{Server function}}

{{New feature/item|3.0158|1.5.7|20468|
This will check if a resource is currently protected, as defined in [[Server_mtaserver.conf#resource|mtaserver.conf]].
}}
==Syntax==

<syntaxhighlight lang="lua">
bool isResourceProtected(resource theResource)
</syntaxhighlight>
{{OOP||[[resource]]:isProtected|protected}}
===Required Arguments===

*'''theResource:''' the resource to check

===Returns===

Returns ''true'' if the resource is 'protected', ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
{{Needs Example}}
<syntaxhighlight lang="lua">
-- todo
</syntaxhighlight>
</section>

==See Also==

{{Resource_functions}}

Template:Player functions

2020-05-20T10:36:17Z

Qaisjp: ver

* [[forcePlayerMap]]
* [[getAlivePlayers]]
* [[getDeadPlayers]]
* [[getPlayerACInfo]]
* [[getPlayerAnnounceValue]]
* [[getPlayerBlurLevel]]
* [[getPlayerCount]]
* [[getPlayerFromName]]
* [[getPlayerIdleTime]]
* [[getPlayerIP]]
* [[getPlayerMoney]]
* [[getPlayerName]]
* [[getPlayerNametagColor]]
* [[getPlayerNametagText]]
* [[getPlayerPing]]
{{New items|3.0158|1.5.7|
*[[getPlayerScriptDebugLevel]]
|19626}}
* [[getPlayerSerial]]
* [[getPlayerTeam]]
* [[getPlayerVersion]]
* [[getPlayerWantedLevel]]
* [[getRandomPlayer]]
* [[givePlayerMoney]]
* [[isPlayerMapForced]]
* [[isPlayerMuted]]
* [[isPlayerNametagShowing]]
* [[isVoiceEnabled]]
* [[redirectPlayer]]
{{New items|3.0152|1.5.1-7633|
*[[resendPlayerACInfo]]
}}
* [[resendPlayerModInfo]]
* [[setPlayerAnnounceValue]]
* [[setPlayerBlurLevel]]
* [[setPlayerHudComponentVisible]]
* [[setPlayerMoney]]
* [[setPlayerMuted]]
* [[setPlayerName]]
* [[setPlayerNametagColor]]
* [[setPlayerNametagShowing]]
* [[setPlayerNametagText]]
{{New items|3.0158|1.5.7|
*[[setPlayerScriptDebugLevel]]
|19626}}
* [[setPlayerTeam]]
* [[setPlayerVoiceBroadcastTo]]
* [[setPlayerVoiceIgnoreFrom]]
* [[setPlayerWantedLevel]]
* [[spawnPlayer]]
* [[takePlayerMoney]]
* [[takePlayerScreenShot]]

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

GetPlayerScriptDebugLevel

2020-05-20T10:36:12Z

Qaisjp: ver

__NOTOC__
{{Server function}}

{{New feature/item|3.0158|1.5.7|19626|
This will allow you to retrieve the player current debug script level.
}}
==Syntax==

<syntaxhighlight lang="lua">
int getPlayerScriptDebugLevel( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getScriptDebugLevel|scriptDebugLevel}}
===Required Arguments===

*'''thePlayer:''' The person whose debug script level you want

===Returns===

Returns an ''int'' with the player debug script level, ''false'' if the player is invalid.

==Example==


Displays a message in the chat what is the player's debug level.
<syntaxhighlight lang="lua">
function showdebug (player)
local level = getPlayerScriptDebugLevel( player )
outputChatBox( "Your Script Debug Level: " .. level )
end
addCommandHandler ( "showdebug", showdebug )
</syntaxhighlight>

==See Also==

{{Player_functions}}

SetPlayerScriptDebugLevel

2020-05-20T10:35:45Z

Qaisjp: ver

__NOTOC__
{{Server function}}

{{New feature/item|3.0158|1.5.7|19626|
This will set player's debug level, equivalent to [[Debugging|debugscript <level>]].
}}
==Syntax==

<syntaxhighlight lang="lua">
bool setPlayerScriptDebugLevel ( player thePlayer, int level )
</syntaxhighlight>
{{OOP||[[player]]:setScriptDebugLevel|scriptDebugLevel}}
===Required Arguments===

*'''thePlayer:''' The player whose debug level you wish to change
*'''level:''' 0: close debug console, 1: only errors, 2: errors and warnings, 3: errors, warnings and info messages

===Returns===

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

==Example==
<section name="Server" class="server" show="true">
This code will set joining players debug level to (3), (It is no recommended to use it in production, specially if you have sensitive data in your logs).
<syntaxhighlight lang="lua">
addEventHandler('onPlayerJoin', root, function()
setPlayerScriptDebugLevel(source, 3)
end)
</syntaxhighlight>
</section>

==See Also==

{{Player_functions}}

Template:Element functions

2020-05-20T10:35:00Z

Qaisjp: ver

*[[attachElements]]
*[[clearElementVisibleTo]]
*[[cloneElement]]
*[[createElement]]
*[[destroyElement]]
*[[detachElements]]
*[[getAllElementData]]
*[[getAttachedElements]]
*[[getElementAlpha]]
*[[getElementAttachedOffsets]]
*[[getElementAttachedTo]]
*[[getElementCollisionsEnabled]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementColShape]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementMatrix]]
*[[getElementModel]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRotation]]
*[[getElementSyncer]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getElementZoneName]]
*[[getElementsByType]]
*[[getElementsWithinColShape]]
*[[getLowLODElement]]
*[[getRootElement]]
{{New items|3.0158|1.5.7|
*[[hasElementData]]
|20447}}
*[[isElement]]
*[[isElementAttached]]
*[[isElementCallPropagationEnabled]]
*[[isElementDoubleSided]]
*[[isElementFrozen]]
*[[isElementInWater]]
*[[isElementLowLOD]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[isElementWithinMarker]]
*[[removeElementData]]
*[[setElementAlpha]]
{{New items|3.0156|1.5.5|
* [[setElementAngularVelocity]]
* [[getElementAngularVelocity]]
|14165}}
*[[setElementAttachedOffsets]]
*[[setElementCallPropagationEnabled]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementDoubleSided]]
*[[setElementFrozen]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementInterior]]
*[[setElementModel]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementRotation]]
*[[setElementSyncer]]
*[[setElementVelocity]]
*[[setElementVisibleTo]]
*[[setLowLODElement]]
<noinclude>[[Category:Functions templates]]</noinclude>

HasElementData

2020-05-20T10:34:47Z

Qaisjp: ver

__NOTOC__
{{Server client function}}
{{New feature/item|3.0158|1.5.7|20447|
This function checks if an element has [[element data]] available under a certain key.}}

==Syntax==
<syntaxhighlight lang="lua">bool hasElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:hasData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to check.
*'''key:''' The name of the element data entry you want to check for. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns ''true'' if the element contains element data for ''key'', or ''false'' if the element doesn't exist or there is no data associated with the ''key''.

==Example==
This example outputs a player's favorite animal using a console function 'favoriteAnimal' if they have one set.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function favoriteAnimal ( source, commandName, playerName )
local thePlayer = source
if playerName then -- see if a player was specified
thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player
if not thePlayer then -- if we still couldn't find a player with the specified name...
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
return
end
end

if hasElementData ( thePlayer, "favoriteAnimal" ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "favoriteAnimal", favoriteAnimal )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20447|1.5.7-9.20447|}}

==See Also==
{{Element functions}}

Template:Element functions

2020-05-20T10:33:46Z

Qaisjp: fix version

*[[attachElements]]
*[[clearElementVisibleTo]]
*[[cloneElement]]
*[[createElement]]
*[[destroyElement]]
*[[detachElements]]
*[[getAllElementData]]
*[[getAttachedElements]]
*[[getElementAlpha]]
*[[getElementAttachedOffsets]]
*[[getElementAttachedTo]]
*[[getElementCollisionsEnabled]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementColShape]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementMatrix]]
*[[getElementModel]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRotation]]
*[[getElementSyncer]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getElementZoneName]]
*[[getElementsByType]]
*[[getElementsWithinColShape]]
*[[getLowLODElement]]
*[[getRootElement]]
{{New items|3.0158|1.5.8|
*[[hasElementData]]
|20447}}
*[[isElement]]
*[[isElementAttached]]
*[[isElementCallPropagationEnabled]]
*[[isElementDoubleSided]]
*[[isElementFrozen]]
*[[isElementInWater]]
*[[isElementLowLOD]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[isElementWithinMarker]]
*[[removeElementData]]
*[[setElementAlpha]]
{{New items|3.0156|1.5.5|
* [[setElementAngularVelocity]]
* [[getElementAngularVelocity]]
|14165}}
*[[setElementAttachedOffsets]]
*[[setElementCallPropagationEnabled]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementDoubleSided]]
*[[setElementFrozen]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementInterior]]
*[[setElementModel]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementRotation]]
*[[setElementSyncer]]
*[[setElementVelocity]]
*[[setElementVisibleTo]]
*[[setLowLODElement]]
<noinclude>[[Category:Functions templates]]</noinclude>

HasElementData

2020-05-20T10:33:29Z

Qaisjp: typo

__NOTOC__
{{Server client function}}
{{New feature/item|3.0158|1.5.8|20447|
This function checks if an element has [[element data]] available under a certain key.}}

==Syntax==
<syntaxhighlight lang="lua">bool hasElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:hasData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to check.
*'''key:''' The name of the element data entry you want to check for. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns ''true'' if the element contains element data for ''key'', or ''false'' if the element doesn't exist or there is no data associated with the ''key''.

==Example==
This example outputs a player's favorite animal using a console function 'favoriteAnimal' if they have one set.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function favoriteAnimal ( source, commandName, playerName )
local thePlayer = source
if playerName then -- see if a player was specified
thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player
if not thePlayer then -- if we still couldn't find a player with the specified name...
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
return
end
end

if hasElementData ( thePlayer, "favoriteAnimal" ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "favoriteAnimal", favoriteAnimal )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20447|1.5.7-9.20447|}}

==See Also==
{{Element functions}}

HasElementData

2020-05-20T10:33:05Z

Qaisjp: fix version

__NOTOC__ {{Server client function}}
{{New feature/item|3.0158|1.5.8|20447|
This function checks if an element has [[element data]] available under a certain key.
}}

==Syntax==
<syntaxhighlight lang="lua">bool hasElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:hasData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to check.
*'''key:''' The name of the element data entry you want to check for. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns ''true'' if the element contains element data for ''key'', or ''false'' if the element doesn't exist or there is no data associated with the ''key''.

==Example==
This example outputs a player's favorite animal using a console function 'favoriteAnimal' if they have one set.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function favoriteAnimal ( source, commandName, playerName )
local thePlayer = source
if playerName then -- see if a player was specified
thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player
if not thePlayer then -- if we still couldn't find a player with the specified name...
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
return
end
end

if hasElementData ( thePlayer, "favoriteAnimal" ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "favoriteAnimal", favoriteAnimal )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20447|1.5.7-9.20447|}}

==See Also==
{{Element functions}}

Template:Useful Functions

2020-05-13T00:58:59Z

Qaisjp: /* Account functions */ deadlink

__NOTOC__
=== Table functions ===
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[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.empty]] » This function checks whether a table is empty.
*[[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.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[table.element]] » This function returns a new table with only userdata content.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[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.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.

=== 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.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[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.
*[[dxDrawSprite]] » This function draw a sprite in the 3D 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.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[dxDrawRombo]] » This function creates a Rhombus.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.

=== Elements functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[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.
*[[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.
*[[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.

=== Events ===
*[[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]].
*[[getClipboard]] » This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[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.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D 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.
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getDistance]] » Returns the distance between two elements.
*[[getAge]] » This function calculates the age of a given birthday.
*[[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.
*[[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.
*[[getRealMonthH]] » This function convert english months to arabic months
*[[getRealMonthM]] » This function gives you the real months 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.
*[[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.
*[[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.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[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.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
*[[guiComboBoxAddPlayersName]] » This function is add players name in combobox .

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

=====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 ===
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[reMap]] » Re-maps a number from one range to another.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object

=== Ped functions ===
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[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.
*[[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.
*[[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.
*[[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.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[warpToPlayer]]» This function make player warp to another player.

=== Resource functions ===
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[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.
*[[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.
*[[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.
*[[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.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleTurnVelocityCenterOfMass]]» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getPreviousAndNextWeapon]] » This function returns the next weapon and previous.

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

=== 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.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[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.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.

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