Multi Theft Auto: Wiki - User contributions [en]

PlaySound3D

2020-04-22T15:01:18Z

-ffs-Sniper: Added info about supported URL protocols, especially ftp://

__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.<br />
<br />
{{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)
*'''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]]

PlaySound

2020-04-22T14:54:20Z

-ffs-Sniper: add info about supported URL protocols, especially ftp://

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
<br />
{{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)

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

User:-ffs-Sniper

2020-04-22T10:06:51Z

-ffs-Sniper: self update

== Welcome, ==

my name is -ffs-Sniper, leader at the FFS Gaming community with its innovative multigamemode server.

Some folks might remember me as a former leader of the "Small Hustlers Crew" clan in 2009-2011 and former contributor to the MTA DayZ gamemode.

== Current projects: ==

http://ffs.gg/ (Leader - Head of Community)

== Source patches: ==

-https://github.com/multitheftauto/mtasa-blue/commit/522b83efc78f23210dfde1acaeeab8cc4e545c1f

See my wiki contributions [http://wiki.multitheftauto.com/wiki/Special:Contributions/-ffs-Sniper here].

User:-ffs-Sniper

2014-03-19T22:52:49Z

-ffs-Sniper: spring cleaning

== Welcome, ==

I am -ffs-Sniper, leader of the |FFS|Gaming community playing race gamemodes on an innovative multimode server.

Most people might remember me as SHC//Sniper, the former founder and leader of the "Small Hustlers Crew" clan.

== Current projects: ==

http://ffsgaming.net/ (leader and developer)

http://mtadayz.net/ (MTA:DayZ gamemode developer)

== Source patches: ==

-http://code.google.com/p/mtasa-blue/source/detail?r=3909

See my wiki contributions [http://wiki.multitheftauto.com/wiki/Special:Contributions/-ffs-Sniper here].

User:-ffs-Sniper

2013-04-19T21:45:50Z

-ffs-Sniper: Updated my page

== Welcome, ==

I am -ffs-Sniper, leader of the famous |FFS|Gaming community.
Most people know might remember me as SHC//Sniper, the former founder and leader of the SHC clan.

== Current projects: ==

http://ffsgaming.net (leader and developer)

http://community.vavegames.net/ (MTA:DayZ gamemode developer)

== Source patches: ==

-http://code.google.com/p/mtasa-blue/source/detail?r=3909

See my wiki contributions [http://wiki.multitheftauto.com/wiki/Special:Contributions/-ffs-Sniper here].

ToJSON

2013-02-18T20:04:44Z

-ffs-Sniper:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards
}}
This function converts a '''single''' value (preferably a Lua table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]].

==Syntax==

<syntaxhighlight lang="lua">
string toJSON ( var value )
</syntaxhighlight>

===Required Arguments===
*'''var:''' An argument of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.

===Returns===
Returns a JSON formatted string.

==Example==
This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
<syntaxhighlight lang="lua">
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

CreatePed

2012-08-26T21:54:05Z

-ffs-Sniper: Corrected meaning of the servers-side "synced" argument

__NOTOC__
{{Server client function}}
Creates a Ped in the GTA world.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0, bool synced = true ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|GTASA skin ID]].
*'''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==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
*'''synced:''' A boolean value representing whether or not the ped will be synced. Disabling the sync might be useful for frozen or static peds to increase the server performance.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0 ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|GTASA skin ID]].
*'''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==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
</section>

===Returns===
Returns a ped element if it was successfully created.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getResourceRootElement(), pedLoad )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[ru:createPed]]

User:-ffs-Sniper

2012-08-26T21:45:18Z

-ffs-Sniper:

Welcome,
I am -ffs-Sniper, leader of the famous |FFS|Gaming community.
Most people know me as SHC//Sniper, the former founder and leader of the SHC clan.

Source patches:
-http://code.google.com/p/mtasa-blue/source/detail?r=3909

See my contributions [http://wiki.multitheftauto.com/wiki/Special:Contributions/-ffs-Sniper here].

SetVehicleIdleRespawnDelay

2012-08-26T21:43:11Z

-ffs-Sniper: /* Example */ Fixed example

__NOTOC__
{{Server function}}
This function sets the time delay (in milliseconds) the vehicle will remain at its position while empty.
{{Important Note|[[toggleVehicleRespawn]] must be set to true for this function to have any effect}}
==Syntax==
<syntaxhighlight lang="lua">bool setVehicleIdleRespawnDelay ( vehicle theVehicle, int timeDelay )</syntaxhighlight>

===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the respawn delay of.
*'''timeDelay''': The number of milliseconds the vehicle will be allowed to remain unused until it respawns.

==Returns==
Returns ''true'' if the vehicle was found and edited.

==Example==
This example creates a vehicle and sets its respawn delay to 20 seconds.
<syntaxhighlight lang="lua">
theVehicle = createVehicle ( 400, 1, 1, 1 ) -- create us a new vehicle
if ( theVehicle ) then
toggleVehicleRespawn ( theVehicle, true ) -- enable vehicle respawn as it is necessary for the idle respawn to function
setVehicleIdleRespawnDelay ( theVehicle, 20000 ) -- tell the server to respawn the vehicle 20 seconds after it's been left.
end
</syntaxhighlight>

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

CreateResource

2012-05-19T10:55:17Z

-ffs-Sniper: fixed my last revision

__NOTOC__
{{Server function}}
This function creates an new, empty resource. This creates a directory matching the name you specify on disk, then creates an empty meta.xml file with a <meta> element in it.

==Syntax==
<syntaxhighlight lang="lua">
resource createResource ( string resourceName [, string organizationalDir ] )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of the new resource. This should be a valid file name. It's recommended that you do not have spaces or non-ASCII characters in resource names.

===Optional Arguments===
{{OptionalArg}}
* '''organizationalDir''': A string containing the path where the resource should be created (e.g. "[gamemodes]/[amx]").

===Returns===
Returns the [[resource]] element of the new resource if successful, ''false'' otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons.

==Example==
This example creates a new resource named what the player specified. The command is "/new-resource <name>".
<syntaxhighlight lang="lua">
function createNewResource ( source, command, resourceName ) -- Define the source and add a resourceName argument.
if ( resourceName ) then -- Check if they entered a resource name, and if they did...
local resourceName = tostring ( resourceName ) -- Convert the name into a string.
local newResource = createResource ( resourceName ) -- Create the new resource.
if ( newResource ) then -- Check if the resource has been created, if so then...
outputChatBox ( "New resource created succcessfully.", source, 255, 0, 0 ) -- Output it's done.
else -- If the resource wasn't made successfully then...
outputChatBox ( "An un-expected error occured.", source, 255, 0, 0 ) -- Output it failed.
end
else -- If they didn't enter a resource name...
outputChatBox ( "Please specify a name for your new resource.", source, 255, 0, 0 ) -- Tell them to specify a name.
end
end
addCommandHandler ( "new-resource", createNewResource ) -- Make it trigger when somebody types "/new-resource <name>".
</syntaxhighlight>

==See Also==
{{Resource_functions}}

CreateResource

2012-05-19T10:13:27Z

-ffs-Sniper:

__NOTOC__
{{Server function}}
This function creates an new, empty resource. This creates a directory matching the name you specify on disk, then creates an empty meta.xml file with a <meta> element in it.

==Syntax==
<syntaxhighlight lang="lua">
resource createResource ( string resourceName [, string organizationalDir ] )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of the new resource. This should be a valid file name. It's recommended that you do not have spaces or non-ASCII characters in resource names.

===Optional Arguments===
{{OptionalArg}}
* '''organizationalDir''': A string containing the path where the resource should be created (e.g. "[gamemodes]/[amx]").

===Returns===
Returns ''true'' if the resource has been created successfully, ''false'' otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons.

==Example==
This example creates a new resource named what the player specified. The command is "/new-resource <name>".
<syntaxhighlight lang="lua">
function createNewResource ( source, command, resourceName ) -- Define the source and add a resourceName argument.
if ( resourceName ) then -- Check if they entered a resource name, and if they did...
local resourceName = tostring ( resourceName ) -- Convert the name into a string.
local newResource = createResource ( resourceName ) -- Create the new resource.
if ( newResource ) then -- Check if the resource has been created, if so then...
outputChatBox ( "New resource created succcessfully.", source, 255, 0, 0 ) -- Output it's done.
else -- If the resource wasn't made successfully then...
outputChatBox ( "An un-expected error occured.", source, 255, 0, 0 ) -- Output it failed.
end
else -- If they didn't enter a resource name...
outputChatBox ( "Please specify a name for your new resource.", source, 255, 0, 0 ) -- Tell them to specify a name.
end
end
addCommandHandler ( "new-resource", createNewResource ) -- Make it trigger when somebody types "/new-resource <name>".
</syntaxhighlight>

==See Also==
{{Resource_functions}}

ToJSON

2012-04-25T23:26:06Z

-ffs-Sniper: Small fixes

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards
}}
This function converts '''one''' variable (preferably a Lua table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]].

==Syntax==

<syntaxhighlight lang="lua">
string toJSON ( var value )
</syntaxhighlight>

===Required Arguments===
*'''var:''' An argument of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.

===Returns===
Returns a JSON formatted string.

==Example==
This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
<syntaxhighlight lang="lua">
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

User:-ffs-Sniper

2012-03-31T22:36:35Z

-ffs-Sniper:

Welcome, this is -ffs-Sniper, co leader of the |FFS|Gaming community, No 1 in DD/DM racing.
Most people know me as SHC//Sniper, the former founder and leader of the SHC clan.

Source patches:
-http://code.google.com/p/mtasa-blue/source/detail?r=3909

See my contributions [http://wiki.multitheftauto.com/wiki/Special:Contributions/-ffs-Sniper here].

User talk:X86dev

2012-03-31T21:18:02Z

-ffs-Sniper: Question

Cmon x86, not all scripters knew that about setGameSpeed. Why to delete it? Was it specified somewhere else or what? --[[User:The Kid|Benxamix2]] 20:10, 16 November 2011 (CET)

: It's rather obvious and applies to every function that is implemented both server- and client-side. --[[User:Wielebny|Wielebny]] 03:51, 17 November 2011 (CET)

Why did you undo my revision 29816 of createPed? The arguments name is bSynced in the source code while the "b" indicates the type of the argument, a boolean. The "b" is not necessary since the type of the argument is already determined in the syntax. The real LUA name should be "synced". --[[User:-ffs-Sniper|-ffs-Sniper]] 21:18, 31 March 2012 (UTC)

CreatePed

2012-03-30T22:19:20Z

-ffs-Sniper: small fix for the syntax: bSynced -> synced

__NOTOC__
{{Server client function}}
{{Needs_Checking|Please check if I'm right with the synced argument. I've been testing two different peds and discovered the effect described below --[[User:OpenIDUser28|Sniper]] 03:12, 4 September 2011 (CEST)}}
Creates a Ped in the GTA world.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0, bool synced = true ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|GTASA skin ID]].
*'''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==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
*'''synced:''' A boolean value representing whether or not the ped will be fully synchronized even for players that are not within the syncing range. If disabled a player that is more than 100 units away from the ped won't receive any new information about its state and position. This will cause a desync of the ped (useful for frozen/static peds to increase the server perfomance).
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0 ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|GTASA skin ID]].
*'''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==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
</section>

===Returns===
Returns a ped element if it was successfully created.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getResourceRootElement(), pedLoad )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[ru:createPed]]

FromJSON

2012-03-29T19:39:26Z

-ffs-Sniper: Removed "Needs Checking", fixed example

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards
}}
This function parses a [[JSON]] formatted string into variables. You can use [[toJSON]] to encode variables into a JSON string that can be read by this function.

==Syntax==
<syntaxhighlight lang="lua">
var fromJSON ( string json )
</syntaxhighlight>

===Required Arguments===
*'''json:''' A JSON formatted string

===Returns===
Returns variables read from the JSON string.

'''Note:''' Indices of a JSON object such as "1": "cat" are being returned as [[string]], not as [[int]]eger.

==Example==
This makes data equal: ''{ ["1"] = "cat", ["2"] = "mouse", ["3"] = 5, ["4"] = null, ["cat"] = 5, ["mouse"] =1 }''
<syntaxhighlight lang="lua">
local data = fromJSON ( '[ { "1": "cat", "2": "mouse", "3": 5, "4": null, "cat":5, "mouse":1 } ]' )
</syntaxhighlight>

==Example 2==
<syntaxhighlight lang="lua">
local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

Server Manual

2012-03-29T19:03:06Z

-ffs-Sniper: Undo revision 29767 by Khtsjefen (talk) Grammar, broken link

__TOC__

==Getting started==
It is much easier than it looks to get a server up and running for your internet or LAN buddies; follow this wiki article and you will hopefully be on your way to hosting your own MTA:SA server in no time!

==Installing the server==
The dedicated server application is available in different flavours depending on the platform of the server.

===Linux installation===
There are different ways of getting a Linux server up and running:
* [[Building MTASA Server on GNU Linux]]
* [http://linux.mtasa.com Getting a precompiled package]

===Windows installation===
Installation of the MTA:SA server on Windows is easy as pie.
*Go to the [http://mtasa.com/ download page] and download the installer.
*Once the installer is downloaded, open it.
*Select a folder where you want to install the server.
*Click Install.
*Done!

''For a full explanation of acl.xml (access control list) read: [[Access_Control_List|Access Control List]]''<br/><br/>

==Configuring your server==
The Multi Theft Auto dedicated server is initially configurable through it's console window, from within the game, and from a webbrowser. In order to make use of the two last options, it is necessary to add at least one administrator user to your configuration file.

===General configuration===
All general configuration options can be found in the 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' file and can be opened by any regular text editor.

This file is fairly straightforward; every variable has a [[Server_mtaserver.conf|description of what to do with it and how to change it]].

===Port forwarding===
If you run your server on your own private computer, and you have an router between the internet and your computer. You need to forward 3 ports.

First of all open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' and search for the next lines:
<syntaxhighlight lang="xml">
<serverport>22004</serverport>
<httpport>22005</httpport>
</syntaxhighlight>

The ports are needed to setup the server correctly. We explain later how to set them, but first if you want your server to appear in the server browser there is another port we need, and that is the ASE port.
(quick example for how to turn ASE on or off):
<syntaxhighlight lang="xml">
<ase>1</ase> 
</syntaxhighlight>

Now we going to forward the ports in your router, which is not needed if you already have all ports open, or if you don't have a router with a firewall. If so, skip this part.

If you don't know how port forwarding works in your router, go to the [http://portforward.com/ Port Forward website], find your router model there, and follow the instructions there.

In almost every router you can set the port type: UDP or TCP. The following list will explain which port type is needed for what:

Main server port: UDP

HTTP Port: TCP

ASE Port: UDP (this is needed if you want your server to appear in the server list)

The ASE port is also simple to get:

ASE port = Main server port + 123

So, if you have the main server port set to 22003, then the ASE port will be 22126.

Good luck!

''In the latest version of the server, you can check the port status by using the server command [[Server_Commands#openports|openports]].''

===Client Checks===

The MTA server can be configured to disable the anti-cheat. It can also allow specific or all files to be modified (e.g. carmods.dat), and make sure clients are of a minimum version.

All of these settings are within the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]'. See the [[Anti-cheat_guide|Anti-cheat guide]] for more details.<br/>

If you want to force a minimum client version, search for the following line:
<syntaxhighlight lang="xml">
<minclientversion></minclientversion>
</syntaxhighlight>
Accepted values look like: 1.1.1-9.02320

===Adding administrators===
It is strongly recommended to add at least one administrator to your server in order to make use of the built-in webserver to easily maintain and configure your server. This administrator will then also be able to log-in from within the game and control the server.

To add an administrator to your server, follow these steps:<br>
<ol>
<li>While the server is running, add a new account by typing '''[[Server_Commands#addaccount|addaccount name password]]''' into the server window. For example, to add user BennyLava you could type:
<div style="margin: 10px 10px 10px 10px;">
<syntaxhighlight lang="xml">
addaccount BennyLava 123password
</syntaxhighlight>
</div>
<div style="margin: 10px 10px 10px 20px;">
''Note: If you do not have access to the server window, and the 'admin' resource is running, you can add the example account by issuing the chatbox command '''/register BennyLava 123password'''''
</div>
<li>The server should display a message confirming the account has been added.
<li>Next, shutdown the server by typing '''shutdown''' into the server window.
<li>Make sure your server is stopped; if your server is still running, the following changes you make will be overwritten</li>
<li>Open the file 'mods/deathmatch/'acl.xml'''' with any text editor</li>
<li>Add the account to the ''Admin'' group by using the XML-syntax below
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<acl>
...
<group name="Admin">
<acl name="Admin"/>
...
<object name="user.BennyLava" />
</group>
...
</acl>
</syntaxhighlight>
</div>

You can actually add your user to any group you want. Each group is linked to an ACL ([[Access Control List]]). Each ACL contains a series of specific allowed or denied rights. These groups exist so different users can be assigned different rights. The ''Admin'' group points to the ''Admin'' ACL, which is empty (thus allowing all possible commands). The ''Everyone'' group points to the ''Default'' ACL that puts a series of restrictions on the available commands (to disallow regular players from using admin commands).
</li>
<li>
You're done! You can add as many administrators or users as you want this way, take a look at some of the other groups and ACLs for example. The ACL is also accessible through the [[Access_Control_List|Lua scripting engine]].<br>

It is recommended to take a look at the web interface, we will explain how to do this below.
</li>
</ol>
'''Note''': There are also ways to add accounts and edit rights for the server while it's running. "[[Server_Commands#addaccount|addaccount <user> <password>]]" is an internal command to add accounts, but you will have to use the web interface to add these accounts to specific groups/ACLs!<br />

===Using the web interface===
The dedicated server comes with a few Lua [[resources]] that provide a nice little web interface to your server. This can be used to easily maintain your server, as it allows you to add users, start/stop resources, and more.

The web interface resources are enabled by default and are served through the built-in HTTP web server. To make sure the built-in HTTP web server runs on a port you like (22005 by default), follow these steps:
<ol>
<li>Make sure your server is stopped
<li>Open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' with any text editor</li>
<li>Verify that the HTTP server is enabled:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpserver>1</httpserver>
</syntaxhighlight>
</div>
</li>
<li>Change the HTTP server port to your liking:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpport>22005</httpport>
</syntaxhighlight>
</div>
</li>
<li>Save and close the configuration file</li>
<li>Start your server</li>
<li>If you happened to have changed the start-up resources in your configuration file, make sure the following resources are started:

# resourcebrowser
# resourcemanager
# webadmin
# webmap

These are automatically started in the default configuration file, in case you just installed your server.
</li>
<li>Open a web browser (Internet Explorer 6 or 7 are NOT supported; use [http://www.mozilla.com/firefox Mozilla Firefox], [http://www.google.com/chrome Google Chrome], [http://www.apple.com/safari/download Apple Safari], [http://www.opera.com Opera] or others) and navigate to the HTTP server URL: '''http://server:port/'''. For example, If you are running a local server on HTTP port 22005, use '''http://127.0.0.1:22005/'''.</li>
<li>Enter the username and password of the administrator you added in the previous section.</li>
</ol>

<br />
You should now be able to maintain your server from the web interface.

=== Configuring an external web server ===
The built-in web server is also used to serve files that are required by resources running on your server to any player that is connected to your server. For example, if you are running a game script with a scripted graphical user interface, or custom models, these need to be transferred to every connected player in order to function properly. This is done by either the built-in web server, or an external web server (that is usually a bit faster) but needs to be set up separately.

For performance or consistency reasons during the game, you could choose to make use of such an external web server if you have one set up. The external web server needs to be accessible for the public, so any client will be able to download the necessary client-side files in order to join and play on your server.

To enable downloading off an external web server, you should configure the [[Server_mtaserver.conf#httpdownloadurl|httpdownloadurl]] tag in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpdownloadurl>http://www.myserver.tld/directory/here</httpdownloadurl>
</syntaxhighlight></div>

Since all the default resources provided with the dedicated server are zipped, and are normally automatically extracted by the built-in web server, you now have to provide a way for the clients to download the compressed files to their computers. To configure MTA to maintain a copy of only your unzipped client resources, set [[Server_mtaserver.conf#httpautoclientfiles|httpautoclientfiles]] in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml"><httpautoclientfiles>1</httpautoclientfiles>
</syntaxhighlight></div>

Now when you launch the server, the directory '''<SERVER>/mods/deathmatch/resource-cache/http-client-files''' will contain the correct client files for hosting on an external web server. If the web server is on the same machine, you can simply link the appropriate web server directory to '''http-client-files'''. If the web server is on a separate machine, ensure it has access to '''http-client-files''' via a network path, or maintain a remote copy using synchronization software.

'''Note 1''': Please try to avoid any special characters (e.g. ~, !) in your download URLs.<br />
'''Note 2''': Please do not use a trailing slash in your download URL (e.g. ''hxxp://www.myserver.tld/directory'' rather than ''hxxp://www.myserver.tld/directory/'')

==Starting your server==
Begin by making sure that you have finished all configuration of your server, starting your server is the last stage so everything must be ready!

To start your server double click on MTA Server.exe, make sure you allow it through any firewalls and forward ports where necessary.

==Installing/Updating resources on your server==
Resources can come in two formats, either a ZIP format or just a normal folder with the script files inside it. The MTA:SA server supports both these methods.

# Move or copy the new resource to your <SERVER>\mods\deathmatch\resources folder.
# In the server window type in the command [[Server_Commands#refresh|refresh]], this will re-scan the resources folder and update the live resources where necessary.

==Uninstalling resources==
Resources can easily be removed from your server if you no longer want them.

# Delete the ZIP file or the folder of the resource you wish to uninstall
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Administrating your server==
You can start resources by typing the command "start resourcename" in the server console, or stop ones with "stop resourcename".

It's also possible to execute these and other admin commands from the in-game console (which you can bring up with the ` key or F8); for this to work, you first need to log in with the command "[[Server_Commands#login|login username password]]". Additionally, you can press the p key to bring up the admin panel: this is a graphical interface which allows you to easily kick or ban misbehaving players, among others.

For further commands, type [[Server_Commands#help|help]] in a console.

==Starting a map/gamemode==
See the commands section of the documentation for [[Resource:Map manager|mapmanager]] for more information.

==Useful Notes==

# You may also update the resources while in-game as long as you have the correct access levels by typing "refresh" in the clients console or "/refresh" in the chat window. This may cause a second of lag if you have many resources.
# In the above instructions, <SERVER> is the path to your server's main directory. In most cases this is C:\Program Files\MTA San Andreas\server
# You can choose a different config file for the server to use by passing it in the command line after a --config argument, e.g. mtaserver.exe --config anotherconfig.cfg.
# Do not be alarmed by the warning regarding the parsing of the settings.xml file. This happens because your server installation is still clean and unused.

====Need further help?====
Why not pop over to our [http://forum.mtasa.com/ Forums] or join us on [irc://irc.multitheftauto.com/mta IRC] (irc.multitheftauto.com #mta - [http://www.mirc.com mIRC])

[[es:Manual Servidor]]
[[de:Server Anleitung]]
[[it:Manuale del Server]]
[[nl:Server Manual]]
[[ru:Server Manual]]
[[pl:Server Manual]]

[[Category:Support]]

ToJSON

2012-03-29T19:00:56Z

-ffs-Sniper: ToJSON was described wrong, it only grabs one argument, updated syntax, description and example

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards
}}
This function converts '''one''' variable (preferably a table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]].

==Syntax==

<syntaxhighlight lang="lua">
string toJSON( var value )
</syntaxhighlight>

===Required Arguments===
*'''var:''' An arguments of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.

===Returns===
Returns a JSON formatted string.

==Example==
This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
<syntaxhighlight lang="lua">
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

SetElementData

2012-03-29T18:49:06Z

-ffs-Sniper: /* Syntax */

{{Server client function}}
__NOTOC__
This function stores [[element data]] under a certain key, attached to an element. Element data set using this is then synced with all clients or the server. As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.

==Syntax==

<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you wish to attach the data to.
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.)
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server (client-side variation) and remote clients (both variations).

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

==Example==
<section name="Server" class="server" show="true">
This example allows for a player to add a custom tag onto their nickname, and also revert it back to normal if they wish
<syntaxhighlight lang="lua">
function addPlayerCustomTag ( thePlayer, command, newTag )
--Let's make sure the newTag param has been entered...
if ( newTag ) then
--Grab their current playername for saving.
local sPlayerNickname = getPlayerName ( thePlayer )
--Create their new nickname with their tag
local sNewPlayerNickname = newTag .. " " .. sPlayerNickname

--Let's first load the element data, see if it's there already
--The reason for this is that if a player were to do /addtag twice,
--the tag would be prepended a second time
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick == false ) then
--Save their orignal nickname in their element data
setElementData ( thePlayer, "tempdata.originalnick", sPlayerNickname )
end

--Set their new nickname globally
setPlayerName ( thePlayer, sNewPlayerNickname )

--Tell them it's done
outputChatBox ( "Your new nickname has been set, to put it back to its original state you can use /deltag", thePlayer )
else
--The newTag param was not entered, give an error message
outputChatBox ( "/addtag - Incorrect syntax, Correct: /addtag <newtag>", thePlayer )
end
end
addCommandHandler ( "addtag", addPlayerCustomTag )

function removePlayerCustomTag ( thePlayer, command )
--We first need to check that they have already used /addtag, let's do that now
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick ) then
--Great, they have a tag added, let's reset them

--First we will want to reset the element data back to its default (that being false)
setElementData ( thePlayer, "tempdata.originalnick", false )

--Now set the client name back
setClientName ( thePlayer, sOldNick )

--Notify them
outputChatBox ( "Your old nickname has been set", thePlayer )
end
end
addCommandHandler ( "deltag", removePlayerCustomTag )
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}

CopyResource

2012-03-29T02:50:02Z

-ffs-Sniper: /* Returns */

__NOTOC__
{{Server function}}
This function copies a specified [[resource]] with a new name.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder .

==Syntax==
<syntaxhighlight lang="lua">
resource copyResource ( resource theResource, string newResourceName [, string organizationalDir ] )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource which is going to be copied
*'''newResourceName:''' the name that the copied resource will receive

===Optional Arguments===
{{OptionalArg}}
* '''organizationalDir''': A string containing the path where the resource should be copied to (e.g. "[gamemodes]/[amx]").

===Returns===
Returns the [[resource]] element of the copy. Returns ''false'' if the arguments are incorrect.

==Example==
<syntaxhighlight lang="lua">
-- This script can backup your resource with a easy command! /backupresource [resourcename]
function backupResource (player,command,resourcetobackup) -- start the function
if (resourcetobackup) and (getResourceFromName(resourcetobackup)) then -- check if the resource is exist
copyResource (getResourceFromName(resourcetobackup),resourcetobackup .. "_backup") -- copy the resource and give it the name [resource]_backup
outputChatBox ("Resource " .. resourcetobackup .. " succesfully backed up!",player,255,0,0,false) -- say it's OK!
else -- if it isn't exist
outputChatBox ("Resource can't be backed up! (don't forget the parameters!)",player,255,0,0,false) -- say it isn't exist!
end
end
addCommandHandler ("backupresource",backupResouce) -- add command
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

Help:Editing Guidelines

2012-03-28T23:53:08Z

-ffs-Sniper: /* Script Examples */ Added: Preferably use four spaces instead of one tabulator.

> '''This page is work in progress (WIP)''' <

Before you contribute to the Multi Theft Auto Wiki make sure you know/understand the basics of [http://www.mediawiki.org/wiki/Help:Contents MediaWiki].

== Editing Pages ==
<div style="font-size: 85%;">''MediaWiki general help page: [http://www.mediawiki.org/wiki/Help:Editing_pages Editing Pages]''</div>
=== Minor Edits ===
From Wikipedia: "A check to the "minor edit" box signifies that only superficial differences exist between the version with your edit and the previous version: typo corrections, formatting and presentational changes, rearranging of text without modifying content, etc. A minor edit is a version that the editor believes requires no review and could never be the subject of a dispute. The "minor edit" option is one of several options available only to registered users."<ref>http://en.wikipedia.org/wiki/Help:Minor_edit</ref>

=== Editing Function/Event Pages ===
[[File:Layout function page.png|thumb|Layout Function Pages]]

Specific information for editing the MTA Wiki.

===== Contents of Function/Event Pages =====
Function and event pages have a layout that is easy to identify and consistent. Before adding function and/or event pages make sure they do exist in the MTA Core!

====== Layout Function Pages ======
* No Table of Contents: <nowiki>__NOTOC__</nowiki>
* Define if function is server and/or client: <nowiki>{{Server client function}}</nowiki>
** Server only function: <nowiki>{{Server function}}</nowiki>
** Client only function: <nowiki>{{Client function}}</nowiki>
** Both client and server: <nowiki>{{Server client function}}</nowiki>
* Explain the function
* Syntax: Use <nowiki><syntaxhighlight lang="lua"></syntaxhighlight></nowiki>
** Required Arguments
** Optional Arguments (not always necessary)
* Returns
* Example
* See Also: Add the template to which function group this function belongs

====== Layout Event Pages ======
* No Table of Contents: <nowiki>__NOTOC__</nowiki>
* Define if event is server or client: <nowiki>{{server event}}</nowiki>
** Server event: <nowiki>{{Server event}}</nowiki>
** Client event: <nowiki>{{Client event}}</nowiki>
* Parameters
* Source: The source of the event.
* Example
* See Also

Events can only be server or client side not both.

===== Tips =====
* When creating a new page for a function or event, you need to edit the template for 'See Also' too. If you don't add it to a function/event group template this page is considered orphaned and no one will find it unless they use the search function.
* When you don't want to add examples, add the <nowiki>{{Needs Example}}</nowiki> template at the top of the page.
* If you added examples to a page make sure to remove template <nowiki>{{Needs Example}}</nowiki> when necessary.

== Script Examples ==
When writing a script example always test and verify that your example is working, submitting not working examples is a waste of time for everyone.

* Preferably use four spaces instead of one tabulator.
* Use the syntaxhighlighting codebox provided on this wiki. (<nowiki><syntaxhighlight lang="lua">(CODE HERE)</syntaxhighlight></nowiki>)
* If the event/function is both client and server you should use the section template with server and/or client classes.
** For server side examples: <nowiki><section name="Example 1" </nowiki>'''class="server"'''<nowiki> show="true"></section></nowiki>
** For client side examples: <nowiki><section name="Example 2" </nowiki>'''class="client"'''<nowiki> show="false"></section></nowiki>

When an event/function is only client or server side you should only use the code box not the section tags.

If there are enough scripting examples, remove the template <nowiki>{{Needs Example}}</nowiki> or the <nowiki>[[Category:Needs Example]]</nowiki> when necessary.

== Templates ==
<div style="font-size: 85%;">''MediaWiki general help page: [http://www.mediawiki.org/wiki/Help:Templates Templates]''</div>
Templates are a consistent set of visual styling and can be used in articles to get the reader's attention or mark a page for example as outdated. Some templates also require arguments, for more information on how to use MTA's specific wiki templates go [[MTA Wiki:Specific Templates |here]].
{{Tip|If you want to avoid spacing between the page title and the template itself, you should include the template before __NOTOC__ other templates and/or [http://www.mediawiki.org/wiki/Help:Magic_words magic words].}}
Using templates is recommended when using the same content over a large number of pages. This will save you time when you want to change something in that content and doesn't require you to edit all the pages but just the template.

* [[MTA Wiki:Specific Templates |How to use MTA Wiki's Specific templates]]

== Protected Pages ==
Protected pages cannot be modified by normal users, if you want to change something on a protected page you will have to ask someone who as the right permissions to modify them.<ref>http://www.mediawiki.org/wiki/Help:Protected_pages</ref>

== Icons ==
When you want to use icons, it is recommended to use general icons this improves the consistency of the wiki.

* [[MTA Wiki:Tango Icon List |Tango Icon List]]

== Helpful links ==
* [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet] - Quick overview of general editing tags and functions.

== References ==
<references></references>

[[Category:MTA Wiki:Editing]]

Modules/MTA-MySQL

2012-03-28T23:45:49Z

-ffs-Sniper:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>

{{Module_Info|
name = MTA MySQL |
version = 0.5 |
author = [[User:ryden|Alberto Alonso (ryden)]] |
module_website = [http://code.google.com/p/multitheftauto-modules Here] |
download_link = [http://code.google.com/p/multitheftauto-modules/downloads/list Here] |
license = [http://www.opensource.org/licenses/bsd-license.php BSD] |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.x & 1.X |
}}
MTA MySQL is an alternative to the default [[Modules/MySQL|ml_mysql]] module provided by the MTA team.
It is available for Windows and GNU/Linux and provides the source code.

''Note: From version 0.4 it supports both DP2.3 and 1.0 servers.''

==Installation==
===Windows===
Uncompress the file mta_mysql.dll into your ''C:\Program files\MTA San Andreas\server\mods\deathmatch\modules\'' directory and the file libmysql.dll into your ''C:\Program files\MTA San Andreas\server\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.dll" />
</syntaxhighlight>

===GNU/Linux===
Uncompress the file mta_mysql.so in the ''mods/deathmatch/modules/'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.so" />
</syntaxhighlight>

To fix '''MODULE: Unable to find modules/mta_mysql.so (libmysqlclient.so.15: cannot open shared object file: No such file or directory)!''' you have to install libmysqlclient15.
You can get it here: http://automation.binarysage.net/?p=1311

'''If you experience an error on Unix systems:'''
Try to add port and socket parameters to your mysql_connect.

==Handler functions==
{{Modules/MTA-MySQL/Handler_functions}}

==Result managing functions==
{{Modules/MTA-MySQL/Result_functions}}

==Version 0.5 calling method==
From version 0.5 onwards you can call all this module functions, except mysql_connect and mysql_null, as if they are methods of an object.

For example, having a valid MySQL handler, you can do handler:query ( "SELECT * FROM table" ) instead of mysql_query ( handler, "SELECT * FROM table" ).

===Function aliases===
A function alias is a second name for a function, which makes calling any of the original name or the alias have the same result. The new aliases introduced in version 0.5 are:
* result:num_rows() is the same as result:numrows()
* result:num_fields() is the same as result:numfields()
* result:free_result() is the same as result:free()

[[Category:Modules]]

OnPedWasted

2012-03-28T23:39:08Z

-ffs-Sniper:

__NOTOC__
{{Server event}}
{{Needs Example}}
This event is triggered when a ped is killed or dies. It is not triggered for players.

==Parameters==
<syntaxhighlight lang="lua">int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[Weapons|killer weapon]] or the [[Death Reasons|death reason]].
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*'''stealth''': boolean value representing whether or not this was a stealth kill

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that died or got killed.

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

==See Also==
{{Ped_events}}

CreateVehicle

2012-03-28T23:34:50Z

-ffs-Sniper: /* Syntax */

{{Needs_Checking|Numberplates only seem to work for some vehicles, and then only for the front or rear plate only}}
__NOTOC__
{{Server client function}}
{{note_box|Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.}}
This function creates a vehicle at the specified location.

Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

==Syntax==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
</syntaxhighlight>

===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''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===
{{OptionalArg}}
* '''rx''': A floating point number representing the rotation about the X axis in degrees.
* '''ry''': A floating point number representing the rotation about the Y axis in degrees.
* '''rz''': A floating point number representing the rotation about the Z axis in degrees.
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.
* '''direction''': A boolean which should be set to false. *SERVER ONLY*
{{New feature/item|3.0120|1.2||
* '''variant1''': An integer for the first vehicle variant see [[Vehicle variants]]
* '''variant2''': An integer for the second vehicle variant see [[Vehicle variants]]
}}

===Returns===
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.

==Example==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="true">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

==See Also==

{{Vehicle functions}}

OnPedWasted

2012-03-28T23:33:57Z

-ffs-Sniper: Removed bullshit example

__NOTOC__
{{Server event}}
This event is triggered when a ped is killed or dies. It is not triggered for players.

==Parameters==
<syntaxhighlight lang="lua">int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[Weapons|killer weapon]] or the [[Death Reasons|death reason]].
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*'''stealth''': boolean value representing whether or not this was a stealth kill

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that died or got killed.

==See Also==
{{Ped_events}}

OnElementStopSync

2012-03-28T23:31:48Z

-ffs-Sniper: /* Example */

__NOTOC__
{{Server event}}
{{Warning|In 1.1.x, Destroying the source of this event could crash the server!|true}}

This event is triggered when an element is no longer synced by a player.

==Parameters==
<syntaxhighlight lang="lua">
player oldSyncer
</syntaxhighlight>

*'''oldSyncer''': [[player]] element representing the last player who was syncing the element

==Source==
The [[event system#Event source|source]] of this event is the [[element]] which is no longer synced by a player.

==Example==
This script creates a vehicle in the center of the map and outputs a message to its old syncer if he is not syncing the vehicle anymore.
<syntaxhighlight lang="lua">
--create our testing vehicle onResourceStart
addEventHandler ( "onResourceStart", getResourceRootElement( ),
function ( )
vehicle = createVehicle ( 520, 0, 0, 0 )
end )

function syncStop ( oldSyncer )
-- check if the element that stopped being synced was our vehicle
if source == vehicle then
--tell the player (oldSyncer) he stopped syncing the vehicle
outputChatBox ( "The vehicle is not being synced by you anymore", oldSyncer )
end
end
--add the event handler
addEventHandler( "onElementStopSync", getRootElement(), syncStop )
</syntaxhighlight>

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

CopyResource

2012-03-28T23:25:06Z

-ffs-Sniper: Syntax update

__NOTOC__
{{Server function}}
This function copies a specified [[resource]] with a new name.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder .

==Syntax==
<syntaxhighlight lang="lua">
resource copyResource ( resource theResource, string newResourceName [, string organizationalDir ] )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource which is going to be copied
*'''newResourceName:''' the name that the copied resource will receive

===Optional Arguments===
{{OptionalArg}}
* '''organizationalDir''': A string containing the path where the resource should be copied to (e.g. "[gamemodes]/[amx]").

===Returns===
Returns the [[resource]] element that was copied. Returns ''false'' if the arguments are incorrect

==Example==
<syntaxhighlight lang="lua">
-- This script can backup your resource with a easy command! /backupresource [resourcename]
function backupResource (player,command,resourcetobackup) -- start the function
if (resourcetobackup) and (getResourceFromName(resourcetobackup)) then -- check if the resource is exist
copyResource (getResourceFromName(resourcetobackup),resourcetobackup .. "_backup") -- copy the resource and give it the name [resource]_backup
outputChatBox ("Resource " .. resourcetobackup .. " succesfully backed up!",player,255,0,0,false) -- say it's OK!
else -- if it isn't exist
outputChatBox ("Resource can't be backed up! (don't forget the parameters!)",player,255,0,0,false) -- say it isn't exist!
end
end
addCommandHandler ("backupresource",backupResouce) -- add command
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

OnElementStopSync

2012-03-28T23:21:32Z

-ffs-Sniper: /* Example */ Spaces ftw

__NOTOC__
{{Server event}}
{{Warning|In 1.1.x, Destroying the source of this event could crash the server!|true}}

This event is triggered when an element is no longer synced by a player.

==Parameters==
<syntaxhighlight lang="lua">
player oldSyncer
</syntaxhighlight>

*'''oldSyncer''': [[player]] element representing the last player who was syncing the element

==Source==
The [[event system#Event source|source]] of this event is the [[element]] which is no longer synced by a player.

==Example==
This script creates a vehicle in the center of the map and outputs a message to its old syncer if he is not syncing the vehicle anymore.
<section name="Example" class="server" show="true">
<syntaxhighlight lang="lua">
--create our testing vehicle onResourceStart
addEventHandler ( "onResourceStart", getResourceRootElement( ),
function ( )
vehicle = createVehicle ( 520, 0, 0, 0 )
end )

function syncStop ( oldSyncer )
-- check if the element that stopped being synced was our vehicle
if source == vehicle then
--tell the player (oldSyncer) he stopped syncing the vehicle
outputChatBox ( "The vehicle is not being synced by you anymore", oldSyncer )
end
end
--add the event handler
addEventHandler( "onElementStopSync", getRootElement(), syncStop )
</syntaxhighlight>
</section>

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

OnElementStopSync

2012-03-28T23:06:52Z

-ffs-Sniper: Fixed FabioGNR's changes and fixed example

__NOTOC__
{{Server event}}
{{Warning|In 1.1.x, Destroying the source of this event could crash the server!|true}}

This event is triggered when an element is no longer synced by a player.

==Parameters==
<syntaxhighlight lang="lua">
player oldSyncer
</syntaxhighlight>

*'''oldSyncer''': [[player]] element representing the last player who was syncing the element

==Source==
The [[event system#Event source|source]] of this event is the [[element]] which is no longer synced by a player.

==Example==
This script creates a vehicle in the center of the map and outputs a message to its old syncer if he is not syncing the vehicle anymore.
<section name="Example" class="server" show="true">
<syntaxhighlight lang="lua">
--create our testing vehicle onResourceStart
addEventHandler ( "onResourceStart", getResourceRootElement( ),
function ( )
vehicle = createVehicle ( 520, 0, 0, 0 )
end )

function syncStop ( oldSyncer )
-- check if the element that stopped being synced was our vehicle
if source == vehicle then
--tell the player (oldSyncer) he stopped syncing the vehicle
outputChatBox ( "The vehicle is not being synced by you anymore", oldSyncer )
end
end
--add the event handler
addEventHandler( "onElementStopSync", getRootElement(), syncStop )
</syntaxhighlight>
</section>

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

DeleteResource

2012-03-28T22:54:01Z

-ffs-Sniper:

{{New feature/item|3.0120|1.2|3316|
__NOTOC__
{{Server function}}
This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.

==Syntax==
<syntaxhighlight lang="lua">
bool deleteResource ( string resourceName )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of resource to delete.

===Returns===
Returns ''true'' if the resource has been deleted successfully, ''false'' otherwise.

==Example==
This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
<syntaxhighlight lang="lua">
addCommandHandler ( "removeresource",
function ( playerSource, commandName, name )
--Check if it is an admin using this command
if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then
outputChatBox ( "You are not allowed to use this command", playerSource )
return
end
--Did the user pass a valid resource name?
if not name or name == "" or name == " " then
outputChatBox ( "An invalid resource name has been passed (/removeresource <name>)", playerSource )
return
end
--Let us check if the resource name exists
--Get all resources
local resourceTable = getResources ( )
for resourceKey, resourceValue in ipairs ( resourceTable ) do
local resourceName = getResourceName ( resourceValue )
--Does the resource exist?
if name == resourceName then
--Stop the resource (maybe it is running)
stopResource ( resourceValue )
--Delete it
local deleted = deleteResource ( name )
if deleted then
outputChatBox ( "Resource " .. name .. " has been successfully removed", playerSource )
else
outputChatBox ( "There is an unknown problem with the resource", playerSource )
end
--The function is finished and was successful, return to stop it
return
end
end
--If a resource with the specified name does not exist show an error message
outputChatBox ( "The specified resource does not exist", playerSource )
end )
</syntaxhighlight>
}}

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

CopyResource

2012-03-28T22:38:38Z

-ffs-Sniper: Added optional argument, fixed returns and added note about revision

__NOTOC__
{{Server function}}
This function copies a specified [[resource]] with a new name.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder .

==Syntax==
<syntaxhighlight lang="lua">
bool copyResource ( resource theResource, string newResourceName[, string organizationalDir] )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource which is going to be copied
*'''newResourceName:''' the name that the copied resource will receive

===Optional Arguments===
{{OptionalArg}}
* '''organizationalDir''': A string containing the path where the resource should be copied to (e.g. "[gamemodes]/[amx]").

===Returns===
Returns the [[resource]] element that was copied. Returns ''false'' if the arguments are incorrect

==Example==
<syntaxhighlight lang="lua">
-- This script can backup your resource with a easy command! /backupresource [resourcename]
function backupResource (player,command,resourcetobackup) -- start the function
if (resourcetobackup) and (getResourceFromName(resourcetobackup)) then -- check if the resource is exist
copyResource (getResourceFromName(resourcetobackup),resourcetobackup .. "_backup") -- copy the resource and give it the name [resource]_backup
outputChatBox ("Resource " .. resourcetobackup .. " succesfully backed up!",player,255,0,0,false) -- say it's OK!
else -- if it isn't exist
outputChatBox ("Resource can't be backed up! (don't forget the parameters!)",player,255,0,0,false) -- say it isn't exist!
end
end
addCommandHandler ("backupresource",backupResouce) -- add command
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

User:-ffs-Sniper

2012-03-17T10:40:07Z

-ffs-Sniper:

Welcome, this is -ffs-Sniper, co leader of the |FFS|Gaming community, No 1 in DD/DM racing.
Most people know me as SHC//Sniper, the former founder and leader of the SHC clan.

Source patches:
-http://code.google.com/p/mtasa-blue/source/detail?r=3909

Wiki updates:
-[[GetRainLevel]]
-[[SetRainLevel]]
-[[ResetRainLevel]]
-[[DeleteResource]]
-and a lot more

DeleteResource

2012-03-17T10:36:23Z

-ffs-Sniper: Small update for the example

{{New feature/item|3.0120|1.2|3316|
__NOTOC__
{{Server function}}
This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.

==Syntax==
<syntaxhighlight lang="lua">
bool deleteResource ( string resourceName )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of resource to delete.

===Returns===
Returns ''true'' if the resource has been deleted successfully, ''false'' otherwise.

==Example==
This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
<syntaxhighlight lang="lua">
addCommandHandler ( "removeresource",
function( playerSource, commandName, name )
--Check if it is an admin using this command
if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then
outputChatBox ( "You are not allowed to use this command", playerSource )
return
end
--Did the user pass a valid resource name?
if not name or name == "" or name == " " then
outputChatBox ( "An invalid resource name has been passed (/removeresource <name>)", playerSource )
return
end
--Let us check if the resource name exists
--Get all resources
local resourceTable = getResources ( )
for resourceKey, resourceValue in ipairs ( resourceTable ) do
local resourceName = getResourceName ( resourceValue )
--Does the resource exist?
if name == resourceName then
--Stop the resource (maybe it is running)
stopResource ( resourceValue )
--Delete it
local deleted = deleteResource ( name )
if deleted then
outputChatBox ( "Resource " .. name .. " has been successfully removed", playerSource )
else
outputChatBox ( "There is an unknown problem with the resource", playerSource )
end
--The function is finished and was successful, return to stop it
return
end
end
--If a resource with the specified name does not exist show an error message
outputChatBox ( "The specified resource does not exist", playerSource )
end )
</syntaxhighlight>
}}

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

DeleteResource

2012-03-17T10:25:28Z

-ffs-Sniper: Completely wrong example replaced by a useful and working example

{{New feature/item|3.0120|1.2|3316|
__NOTOC__
{{Server function}}
This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.

'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.

==Syntax==
<syntaxhighlight lang="lua">
bool deleteResource ( string resourceName )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of resource to delete.

===Returns===
Returns ''true'' if the resource has been deleted successfully, ''false'' otherwise.

==Example==
This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
<syntaxhighlight lang="lua">
addCommandHandler("removeresource",
function(player, cmd, name)
--Check if it is an admin using this command
if not (isObjectInACLGroup("user."..getAccountName(getPlayerAccount(player)),aclGetGroup("Admin"))) then
outputChatBox("You are not allowed to use this command", player)
return
end
--Did the user pass a valid resource name?
if not (name) or (name == "") and (name == " ") then
outputChatBox("An invalid resource name has been passed (/removeresource <name>)", player)
return
end
--Let us check if the resource name exists
--Get all resources
local resourceTable = getResources()
for resourceKey, resourceValue in ipairs(resourceTable) do
local resourceName = getResourceName(resourceValue)
--Does the resource exist?
if (name == resourceName) then
--Stop the resource (maybe it is running)
stopResource(resourceValue)
--Delete it
local deleted = deleteResource(name)
if (deleted) then
outputChatBox("Resource "..name.." has been successfully removed", player)
else
outputChatBox("There is an unknown problem with the resource", player)
end
--The function is finished and was successful, return to stop it
return
end
end
--If a resource with the specified name does not exist show an error message
outputChatBox("The specified resource does not exist", player)
end)
</syntaxhighlight>
}}

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}

DeleteResource

2012-03-15T21:59:19Z

-ffs-Sniper: Wrong revision number, updated

DeleteResource

2012-03-15T21:18:48Z

-ffs-Sniper:

FromJSON

2012-03-15T20:39:58Z

-ffs-Sniper:

__NOTOC__
{{Server client function}}
{{Needs_Checking|Example 1 does not work. FromJSON is not compatible with JSON objects such as "cat:5, mouse:1". You might only use JSON arrays instead or move the JSON formatting to PHP --[[User:-ffs-Sniper|-ffs-Sniper]] 20:39, 15 March 2012 (UTC)}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards
}}
This function parses a [[JSON]] formatted string into variables. You can use [[toJSON]] to encode variables into a JSON string that can be read by this function.

==Syntax==
<syntaxhighlight lang="lua">
var fromJSON ( string json )
</syntaxhighlight>

===Required Arguments===
*'''json:''' A JSON formatted string

===Returns===
Returns variables read from the JSON string.

==Example==
This should make data equal: {1="cat", 2="mouse", 3=5, 4=null, 5={cat=5, mouse=1}} (untested)
<syntaxhighlight lang="lua">
local data = fromJSON("[\"cat\", \"mouse\", 5, null, {cat:5, mouse:1}]")
</syntaxhighlight>

==Example 2==
<syntaxhighlight lang="lua">
local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

User:-ffs-Sniper

2012-03-15T20:27:32Z

-ffs-Sniper: Created page with "Welcome, this is -ffs-Sniper, co leader of the |FFS|Gaming community, No 1 in DD/DM racing. Most people know me as SHC//Sniper, the former founder and leader of the SHC clan. So..."

Welcome, this is -ffs-Sniper, co leader of the |FFS|Gaming community, No 1 in DD/DM racing.
Most people know me as SHC//Sniper, the former founder and leader of the SHC clan.

Source patches:
-http://code.google.com/p/mtasa-blue/source/detail?r=3909

Wiki updates:
-[[GetRainLevel]]
-[[SetRainLevel]]
-[[ResetRainLevel]]
-and a lot more