Multi Theft Auto: Wiki - User contributions [en]

SetVehicleOverrideLights

2017-06-04T19:19:25Z

Jaysds1: OOP

__NOTOC__
{{Server client function}}
This function changes the light overriding setting on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleOverrideLights ( vehicle theVehicle, int value )</syntaxhighlight>
{{OOP||[[vehicle]]:setOverrideLights|overrideLights|getVehicleOverrideLights}}
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the override lights setting of.
*'''value''': A whole number representing the state of the lights:
** '''0''': No override, lights are set to default.
** '''1''': Lights are forced off.
** '''2''': Lights are forced on.

==Returns==
Returns ''true'' if the vehicle's lights setting was changed. Otherwise ''false''.

==Example==
<section name="Example 1" class="server" show="true">
This example will toggle the car lights on and off for a player's vehicle by using a "vehiclelights" command.
<syntaxhighlight lang="lua">
function consoleVehicleLights ( source )
if isPedInVehicle(source) then -- checks is the player in vehicle if yes, then:
playerVehicle = getPedOccupiedVehicle ( source ) -- get the player's vehicle
if ( playerVehicle ) then -- if he was in one
if ( getVehicleOverrideLights ( playerVehicle ) ~= 2 ) then -- if the current state isn't 'force on'
setVehicleOverrideLights ( playerVehicle, 2 ) -- force the lights on
else
setVehicleOverrideLights ( playerVehicle, 1 ) -- otherwise, force the lights off
end
end
end
end
addCommandHandler ( "vehiclelights", consoleVehicleLights )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example will toggle the car lights on and off for a player's vehicle by using a "vehiclelights" command.
<syntaxhighlight lang="lua">
function consoleVehicleLights ()
if isPedInVehicle(getLocalPlayer()) then -- checks is the player in vehicle if yes, then:
playerVehicle = getPedOccupiedVehicle ( getLocalPlayer() ) -- get the local player's vehicle
if ( playerVehicle ) then -- if he was in one
if ( getVehicleOverrideLights ( playerVehicle ) ~= 2 ) then -- if the current state isn't 'force on'
setVehicleOverrideLights ( playerVehicle, 2 ) -- force the lights on
else
setVehicleOverrideLights ( playerVehicle, 1 ) -- otherwise, force the lights off
end
end
end
end
addCommandHandler ( "vehiclelights", consoleVehicleLights )
</syntaxhighlight>
</section>

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

SetVehicleEngineState

2017-06-04T19:00:26Z

Jaysds1: OOP

__NOTOC__
{{Server client function}}
This function turns a vehicle's engine on or off. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
</syntaxhighlight>
{{OOP||[[vehicle]]:setEngineState|engineState|getVehicleEngineState}}
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.
*'''engineState''': A boolean value representing whether the engine will be turned on (''true'') or off (''false'').

===Returns===
Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.

==Example==
<section name="Serverside example" class="server" show="true">
This example will turn off a vehicle's engine when the driver gets out of the car.
<syntaxhighlight lang="lua">
function turnEngineOff ( theVehicle, leftSeat, jackerPlayer )
-- if it's the driver who got out, and he was not jacked,
if leftSeat == 0 and not jackerPlayer then
-- turn off the engine
setVehicleEngineState ( theVehicle, false )
end
end
-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
addEventHandler ( "onPlayerVehicleExit", getRootElement ( ), turnEngineOff )
</syntaxhighlight>
</section>

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

Authorized Serial Account Protection

2017-01-03T00:48:53Z

Jaysds1: This should be better for users looking for the doc first, faqs are always at the bottom.

=Main documentation=
==Introduction==
New from 1.5.3, Authorized Serial Account Protection provides a way to prevent password reuse causing damage to your server.
==How to enable==
Open '''mtaserver.conf''' and find ''<auth_serial_groups>'' and change to below.
(If ''<auth_serial_groups>'' does not exist, then add it)
<auth_serial_groups>Admin</auth_serial_groups>
If you wish to protect other ACL groups, then add them separated by commas, e.g.:
<auth_serial_groups>Admin,SuperModerator</auth_serial_groups>
==How to disable==
Open '''mtaserver.conf''' and find ''<auth_serial_groups>'' and change to below
<auth_serial_groups></auth_serial_enabled>
'''Note''': Authorized Serial Account Protection helps prevent your server from getting hacked. If there is a chance any of your admins are using the same password on other servers, then do not disable this feature.
==How to use==
To allow the last attempted serial for an account, enter the following command in the server console:
authserial <account_name>
To view authorized serials for an account:
authserial <account_name> list
To remove the newest authorized serial for an account:
authserial <account_name> remove
 
=FAQ=
==Help, I can't login (game)==
To allow the last attempted serial, use the '''authserial''' command in the server console. 
For example, to allow the last attempted serial for account ''MrBob'', enter the following command in the server console:
authserial MrBob
==Help, I can't login (http)==
To login to the HTTP web interface, the IP has to be authorized.
To authorized an IP:
* Join the MTA server
* Login to the account
* Disconnect from MTA server (optional)
* Login via HTTP

GuiComboBoxClear

2016-06-25T16:13:15Z

Jaysds1: /* Example */

{{Client function}}
__NOTOC__
This function removes all the items from a combobox.

==Syntax==
<syntaxhighlight lang="lua">
bool guiComboBoxClear ( element comboBox )
</syntaxhighlight>

===Required Arguments===
*'''comboBox:''' The combobox element to be cleared

===Returns===
Returns ''true'' if the combobox element is valid and has been cleared successfully, ''false'' otherwise.

==Example==
This example creates a combo box with all server vehicles on it, with a command to clear the combo box.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientResourceStart", resourceRoot,
function ( )
vehiclesComboBox = guiCreateComboBox ( 400, 100, 200, 5 * #getElementsByType ( "vehicle" ), "", false ) -- We create a combo box.
for index, vehicle in ipairs ( getElementsByType ( "vehicle" ) ) do -- We loop through all vehicles.
guiComboBoxAddItem ( vehiclesComboBox, getVehicleName ( vehicle ) ) -- We add the vehicle name to our combo box.
end
end
)

addCommandHandler ( "clear",
function ( )
guiComboBoxClear ( vehiclesComboBox ) -- We clear our combo box removing all vehicles.
end
)
</syntaxhighlight>

==See Also==
{{GUI functions}}

User:Jaysds1

2016-02-01T04:34:53Z

Jaysds1:

Hey you,

Want to know something about me?
I do my own side projects just to make a living... I know what you're thinking, how right?

Just check them out and you'll see...

[http://jquonprojects.tk JQuonProjects]

[http://jquonsignatures.tk JQuon Signatures]

[https://wordsexperiments.tk Words Experiments]

[https://yours-todo.tk Yours ToDo]

[http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=56218 MTA Forums]

User:Jaysds1

2015-01-03T03:21:26Z

Jaysds1:

Hey, I work for J World 137 and I'm planning major things for MTA.

If you have any problems or questions with MTA and/or scripting, contact me at:

[http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=56218 MTA Forums]

Modules

2014-04-07T05:21:26Z

Jaysds1: /* Modules SDK */

Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as sockets. All modules listed here are not distributed with Multi Theft Auto, and must be manually installed.

==Modules list==
You can view a list of all the documented modules in this wiki [[:Category:Modules|here]].

==Modules SDK==
To be able to create your own modules, you must use the Modules SDK. You can download it from one of the links below - choose a link in accordance with your server's operating system.

* Linux
** [http://files.mtasa.com/apps/1.0/dm/ml_devkit.tar.gz Official]
*** (Delete the .d files, and add #include <cstring> to Common.h)
**** (On 64bit add -m32 to CPPFLAGS and LDFLAGS lines in Makefile)
* Microsoft Windows
** [http://www.mediafire.com/?b8b3asgegn0xkm4 Mirror (Mediafire)]
** [https://mega.co.nz/#!nBNGUCgQ!3AHEJt684Heu9bN5de8xwAQ3h-qq5-V6fjUeU7rj5hI Mirror (MEGA)]

===SDK Functions===
*Currently in there:
**Base:
***HelloWorld
**MySQL
***MySQLCreate
***MySQLOpen
***MySQLDestroy
***MySQLQuery
***MySQLSafeString

[[Category:Scripting Concepts]]
[[Category:Incomplete]]
[[Category:Modules]]

[[pt-br:Módulos]]
[[ru:Modules]]

Modules

2014-03-30T14:59:17Z

Jaysds1: /* Modules SDK */ Removed my link

Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as sockets. All modules listed here are not distributed with Multi Theft Auto, and must be manually installed.

==Modules list==
You can view a list of all the documented modules in this wiki [[:Category:Modules|here]].

==Modules SDK==
To be able to create your own modules, you must use the Modules SDK. You can download it from one of the links below - choose a link in accordance with your server's operating system.

* Linux
** [http://files.mtasa.com/apps/1.0/dm/ml_devkit.tar.gz Official]
*** (Delete the .d files, and add #include <cstring> to Common.h)
**** (On 64bit add -m32 to CPPFLAGS and LDFLAGS lines in Makefile)
* Microsoft Windows
** [http://www.mediafire.com/?b8b3asgegn0xkm4 Mirror (Mediafire)]

===SDK Functions===
*Currently in there:
**Base:
***HelloWorld
**MySQL
***MySQLCreate
***MySQLOpen
***MySQLDestroy
***MySQLQuery
***MySQLSafeString

[[Category:Scripting Concepts]]
[[Category:Incomplete]]
[[Category:Modules]]

[[pt-br:Módulos]]
[[ru:Modules]]

DxDrawText

2014-01-25T15:15:23Z

Jaysds1: /* Example */ This function is client-sided already, no need for the section.

__NOTOC__
{{Client function}}

Draws a string of text on the screen for one frame. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawText ( string text, float left, float top [, float right=left, float bottom=top, int color=white,
float scale=1, mixed font="default", string alignX="left", string alignY="top",
bool clip=false, bool wordBreak=false, bool postGUI=false,
bool colorCoded=false, bool subPixelPositioning=false ] )
</syntaxhighlight>

===Required Arguments===
*'''text:''' the text to draw
*'''left:''' the absolute X coordinate of the top left corner of the text
*'''top:''' the absolute Y coordinate of the top left corner of the text

===Optional Arguments===
*'''right:''' the absolute X coordinate of the right side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''bottom:''' the absolute Y coordinate of the bottom side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''color:''' the color of the text, a value produced by [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''scale:''' the size of the text.{{New feature|3.0110|1.1|'''scale:''' can (optionally) be specified as two floats. i.e. '''scaleX, scaleY'''}}
*'''font:''' Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
*'''alignX:''' horizontal alignment of the text within the bounding box. Can be '''"left"''', '''"center"''' or '''"right"'''.
*'''alignY:''' vertical alignment of the text within the bounding box. Can be '''"top"''', '''"center"''' or '''"bottom"'''.
*'''clip:''' if set to ''true'', the parts of the text that don't fit within the bounding box will be cut off.
*'''wordBreak:''' if set to ''true'', the text will wrap to a new line whenever it reaches the right side of the bounding box. If ''false'', the text will always be completely on one line.
* '''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
{{New_feature|3.0131|1.3.1|
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes. '''Note: clip and wordBreak are forced false if this is set.'''
*'''subPixelPositioning:''' A bool representing whether the text can be positioned sub-pixel-ly. Looks nicer for moving/scaling animations.
}}

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

==Example==
This example code will add the current zone name in the lower left corner of the players' screens.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize ( ) -- Get the screen resolution (width and height)

function createText ( )
local playerX, playerY, playerZ = getElementPosition ( localPlayer ) -- Get our player's coordinates.
local playerZoneName = getZoneName ( playerX, playerY, playerZ ) -- Get name of the zone the player is in.

-- Draw zone name text's shadow.
dxDrawText ( playerZoneName, 44, screenHeight - 41, screenWidth, screenHeight, tocolor ( 0, 0, 0, 255 ), 1.02, "pricedown" )
-- Draw zone name text.
dxDrawText ( playerZoneName, 44, screenHeight - 43, screenWidth, screenHeight, tocolor ( 255, 255, 255, 255 ), 1, "pricedown" )
end

function HandleTheRendering ( )
addEventHandler ( "onClientRender", root, createText ) -- keep the text visible with onClientRender.
end

addEventHandler ( "onClientResourceStart", resourceRoot, HandleTheRendering )
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03986|Added colorCoded and subPixelPositioning arguments}}

==See Also==
{{Drawing_functions}}

DxDrawImage

2014-01-23T18:05:44Z

Jaysds1: /* Example */ This function is client-sided already, no need for the section.

__NOTOC__
{{Client function}}

Draws an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]). 
Image files should ideally have dimensions that are a power of two, to prevent possible blurring. 
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...
{{Note|To help prevent edge artifacts when drawing textures, set '''textureEdge''' to '''"clamp"''' when calling [[dxCreateTexture]]}}
==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImage ( float posX, float posY, float width, float height, mixed image [, float rotation = 0, float rotationCenterOffsetX = 0,
float rotationCenterOffsetY = 0, int color = tocolor(255,255,255), bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image
*'''height:''' the absolute height of the image
*'''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' Tints the image with a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Example==
Example of a pendulum swinging from the top of the screen, made using dxDrawImage.
<syntaxhighlight lang="lua">
local screenWidth,screenHeight = guiGetScreenSize() -- Get screen resolution.

function renderDisplay ( )
local seconds = getTickCount() / 1000
local angle = math.sin(seconds) * 80
-- This will draw the graphic file 'arrow.png' at the top middle of the screen
-- using the size of 100 pixels wide, and 240 pixels high.
-- The center of rotation is at the top of the image.
dxDrawImage ( screenWidth/2 - 50, 0, 100, 240, 'arrow.png', angle, 0, -120 )
end

function HandleTheRendering ( )
addEventHandler("onClientRender", getRootElement(), renderDisplay) -- Keep everything visible with onClientRender.
end
addEventHandler("onClientResourceStart",resourceRoot, HandleTheRendering)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

TriggerLatentClientEvent

2014-01-12T19:33:39Z

Jaysds1:

__NOTOC__
{{Server function}}
This function is the same as [[triggerClientEvent ]] except the transmission rate of the data contained in the arguments can be limited
and other network traffic is not blocked while the data is being transferred.
{{Note|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the [[element_tree | element tree]], which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerLatentClientEvent ( [table/element sendTo=getRootElement(),] string name, [int bandwidth=50000,] [bool persist=false,] element theElement, [arguments...] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''theElement:''' The element that is the [[Event system#Event handlers|source]] of the event. This could be another player, or if this isn't relevant, use the root element.

===Optional Arguments===
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''bandwidth:''' The bytes per second rate to send the data contained in the arguments.
*'''persist:''' A bool indicating whether the transmission should be allowed to continue even after the resource that triggered it has since stopped.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s. The total amount of data should not exceed 100MB.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

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

==Requirements==
{{Requirements|1.3.0-9.03772|n/a|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions}}

Talk:Id

2014-01-12T19:17:42Z

Jaysds1: /* Shouldn't this be moved to "ID"? */

==Shouldn't this be moved to "ID"?==
Shouldn't this be moved to [[ID]]? Everywhere else we refer to these things as "IDs", so shouldn't the singular form just be "ID"? --[[User:Qais|qaisjp]] 14:14, 12 January 2014 (UTC)

Well, it's already redirected from [[ID]]... --Jaysds1 19:17, 12 January 2014 (UTC)

Talk:Id

2014-01-12T19:17:26Z

Jaysds1: /* Shouldn't this be moved to "ID"? */

==Shouldn't this be moved to "ID"?==
Shouldn't this be moved to [[ID]]? Everywhere else we refer to these things as "IDs", so shouldn't the singular form just be "ID"? --[[User:Qais|qaisjp]] 14:14, 12 January 2014 (UTC)
Well, it's already redirected from [[ID]]... --Jaysds1 19:17, 12 January 2014 (UTC)

SetAnalogControlState

2014-01-07T18:02:28Z

Jaysds1: /* Example */ This function is client-sided already, no need for the section.

__NOTOC__
{{Client function}}
This sets the analog control state of a control for the local player.

To change the analog controls for a ped, please use [[setPedAnalogControlState]].

==Syntax==
<syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName [, float state] ) </syntaxhighlight>
===Required Arguement===
* '''controlName''': the control name you wish to set the analog state of. Here's a list:
**'''left'''
**'''right'''
**'''forwards'''
**'''backwards'''
**'''vehicle_left'''
**'''vehicle_right'''
**'''steer_forward'''
**'''steer_back'''
**'''accelerate'''
**'''brake_reverse'''
**'''special_control_left'''
**'''special_control_right'''
**'''special_control_up'''
**'''special_control_down'''

===Optional Arguments===
*'''state:''' A float between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.

===Returns===
Returns true, else false if invalid argument.

==Example==
/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
<syntaxhighlight lang="lua">
function analog()
if (getAnalogControlState("forwards") == 0) then
setAnalogControlState ("forwards",1)
else
setAnalogControlState ("forwards",0)
end
end
addCommandHandler("analog",analog)
</syntaxhighlight>
This example written by '''Samurai'''

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

SetWeaponClipAmmo

2013-11-17T05:47:18Z

Jaysds1:

__NOTOC__
{{Client function}}
Set the ammo in a custom weapons magazine/clip.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponClipAmmo ( weapon theWeapon, int clipAmmo )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the clip ammo of.
* '''clipAmmo:''' The amount of ammo in the clip.
===Example===
<syntaxhighlight lang="lua">
function createWepCmd()
local wep = createWeapon("m4", 0, 0, 0)
setWeaponClipAmmo(wep, 50)
end
addCommandHandler("weapon", createWepCmd)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}
==See Also==
{{Weapon functions}}

GetWeaponFiringRate

2013-11-17T05:46:27Z

Jaysds1:

__NOTOC__
{{Client function}}
Gets the firing rate to be used when you set the custom weapon to the firing state.

==Syntax==
<syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to modify the firing rate of.

===Returns===
Returns an ''integer'' with the firing rate of the custom weapon, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local wep = createWeapon("minigun", 0, 0, 0)

function getWepRate()
if (not wep) then return end
local rate = getWeaponFiringRate(wep)
outputChatBox("Fire rate: "..rate)
end
addCommandHandler("firerate", getWepRate)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

Client Scripting Events

2013-10-07T03:52:28Z

Jaysds1:

<pageclass class="client"></pageclass>
This page lists all '''client-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]].

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

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==GUI events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[pl:Zdarzenia_po_stronie_klienta]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]

GuiCreateComboBox

2013-10-07T02:47:13Z

Jaysds1: /* Example */ No point of the section as it's already a client function.

__NOTOC__
{{Client function}}
This function creates a combobox GUI element, which you can compare to a gridlist with a dropdown feature.
* '''NOTE:''' The height of a combobox must be enough to fit the drop down menu, else the drop down won't appear. See [[guiComboBoxAdjustHeight]] to give your combobox the correct height.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateComboBox ( float x, float y, float width, float height, string caption, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
[[Image:Gui-combobox.jpg|frame|Example GUI ComboBox.]]
*'''x:''' A float of the 2D x position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI combobox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI combobox. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''caption:''' A string for what the title of your combobox will be. This will be shown if no item is selected.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the GUI combobox is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created combobox if it was successfully created, false otherwise.

==Example==
This example creates a combo box in the center of the screen with all server vehicles on it.
<syntaxhighlight lang="lua">addEventHandler ("onClientResourceStart",resourceRoot,function()
local screenWidth, screenHeight = guiGetScreenSize()
local windowWidth, windowHeight = 200,100
local left = screenWidth/2 - windowWidth/2
local top = screenHeight/2 - windowHeight/2
local vehiclesComboBox = guiCreateComboBox ( left, top, windowWidth,windowHeight, "Vehicle Names", false ) -- We create a combo box.
for index, vehicle in ipairs ( getElementsByType ( "vehicle" ) ) do -- We loop through all vehicles.
guiComboBoxAddItem ( vehiclesComboBox, getVehicleName ( vehicle ) ) -- We add the vehicle name to our combo box.
end
end)
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiSetProperty

2013-09-28T14:51:54Z

Jaysds1: Page isn't available for some reason

{{Client function}}
__NOTOC__
This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the  [http://web.archive.org/web/20120706081430/http://cegui.org.uk/static/WindowsLookProperties.html CEGUI Properties Wiki Page (Wayback Machine)].

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetProperty ( element guiElement, string property, string value )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' the GUI element you wish to get a property of.
*'''property:''' the name of of property you want the value of.
*'''value:''' the new value for the property.

===Returns===
If the function succeeds it returns ''true'', if it fails it returns ''false''.

==Example==
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
<syntaxhighlight lang="lua">

function onStart()
button = guiCreateButton( 20, 200, 150, 30, "Test", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), onStart )

function toogleButton()
local currentState = guiGetProperty( button, "Disabled" )
if currentState == "False" then
guiSetProperty( button, "Disabled", "True" )
else
guiSetProperty( button, "Disabled", "False" )
end
end
addCommandHandler( "togglebtn", toogleButton )
</syntaxhighlight>

==See Also==
{{GUI functions}}

DxDrawImageSection

2013-09-28T14:10:41Z

Jaysds1: /* Example */ No point of the section as it's already a client function.

__NOTOC__
{{Client function}}
Differing from [[dxDrawImage]], this function only draws a part of an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImageSection ( float posX, float posY, float width, float height, float u, float v, float usize, float vsize, mixed image,
[ float rotation = 0, float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, int color = white, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image
*'''height:''' the absolute height of the image
*'''u:''' the absolute X coordinate of the top left corner of the section which should be drawn from image
*'''v:''' the absolute Y coordinate of the top left corner of the section which should be drawn from image
*'''usize:''' the absolute width of the image section
*'''vsize:''' the absolute height of the image section
*'''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' the color of the image, a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Example==
The example draws a section of an image. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
dxDrawImageSection(400, 200, 64, 64, 0, 0, 64, 64, 'img.jpg') -- Draw a certain section
dxDrawImage(400, 300, 128, 128, 'img.jpg') -- Draw the whole image to be able to identify the difference
end)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

GetAnalogControlState

2013-09-16T01:34:13Z

Jaysds1: /* Example */ No point of the section as it's already a client function.

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

==Syntax==
<syntaxhighlight lang="lua">float getAnalogControlState ( string controlName )</syntaxhighlight>

===Required Arguments===
*'''controlName :''' the name of the control you wish to get the analog state of. Possible values are:
**'''left'''
**'''right'''
**'''forwards'''
**'''backwards'''
**'''vehicle_left'''
**'''vehicle_right'''
**'''steer_forward'''
**'''steer_back'''
**'''accelerate'''
**'''brake_reverse'''
**'''special_control_left'''
**'''special_control_right'''
**'''special_control_up'''
**'''special_control_down'''

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

==Example==
/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
<syntaxhighlight lang="lua">
function analog()
if (getAnalogControlState("forwards") == 0) then
setAnalogControlState ("forwards",1)
else
setAnalogControlState ("forwards",0)
end
end
addCommandHandler("analog",analog)
</syntaxhighlight>
This example written by '''Samurai'''

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

ToJSON

2013-09-14T15:43:49Z

Jaysds1:

__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}}

FromJSON

2013-09-14T15:43:30Z

Jaysds1:

__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}}

FromJSON

2013-09-14T15:43:07Z

Jaysds1: Seperate the feature line from what the function actually does.

__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}}

ToJSON

2013-09-14T15:29:26Z

Jaysds1: Seperate the feature line from what the function actually does.

__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}}

Version History

2013-09-09T23:30:27Z

Jaysds1: /* See Also */ A more secure future :p

{{note|If you just want to download [[Multi Theft Auto]] go here:
* [http://mtasa.com Download MTA: San Andreas {{Current Version|full}}]
* [[Archive|Download Multi Theft Auto 0.5r2 (GTA3 and Vice City)]]
}}
An overview of the (released) MTA versions.

== List of (released) versions ==
{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ List of Multi Theft Auto Versions
|-
! Release
! Version
! Date
! GTA: III
! GTA: Vice City
! GTA: San Andreas
! License
|-
! GTA3:AM
| 0.1
| February 9, 2003
| {{yes}}
| {{No}}
| {{No}}
| Freeware
|-
! rowspan="2" | GTA3:MTA
| 0.2a
| February 28, 2003
| {{yes}}
| {{No}}
| {{No}}
| Freeware
|-
| 0.3b
| May 29, 2003
| {{yes}}
| {{No}}
| {{No}}
| Freeware
|-
! rowspan="4" | MTA:VC
| 0.1
| August 2, 2003
| {{No}}
| {{Yes}}
| {{No}}
| Freeware
|-
| 0.2
| September 20, 2003
| {{No}}
| {{Yes}}
| {{No}}
| Freeware
|-
| 0.3
| December 25, 2003
| {{No}}
| {{Yes}}
| {{No}}
| Freeware
|-
| 0.3r2
| January 1, 2004
| {{No}}
| {{Yes}}
| {{No}}
| Freeware
|-
! rowspan="6" | MTA
| 0.4
| July 27, 2004
| {{Yes}}
| {{Yes}}
| {{No}}
| Freeware
|-
| 0.4.1
| July 31, 2004
| {{Yes}}
| {{Yes}}
| {{No}}
| Freeware
|-
| 0.5
| January 31, 2005
| {{Yes}}
| {{Yes}}
| {{No}}
| Freeware
|-
| style="background: #FFD6BF;" | [http://files.mtasa.com/web/mta_0.5_launch/051.htm 0.5.1 (2005)]
| {{n/a}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{n/a}}
|-
| style="background: #FFEC99;" | [http://forum.mtasa.com/viewtopic.php?f=31&t=31692#p336938 0.5r2]
| January 31, 2011
| {{Yes}}
| {{Yes}}
| {{No}}
| Freeware
|-
| style="background: #B2BDFF;" | [http://www.projectredivivus.com/ 0.5.1 (2013)]
| {{n/a}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{n/a}}
|-
! rowspan="1" | MTA:VC
| style="background: #FFD6BF;" | [http://files.mtasa.com/web/mtablue.info/ Blue]
| {{n/a}}
| {{No}}
| {{Yes}}
| {{No}}
| {{n/a}}
|-
! rowspan="4" | MTA:SA Race
| 1.0
| January 22, 2006
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.1
| March 16, 2006
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.1.1
| March 18, 2006
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.1.2
| May 18, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
! rowspan="5" | MTA:SA Deathmatch
| 1.0 DP1.0
| January 3, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.0 DP2.0
| January 10, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.0 DP2.1
| May 23, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.0 DP2.2
| August 4, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
| 1.0 DP2.3
| August 6, 2008
| {{No}}
| {{No}}
| {{Yes}}
| Freeware
|-
! rowspan="16" | MTA:SA
| 1.0
| August 21, 2009
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.0.1
| October 2, 2009
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.0.2
| October 24, 2009
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.0.3
| December 17, 2009
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.0.4
| June 10, 2010
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.0.5
| March 28, 2011
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.1
| August 25, 2011
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.1.1
| September 19, 2011
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.2
| December 17, 2011
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.3
| January 24, 2012
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.3.1
| September 3, 2012
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.3.2
| May 5, 2013
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| 1.3.3
| July 2, 2013
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| style="background: #99FF99;" | 1.3.4
| September 7, 2013
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| style="background: #B2BDFF;" | 1.3.5
| {{n/a}}
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
| style="background: #B2BDFF;" | 1.4
| {{n/a}}
| {{No}}
| {{No}}
| {{Yes}}
| GPLv3
|-
|}

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|-
| width="20px;" |  
| Previous Version, Unsupported
|-
| width="20px;" style="background: #99FF99;" |  
| Current Version, Supported
|-
| width="20px;" style="background: #B2BDFF;" |  
| In Development / Future Release
|-
| width="20px;" style="background: #FFEC99;" |  
| Released by Community
|-
| width="20px;" style="background: #FFD6BF;" |  
| Never Released
|-
|}

* AM = Alternative Multiplayer
* DP = Developer Preview
** MTA:San Andreas 1.0 was also known as Developer Preview 3.0, this was later dropped because the 'new' 1.0 was a major release.

{{Comparison of Versions}}

== MTA 0.5 ==
{{versionbox|
versionname = Multi Theft Auto 0.5|
image = [[File:Clientwelcome_nick.jpg|MTA 0.5 Client|center|230px]]|
status = Supported by community|
release = January 31, 2005|
core = 0.3|
license = Freeware|
}}
The latest stable release for GTA III and GTA: Vice City bundled in one client and server. This release was also the first version that had a server browser build in the client.
[[File:800px-Robber.jpg|Spawnscreen in Vice City at Robbers spawn|right|thumb|230px]]

=== Gamemodes ===

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|-
! GTA
! Gamemode Name
! Uses Spawnscreen
|-
! rowspan="2" |GTA: Vice City
| [[MTA:VC Deathmatch Gamemode|Deathmatch]]
| {{Yes}}
|-
| [[MTA:VC Stunt Gamemode|Stunt]]
| {{Yes}}
|-
! rowspan="3" |GTA III
| [[GTA3 Portland|Portland]]
| {{No}}
|-
|[[GTA3 SSV|Shoreside Vale]]
| {{Yes}}
|-
|[[GTA3 Staunton|Staunton]]
| {{No}}
|}

==== Spawns ====

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ MTA:Vice City Deathmatch
|-
! Team/Spawn Name/Mode
! Spawn Location
|-
| Robbers
| Phil's Place - Little Haiti
|-
| Mexicans
| Escobar International Airport's terminal
|-
| Sailors
| Vice City Docks - Vice Port
|-
| Vice City Crusader
| Random Location in Vice City
|-
| Secret Service
| Under a shelter - Ocean Beach
|-
| Cops
| Police Stations in Vice City
|-
|  
|  
|-
| Spectator
| Allows to watch other players
|}

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ colspan="2" | MTA:Vice City Stunt
|-
! Team/Spawn Name/Mode
! Spawn Location
|-
| Yuppies
| Spawn inside the multistory parking garage in Ocean Beach
|-
| Dirt Racers
| Spawn outside of the Stadium
|-
| Bikers
| Spawn in the parking lot behind the Malibu club
|-
| Speeders
| Spawn at the parking lot near the Escobar International Airport
|-
| Packer Driver
| Spawn at Downtown in the large parking lot near the Biker Bar
|-
| Fun House Dept.
| Spawns at North Point Mall's multistory parking garage
|-
| Heli Pilot
| Spawn at the Escobar International Airport runway
|-
|  
|  
|-
| Spectator
| Allows to watch other players
|}

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
|+ GTA3:MTA Shoreside Vale
|-
! Team/Spawn Name
! Spawn Location
|-
| Yakuza
| Pike Creek
|-
| Southside Hoods
| Witchita Gardens
|-
| Columbians
| Cedar Grove
|-
| Cops
| Pike Creek
|}

=== Features ===
* Huge increase in stability. Using the errors reported to us using the Error Report Tool, we've managed to fix a large number of the common crashes.
* New Staunton Island map available for GTA3, which includes a race mode and deathmatch.
* New Shoreside Vale map available for GTA3, which includes several gamemodes.
* Lots of changes to the existing maps.
* A server browser has been added to the client along with an area to store your favourites and a list of servers you've played on recently (History).
* New Client design - The client has been redesigned to make it easier to use. Error messages are now more self explanatory and checks are added to help users ensure their game is set up correctly.
* Added an in-client server that allows you to quickly configure and host a server straight from the MTA Client.
* Integrated the MTA Protocol handler - now mta:// links will work for all MTA 0.5 users.
* Redesigned MTA Admin Tool to make it easier and more logical to use.
* In client global MOTD so that you can hear about news from MTA immediately.
* A rich text welcome message that the server can show to players when they join. This can contain much more information than the normal Message of the Day and is visible in the client the entire time the user is on the server.
* New installation and configuration scripts for easy setup for Linux dedicated servers.
* More platforms supported for the dedicated server, including FreeBSD and OpenBSD.
* Improved error report tool is now installed by default (though optionally).
* Chat box in the client now scrolls properly, as most chat programs do (scroll up to stop auto-scroll).

=== Minor Updates ===

* '''Patch 1''': A server [http://forum.multitheftauto.com/viewtopic.php?f=31&t=13923#p198981 patch] was released; the Message of The Day feature could be exploited.
* '''0.5.1 (2005)''': In February 2005 MTA 0.5.1 [http://files.mtasa.com/web/mta_0.5_launch/051.htm preview] was shown to the public, addressing known issues and adding new features. 0.5.1 was never released.
* '''0.5r2''': Members of the MTA community released a minor update called 0.5r2 for 0.5, this also includes a new (external) server browser, the included server browser in 0.5 client is non-functional since 2008.
** [http://forum.mtasa.com/viewtopic.php?f=31&t=31692#p336938 Download]
** [http://forum.mtasa.com/viewtopic.php?f=31&t=31692#p336939 Changelog for 0.5r2]
* '''0.5.1 (2013)''': In 2013 members of the MTA community called ''Project Redivivus'' are developing a minor update for 0.5 with major changes. This is likely to become open source.
** [http://www.projectredivivus.com/ Website]

=== Archived Wiki pages ===
* [[MTA_0.5_EULA|EULA]]
* [[MTA_0.5_Installation|Installation]]
* [[MTA_0.5_Known_Issues|Known Issues]]
* [[MTA:VC_0.5|0.5 Vice City]]
* [[MTA:VC_Deathmatch_Gamemode|Vice City Deathmatch Gamemode]]
* [[MTA:VC_Stunt_Gamemode|Vice City Stunt Gamemode]]
* [[MTA:mA]]
* [[Using_A_0.5_Server_With_Screen|Using the server with screen utility]]

=== See Also ===
*[[MTA Vault]]

== MTA:San Andreas Race ==
{{versionbox|
versionname = Multi Theft Auto: San Andreas Race|
image = [[File:MTASA-Race-Mainmenu.png|Multi Theft Auto± San Andreas Race Main Menu|center|230px]]|
status = Unsupported/Obsolete|
release = May 18, 2008|
core = Blue|
license = Freeware|
}}
MTA:SA Race is the first release that was made with the blue framework, a new approach to control the game (GTA). The sync was also better over the previous releases and the client is in game not an external application. Notice the blue GUI in the screenshot.

A new slogan was introduced: "Stop Playing With Yourself."
[[File:Mtavcbluelaunching.png|MTA Loading screen with the new slogan: "Stop Playing With Yourself."|thumb|230px]]

=== Gamemodes ===
As the name suggests it is only race (you cannot get out of your vehicle).

{| class="wikitable" style="width: auto; text-align: center; table-layout: fixed;"
!Gamemode
!Notes
|-
|Race
|-
|Freeroam
|-
|Destruction Derby
|The goal is to survive, last player that is still alive wins.
|}

=== Features ===
[[File:MTASA-Race-Racing.jpg|Racing in MTA:SA|right|thumb|230px]]
* In game client.
* Map Editor to create a map in game.
* Optimised netcode results in reduced lag.
* Blue loads a DLL with the game instead of injecting code into its memory process. This improves stability and means that custom SCM files do not have to be moved to the game's directory when it is started.
* Full integration means that Blue's server list is directly integrated into GTA's GUI.
* Fewer glitches. This is achieved by synchronizing every animation, implementing a custom pause menu so that people can't pause to escape death, and forcing the frame limiter on so that everyone's game runs at the same maximum speed.
* Greater synchronization, this means that MTA players can finally use boats.
* Anti cheat.

=== Minor Updates ===
* '''1.1'''
** New mappack
** New map nomination voting system
** Respawning during map
** Map timelimit added in map files and server config
** New player animation sync
** Admins can PM players from remote admin
** The 255 map limit has been fixed
** Fixed various admin stability issues
* '''1.1.1'''
** Fixed: Freezes that occurred frequently for some users (and not at all for others)
** Fixed: Nothing would happen after the splash screen appeared for some users
** Fixed: All players getting kicked from a server with a "protocol error 92" message
** Fixed: Players getting stuck in "You will respawn in 1 second" mode, if a race starts before they join completely
** Fixed: Issue where error reporter would sometimes fail to find core dump
** Fixed: Occasional crash when connecting to a server through the server browser
** Fixes: Various other crashes
** Added: An error message is now displayed if you try to use the ′order checkpoints′ option in the map editor if you have no checkpoints in your map
** Added: DefaultMapDuration and DefaultRespawnTime to server config
* '''1.1.2'''
** All-Seeing Eye server-browser has been removed in favour of a more reliable and faster replacement
** Removed redundant "MTA Center" references
** Removed support for built-in error reporter

No more releases for MTA:SA Race, the new MTA release made the race version obsolete, a new resource called 'race' which could read the race maps replaced it.

=== Archived Wiki pages ===
*[[MTA:SA Race FAQ]]
*[[Blue]]
*[[MTA:SA R1]]
*[[MTA:SA Race-Windows Server Guide]]
*[[MTA General FAQ]]
*[[MTA R1 remote administration_protocol]]

=== See Also ===
* [[Upgrading from MTA:Race]]

== MTA:San Andreas (Deathmatch) 1.0.x ==
{{versionbox|
versionname = Multi Theft Auto: San Andreas (Deathmatch) 1.0.x|
image = [[File:MTA_Main_Menu_1.0.x.png|Multi Theft Auto: San Andreas (Deathmatch) Main Menu|center|230px]]|
status = Unsupported|
release = March 28, 2011|
core = Blue|
license = Freeware (Until DP2.3) GPLv3 (since 1.0 (August 21, 2009))|
}}
MTA:San Andreas Deathmatch Developer Preview 1 was the first release that featured on-foot synchronization for San Andreas. The name deathmatch refers to the ability to shoot with weapons and get on-foot unlike the race version. The tag deathmatch has been dropped in later releases because this version allowed customized gamemodes with LUA scripting and confused players. While the first 5 releases were called 'Developer Preview' it was very popular. In August 21, 2009 version 1.0.x was released with the GPLv3 license this allowed to work with more people on the next release when it became open source.

=== Gamemodes ===
This was the first released that allowed to create customized gamemodes with the LUA scripting language. No static gamemodes.
Scripted gamemodes and utilities packed together are called resources.

=== Features ===
* On-foot synchronization.
* Improved vehicle synchronization.
* LUA scripting.
* New map editor with EDF (Editor Definition File) allowed to edit custom gamemodes created with LUA.
* Included web server in server side for remote administration or statistics.
* Client side scripting with LUA, allowing to transfer files to the client which can be used to create GUI on the client for example.
* ...

=== Minor Updates ===
* 1.0.1
* 1.0.2
* 1.0.3
* 1.0.4
* 1.0.5

=== See Also ===
* [[Changes in 1.0]]
* [http://code.google.com/p/mtasa-blue/ Subversion on Google Code]
* [[Scripting Introduction]]
* [http://www.lua.org/pil/index.html "Programming in Lua" Manual]

== MTA:San Andreas 1.1.x ==
{{versionbox|
versionname = Multi Theft Auto: San Andreas 1.1.x|
image = [[File:MTA_Main_Menu_1.1.x.png|Multi Theft Auto: San Andreas 1.1.x Main Menu|center|230px]]|
status = Unsupported|
release = September 19, 2011|
core = Blue|
license = GPLv3|
}}

=== Features ===
* Vehicle handling can be modified by servers
* Custom fonts
* Special skins
* Improved server browser
* Voice chat (on servers that support it)
* Improved sound support, including streaming audio
* Increased maximum player count
* Custom shaders
* Cars can now have any color you want, not just the ones GTA has normally
* GUI Skin switching

=== Minor Updates ===
* 1.1.1

=== See Also ===
* [[Changes in 1.1]]

== MTA:San Andreas 1.2.x ==
{{versionbox|
versionname = Multi Theft Auto:San Andreas 1.2.x|
status = Unsupported|
release = December 17, 2011|
core = Blue|
license = GPLv3|
}}
=== Features ===
* Major bandwidth usage reductions
* Ability to replace ped models
* Ability to replace weapon models
* Threaded database access functions
* Custom weapon stats
* Synced and controllable vehicle variants
* Improved bullet accuracy synchronization

=== Minor Updates ===
* None

=== See Also ===
* [[Changes in 1.2]]

== MTA:San Andreas 1.3.x ==
{{versionbox|
versionname = Multi Theft Auto:San Andreas 1.3.x|
status = Stable|
release = September 7, 2013|
core = Blue|
license = GPLv3|
}}
This version was released quickly because 1.2 had several network related issues, that were fixed in this release.

=== Features ===
* Fixes for various network problems which occured in 1.1 and 1.2 series. (including a fix for "Map download breaking often on large transfers" issue)
* Added new scripting functions for removal of default GTASA map objects. (including breakable ones)
* Introduced a new scripting event. - [[onClientVehicleCollision]]
* Implemented a new scripting function. - [[takePlayerScreenShot]]
* Fixes for various crashes and issues. (including "warp glitch", inaccurate heat seekers sync, createProjectile() velocity desync between clients, custom models texture crash, "white models" when using custom models and more)
* Added functionality to protect client-side scripts which pre-compiles them before being sent and stops resources from being saved on disk. This is configurable in the resource's meta.xml.
* Added pixel manipulation functionality.
* Introduced new client-side scripting functions - [[setBirdsEnabled]] and [[getBirdsEnabled]]
* Included a new gui skin - [http://forum.mtasa.com/viewtopic.php?f=139&t=36010#p371815 Lighter black] - contributed by Aibo

=== Minor Updates ===
* '''1.3.1'''
** Added Custom Vehicle Sirens
** Fixed map files are downloading very slow issue
** Fixed timeouts on map change
** Fixed various issues, crashes and freezes
** Updated max players to 4096
** Added BASS Effects
** Added Analog Controls States
** Added bullet sync
** Fixed several custom model replacing issues
** Windows 8 support (both 32-bits and 64-bits)
** Added ability to create pedless weapons via weapon creation
** Improved Map Editor stability and added new features
** Installers for regular builds and nightlies are now digitally signed
* '''1.3.2'''
** Client setting: Turn off selected sounds when minimized.
** Client setting: Added aim vertical sensitivity setting.
** Client setting: Added process priority setting.
** Added glitch 'hitanim' to allow 'being hit by bullet' animation when aiming certain weapons.
** Added 'sinfo' command to client to output server info.
** Added 'showframegraph' command for displaying frame timings.
** Added server multiple IP support.
** Reduced stutter on big maps.
** Fixed vehicles losing velocity on race respawn .
** Fixed a server browser crash.
** Fixed smoothness when using server setting 'latency_reduction'.
** Fixed PNG files with alpha channel sometimes being all black.
** Fixed a cause of train desync.
** Fixed depth buffer shaders not working right with mirrors.
* '''1.3.3'''
** Anti-cheat updates
** Optimized streamer to work better with complex maps
** Smoothed fonts when scaling chat box
** Added option to scale HUD elements correctly for widescreen
** Added option to disable OS and graphic driver 'tweaks', as they can interfere with MTA
** Better compatibility with NVidia Optimus laptops
** Improved server performance
** Added setVehiclePlateText()
** Added dxSetAspectRatioAdjustmentEnabled() for draws that align with GTA Hud components
** Added server function getPlayerACInfo()
** Added onClientSoundStarted and onClientSoundStopped scripting events
** Fixed custom vehicle plate text not working for some vehicles
** Fixed setVehicleLandingGearDown() not always working
** Fixed GUI window remaining when you disconnect while starting local server
** Fixed incorrect server side vehicle engine state when driver warped in
** Fixed get/setMatrix() rotation order for streamed out objects
** Fixed onPlayerQuit event not being triggered on shutdown
** Fixed setJetpackWeaponEnabled() not disabling jetpack weapons
** Fixed toggleControl() not working for mta controls
** Fixed serverside toggleAllControls()
** Fixed GUI labels sometimes blocking input
** Fixed setElementPosition() for players vehicle sometimes causing freeze for few seconds
** Fixed a crash on disconnect

=== See Also ===
* [[Changes in 1.3]]
* [[Changes in 1.3.1]]
* [[Changes in 1.3.2]]
* [[Changes in 1.3.3]]
* [[Changes in 1.3.4]]

== See Also ==
* [https://code.google.com/p/mtasa-blue/source/browse/trunk/CHANGELOG Changelog] - Overview of all the changes since MTA: San Andreas 1.0dp1.
* [[MTA Vault]] - Overview of releases before MTA 0.5.
* [[Archive]] - Multi Theft Auto Archive.

[[Category: Historical]]

Changes in 1.3.4

2013-09-09T23:25:44Z

Jaysds1: /* Extra information */ A more secure future :p

{{Changelogs}}

== Main Additions / Changes ==
* Added "shared" export type in meta.xml
* Added Lua source encryption option
* Added the ability to cancel onClientKey
* Added escape to onClientKey (can't be cancelled twice in a row)
* Added SettingHUDMatchAspectRatio, SettingAspectRatio to dxGetStatus

=== Client ===

----

==== New Functions ====
* Added [[playSFX]]
* Added [[playSFX3D]]
* Added [[getSFXStatus]]
* Added [[setHeliBladeCollisionsEnabled]]
* Added [[getHeliBladeCollisionsEnabled]]
* Added [[getEventHandlers]]

==== New Events ====

==== Changes / Bug Fixes ====
* Fixed vehicle upgrades
* Fixed warpPedIntoVehicle causing desync when two players try to enter at the same time via vehicle_enter and warpPedIntoVehicle
* Fixed map editor crash
* Fixed debug filename for compiled scripts
* Fixed applying weapon mods may remove your weapon
* Fixed crash when streaming in tec-9 with a replaced weapon model
* Fixed console(F8) input focus begin lost sometimes
* Fixed building removal crashing after loading/unloading a model 16 times
* Fixed projectile-type weapons messing up ammo count
* fixed guiCreateFont fails each second time resource is started
* Fixed client ammo desync when using giveWeapon sometimes
* Fixed guiLabelGetTextExtent not working with unicode
* Fixed onColShapeHit isn't triggered for towed vehicles server side
* Fixed GUI scrollpanes and scrollbars don't trigger onClientMouseEnter/Leave
* Fixed warpPedIntoVehicle after cancelEvent() of onVehicleStartEnter causes network trouble
* Fixed onPedWasted not triggered, when ped died because the vehicle he was in, exploded.
* Fixed server createColPolygon
* Fixed a crash when destroying an object in onClientColShapeHit / onClientElementColShapeHit
* Fixed lightweight sync packet being misread on the client sometimes
* Fixed getLatentEventHandles sometimes returning false instead of an empty table
* Fixed setAccountData clips the digits after the decimal point
* Fixed peds/players being removed from vehicles that fall through the ground

=== Server ===

----

==== New Functions ====

==== New Events ====

==== Changes / Bug Fixes ====

=== Resources ===
* Added sfxbrowser resource
* Fixed instant reload exploits for the reload resource
* Fixed 'Use LODs' option in the map editor resource
* Fixed various things in admin, acpanel, freeroam, parachute and race resources

=== Editor ===

==Extra information==
''More detailed information available on [https://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* MTA:SA: from [https://code.google.com/p/mtasa-blue/source/list?num=25&start=5609 r5593] to [https://code.google.com/p/mtasa-blue/source/list?num=25&start=5800 r5800]
:* Resources: [https://code.google.com/p/mtasa-resources/source/list?num=25&start=955 from r938 to r955]
:* [https://forum.mtasa.com/viewtopic.php?f=31&t=64990 MTASA 1.3.4 released.]

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

IsSoundFinished

2013-09-09T22:53:35Z

Jaysds1: /* Code */ Changed the var "sound" - "theSound".

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if sound finish.

==Syntax==
<syntaxhighlight lang="lua">bool isSoundFinish( element theSound )</syntaxhighlight>

===Required Arguments===
* '''theSound''': The sound element which finish state you want to return.

===Returns===
Returns ''true'' if the [[sound]] element is finished, ''false'' if unfinished or invalid arguments were passed.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isSoundFinish ( theSound )
local length = getSoundLength( theSound )
local post = getSoundPosition( theSound )
if (post==length) then
return true
else
return false
end
end
</syntaxhighlight>
</section>

==Example==
This example will check and see if the sound is finished or not, and tell the player.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function checkSongFinish()
local finish = isSoundFinished(theSound)
if(finish == true) then
outputChatBox("The sound is finish!")
else
outputChatBox("The sound is not finish!")
end
end
addCommandHandler("checkfinish", checkSongFinish)
</syntaxhighlight>
</section>

Author: WASSIm.

==See Also==
{{Useful_Functions}}

GetWeaponOwner

2013-09-09T22:44:25Z

Jaysds1: Added an example section and added this function to "Needs Example" template.

__NOTOC__
{{Client function}}
{{Needs_Example}}
Get the owner of the custom weapon (used for lag compensation.)

==Syntax==
<syntaxhighlight lang="lua">player getWeaponOwner ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to get the owner of.

===Returns===
Returns the ''player element'' of the custom weapon owner, ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

GetWeaponFlags

2013-09-09T22:43:37Z

Jaysds1: Added an example section and added this function to "Needs Example" template.

__NOTOC__
{{Client function}}
{{Needs_Example}}
Gets the flags of the custom weapon (used to determine what to hit)

==Syntax==
<syntaxhighlight lang="lua">value getWeaponFlags ( weapon theWeapon, string theFlag )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the flag of.
* '''theFlag:''' The weapon flag to get:
** bool disable_model disable the weapon model of the weapon
** flags edit the processLineOfSight flags used to find the hit position
** bool checkBuildings
** bool checkCarTires
** bool checkDummies
** bool checkObjects
** bool checkPeds
** bool checkVehicles
** bool checkSeeThroughStuff
** bool checkShootThroughStuff
** bool instant_reload reload the weapon instantly rather than doing a reload
** bool shoot_if_out_of_range shoot the target position if out of weapon range
** bool shoot_if_blocked shoot the target position if blocked

===Returns===
Returns the ''value(s)'' on success (flags have 8 values), ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

SetWeaponFlags

2013-09-09T22:42:29Z

Jaysds1: Added an example section and added this function to "Needs Example" template.

__NOTOC__
{{Client function}}
{{Needs_Example}}
Set a custom weapons flags.

'''Note:''' This is not the same as [[setWeaponProperty]]. These flags are different and can only be set for custom weapon types. You cannot set these flags for 'normal' weapons. This is true despite the ability in setWeaponProperty to set any number of supported [[Weapon Flags]].

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponFlags ( weapon theWeapon, string theFlag, value theValue )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' the weapon to set the flag of
* '''theFlag:''' the weapon flag to set:
** bool disable_model disable the weapon model of the weapon
** flags edit the processLineOfSight flags used to find the hit position
** bool checkBuildings
** bool checkCarTires
** bool checkDummies
** bool checkObjects
** bool checkPeds
** bool checkVehicles
** bool checkSeeThroughStuff
** bool checkShootThroughStuff
** bool instant_reload reload the weapon instantly rather than doing a reload
** bool shoot_if_out_of_range shoot the target position if out of weapon range
** bool shoot_if_blocked shoot the target position if blocked
* '''theValue:''' the value to set

===Returns===
Returns ''true'' on success (flags have 8 values), ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

sets the flags of the weapon ( used to determine what to hit )

SetWeaponOwner

2013-09-09T22:37:23Z

Jaysds1: Added an example section and added this function to "Needs Example" template.

__NOTOC__
{{Client function}}
{{Needs_Example}}
Sets the owner (a player) of the custom weapon.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponOwner ( weapon theWeapon, player theOwner )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the owner of
* '''theOwner:''' The weapon owner

===Returns===
Returns ''true'' on success, ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

CreateWeapon

2013-08-27T06:30:41Z

Jaysds1: /* Examples */ No point of the section as it's already a client function

{{Needs_Checking|"Some weapon types do not work."... needs investigating. Shotguns do not work because the pellet code was complex and its actually 8 very clustered pellets. All other bullet weapons should work and be synced. Exact weapons this works with needs documenting still.}}
__NOTOC__
{{Client function}}
Creates a custom weapon that can fire bullets not related to player held weapons.
'''Note:''' Some weapon types do not work.

==Syntax==
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight>

===Required Arguments===
* '''theType:''' The weapon type which can be:
{{Custom Weapon Types}}

* '''x:''' The x position to create the weapon.
* '''y:''' The y position to create the weapon.
* '''z:''' The z position to create the weapon.

===Returns===
Returns a custom weapon [[element]] type and creates a simulated weapon at that position.

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==Examples ==
'''Example 1:''' This example create weapon and firing.
<syntaxhighlight lang="lua">
function createMinigunWeapon()
local x, y, z = getElementPosition(getLocalPlayer())
local weapon = createWeapon("minigun", x, y, z + 1)
setWeaponClipAmmo ( weapon,99999)
setWeaponState ( weapon,"firing")
end
addCommandHandler("createminigun", createMinigunWeapon)
</syntaxhighlight>

==See Also==
{{Client weapon creation functions}}
[[ru:createWeapon]]

GuiSetInputEnabled

2013-08-27T06:26:50Z

Jaysds1: /* Example */ No point of the section as it's already a client function.

{{Client function}}
__NOTOC__
This function enables or disables input focus for the GUI. This means that any keybinds or MTA binds are overidden so that text can be input into an editbox, for example. In other words, keys such as ''t'' and ''y'' which activate the chatbox are disabled.

{{New feature|3.0110|1.1|
[[guiSetInputMode]] can be used as an extended version of ''guiSetInputEnabled'' since it provides the same functionality with one added feature.
}}

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

===Required Arguments===
* '''enabled:''' true if input should go to GUI, false if it should go to the game.

===Returns===
Returns ''true'' if input mode could be changed, ''false'' if invalid parameters are passed.

==Example==
This example enables or disables the Input.
<syntaxhighlight lang="lua">
function setInputState()
guiSetInputEnabled(not guiGetInputEnabled()) -- Disable the Input if Enabled, either Enable it.
outputChatBox("The input is now ".. (guiGetInputEnabled() and "Enabled" or "Disabled") ..".") -- Output the new Input state.
end
addCommandHandler("input",setInputState) -- Add the command handler attached to the function "setInputState".
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiSetInputMode

2013-08-27T06:25:18Z

Jaysds1: /* Example */ No point of the section as it's already a client function.

{{Client function}}
__NOTOC__
This function controls the input mode to define whether or not (and when) keybinds or MTA binds are overridden (disabled) so that text can be input into an editbox, for example.
The binds can be either:
* never disabled (hence using a key such as t in an editbox will still activate the chatbox)
* always disabled (hence using a key such as t in an editbox will not activate the chatbox)
* only disabled when actually editing an editbox or a memo (binds are always enabled except when an editbox or memo has input focus)

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetInputMode ( string mode )
</syntaxhighlight>

===Required Arguments===
* '''mode:''' a string representing the desired input mode. Accepted values are:
** '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still activate the chatbox (default)
** '''"no_binds":''' binds are disabled, hence using a key such as t in an editbox will not activate the chatbox
** '''"no_binds_when_editing":''' binds are always enabled except when an editable editbox or memo has input focus

===Returns===
Returns ''true'' if input mode could be changed, ''false'' if invalid parameters are passed.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function()
guiSetInputMode("no_binds_when_editing") --Calls guiSetInputMode once and for all to not have to handle binds state dynamically
end)
</syntaxhighlight>

==Note==
This function, introduced in 1.1, can be used as a replacement of [[guiSetInputEnabled]] since it provides the same functionality with one added feature.
* ''guiSetInputEnabled ( false )'' is the same as ''guiSetInputMode ( "allow_binds" )''
* ''guiSetInputEnabled ( true )'' is the same as ''guiSetInputMode ( "no_binds" )''

==See Also==
{{GUI_functions}}

FetchRemote

2013-08-24T16:44:14Z

Jaysds1: /* Optional Arguments */ Arrange in the same order as the function Arguments

__NOTOC__
{{Server client function}}
This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

If you are using fetchRemote to connect to a PHP script, you can use ''file_get_contents("php://input")'' to read the '''postData''' sent from this function.
{{Note|Client side function only works with the server the player is connected to}}
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, int connectionAttempts = 10 ], callback callbackFunction, [ string postData = "", bool postIsBinary = false, [ arguments... ] ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error. A list of possible error values are:
{{Error_codes_for_callRemote_and_fetchRemote}}
<div style="padding-left:19px;">
*'''''arguments...''''' - The arguments that were passed into fetchRemote
</div>

===Optional Arguments===
*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 6 seconds. Therefore, the default setting of 10 connection attempts means it will be 60 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 12 seconds''
*'''postData:''' A string specifying any data you want to send to the remote HTTP server.
*'''postIsBinary :''' A boolean specifying if the data is text, or binary.
*'''arguments:''' Any arguments you may want to pass to the callback.

===Returns===
Returns ''true'' if the arguments are correct, ''false'' otherwise.

==Example==
This example shows you how you can fetch an image from a web page, and transfer it to a particular client:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function startImageDownload( playerToReceive )
fetchRemote ( "http://www.example.com/image.jpg", myCallback, "", false, playerToReceive )
end

function myCallback( responseData, errno, playerToReceive )
if errno == 0 then
triggerClientEvent( playerToReceive, "onClientGotImage", resourceRoot, responseData )
end
end
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent( "onClientGotImage", true )
addEventHandler( "onClientGotImage", resourceRoot,
function( pixels )
if myTexture then
destroyElement( myTexture )
end
myTexture = dxCreateTexture( pixels )
end
)

addEventHandler("onClientRender", root,
function()
if myTexture then
local w,h = dxGetMaterialSize( myTexture )
dxDrawImage( 200, 100, w, h, myTexture )
end
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.0-9.03739|1.3.2|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04605|Added connectionAttempts argument}}
{{ChangelogItem|1.3.2|Added client side}}

==See Also==
{{Resource_functions}}

Modules

2013-08-18T19:34:22Z

Jaysds1: /* Modules SDK */

Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as sockets. All modules listed here are not distributed with Multi Theft Auto, and must be manually installed.

==Modules list==
You can view a list of all the documented modules in this wiki [[:Category:Modules|here]].

==Modules SDK==
To be able to create your own modules, you must use the Modules SDK. You can download it from one of the links below - choose a link in accordance with your server's operating system.

* Linux
** [http://files.mtasa.com/apps/1.0/dm/ml_devkit.tar.gz Official]
* Microsoft Windows
** [http://www.mediafire.com/?b8b3asgegn0xkm4 Mirror (Mediafire)]
** [http://hosting.jworld137.com/files/ml_devkit.zip Mirror (JWorld137 Hosting)]

===SDK Functions===
*Currently in there:
**Base:
***HelloWorld
**MySQL
***MySQLCreate
***MySQLOpen
***MySQLDestroy
***MySQLQuery
***MySQLSafeString

[[Category:Scripting Concepts]]
[[Category:Incomplete]]
[[Category:Modules]]

[[pt-br:Módulos]]
[[ru:Modules]]

Template:Useful Functions

2013-07-26T19:30:44Z

Jaysds1: Re-Organized Alphabetically

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function center the window in any resolution.
*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[dxGetRealFontHeight]] » Accurately measures the pixel height of a font.
*[[findRotation]] » Takes two points and returns the direction from point A to point B.
*[[FormatDate]] » Formats a date on the basis of a format string and returns it.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.
*[[getElementsWithinMarker]] » This function gets the elements that are in a markers colshape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayersByData]] » This function gets players who have data name you passed to it.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPlayerFromSerial]] » This function gets an online player from their serial.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTeamFromColor]] » This function gets a team from it's color. (Related to: [[getTeamFromName]])
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getXMLNodes]] » Returns all children of a node
*[[getVehicleRespawnPosition]] » This function allows you to get the spawn position of a vehicle.
*[[guiComboBoxAdjustHeight]] » Adjusts the combobox to have a correct height.
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element was in the player's camera picture.
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if the [[element]] is in a [[colshape]].
*[[isPedAiming]]» This function checks if a ped is aiming.
*[[isPlayerInTeam]] » This function check if the player in the team.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[mathNumber]] » This function is a workaround for the clientside floating-point precision of 24-bits
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This clientside function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[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.random]] » This function retrieves a random variable from a table.
*[[table.size]] » Finds the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.
*[[var dump]] » This function outputs information about one or more variables using outputConsole()
*[[wavelengthToRGBA]] » This function converts a phisical wavelength of light to a RGBA color.
[[Category:Useful Functions]]

OnClientWeaponFire

2013-07-23T23:20:06Z

Jaysds1: /* Example */ No point of section as it's already only client-sided

{{Client event}}
__NOTOC__
This event will be triggered once a client fires his weapon.

==Parameters==
<syntaxhighlight lang="lua">
element hitElement, float posX, float posY, float posZ, float normalX, float normalY, float normalZ, int materialType, int lighting, int pieceHit
</syntaxhighlight>
*'''hitElement:''' the element that was hit
*'''posX:''' the position it will hit
*'''posY:''' the position it will hit
*'''posZ:''' the position it will hit
*'''normalX:''' the normal it hit ( see processLineOfSight )
*'''normalY:''' the normal it hit ( see processLineOfSight )
*'''normalZ:''' the normal it hit ( see processLineOfSight )
*'''materialType:''' the material type it hit ( see processLineOfSight )
*'''lighting:''' the lighting of the entity it hit ( see processLineOfSight )
*'''pieceHit:''' the piece of the entity it hit ( see processLineOfSight )

==Source==
The [[event system#Event source|source]] of this event is the weapon that was fired.

==Cancel Effect==
If this event was [[Event system#Canceling|canceled]], then the weapon will not fire.

==Example==
This example prevents the player from firing a Deagle.
<syntaxhighlight lang="lua">
function noDeagle()
local weaponID = getElementModel(source)
-- Gets the ID of the weapon.
if weaponID == 24 then
-- If the weapon ID is of the Deagle's then cancel the event.
cancelEvent()
end
end
addEventHandler("onClientWeaponFire", getRootElement(), noDeagle)
-- Attach the event 'onClientWeaponFire' to the function.
</syntaxhighlight>

==See Also==
===Client event functions===
{{Client_event_functions}}

ToggleAllControls

2013-07-23T20:15:33Z

Jaysds1:

__NOTOC__
{{Server client function}}
Enables or disables the use of all GTA controls for a specified player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool toggleAllControls ( player thePlayer, bool enabled, [ bool gtaControls = true, bool mtaControls = true ] ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to toggle the control ability of.
*'''enabled:''' A boolean value representing whether or not the controls will be usable.

===Optional Arguemnts===
{{OptionalArg}}
*'''gtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect GTA's internal controls.
*'''mtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect MTA's own controls., e.g. chatbox.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool toggleAllControls ( bool enabled, [ bool gtaControls = true, bool mtaControls = true ] ) </syntaxhighlight>

===Required Arguments===
*'''enabled:''' A boolean value representing whether or not the controls will be usable.

===Optional Arguemnts===
{{OptionalArg}}
*'''gtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect GTA's internal controls.
*'''mtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect MTA's own controls., e.g. chatbox.
</section>

===Returns===
This function returns ''true'' if controls were toggled successfully, false otherwise.

==Example==
<section name="Server" class="server" show="true">
This function will disable the use of all controls in order to freeze a player, which will be used every time someone enters a vehicle.
<syntaxhighlight lang="lua">
function freezeThisDude ( thePlayer, freezeTime )
toggleAllControls ( thePlayer, false ) -- disable this player's controls
setTimer ( toggleAllControls, freezeTime, 1, thePlayer, true ) -- enable this player's controls after the specified time
end

function freezeOnEnterVehicle ( theVehicle, seat, jacked )
freezeThisDude ( source, 5000 ) -- 'freeze' him for 5000ms = 5 seconds
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), freezeOnEnterVehicle )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

HandlingGetSuspensionFrontRearBias

2013-07-19T16:42:42Z

Jaysds1:

__NOTOC__
{{Server function}}
{{Needs_Example}}
Returns the suspension bias of a handling element or vehicle ID.

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

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

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

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

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

==See Also==
{{Handling_functions}}

SetWeaponClipAmmo

2013-07-19T16:26:57Z

Jaysds1: Added example header and Needs Example

__NOTOC__
{{Client function}}
{{Needs_Example}}
Set the ammo in a custom weapons magazine/clip.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponClipAmmo ( weapon theWeapon, int clipAmmo )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the clip ammo of.
* '''clipAmmo:''' The amount of ammo in the clip.

===Returns===
Returns ''true'' on success, ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

HandlingSetABS

2013-07-19T16:21:18Z

Jaysds1: Needs an example

__NOTOC__
{{Server function}}
{{Needs_Example}}
Turns ABS on or off for a handling element.

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

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

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

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

==See Also==
{{Handling_functions}}

SetPedClothes

2013-07-19T16:20:29Z

Jaysds1: /* Example */ "/" is not needed

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you set a ped's clothes with just the slot and clothing index, allowing you to forget about texture and model names.

==Syntax==
<syntaxhighlight lang="lua">bool setPedClothes(ped thePed, int clothingSlot, int/bool clothingID)</syntaxhighlight>

===Required Arguments===
* '''thePed''': The ped to dress up.
* '''clothingSlot''': The clothing slot to change. See the [[CJ Clothes|clothes catalog]] for more info.
* '''clothingID''': The clothing ID to set the slot to, or false to remove clothing from this slot (only applicable to slot IDs > 3). See the [[CJ Clothes|clothes catalog]] for more info.

===Returns===
This function returns ''true'' if the clothes were set successfully, ''false'' otherwise.

==Code==
<section show="true">
<syntaxhighlight lang="lua">
function setPedClothes(thePed, clothingSlot, clothingID)
if not isElement(thePed) or type(clothingSlot) ~= "number" then
error("Invalid arguments to setPedClothes()!", 2)
end

if not clothingID then
return removePedClothes(thePed, clothingSlot)
end

local hasClothes = getPedClothes(thePed, clothingSlot)
if hasClothes then
removePedClothes(thePed, clothingSlot)
end

local texture, model = getClothesByTypeIndex(clothingSlot, clothingID)
return addPedClothes(thePed, texture, model, clothingSlot)
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example adds a '/setClothes [slot] [id]' command.
<syntaxhighlight lang="lua">
local function clothesCommand(player, slot, id)
if not tonumber(slot) then
outputChatBox("SYNTAX: /setClothes [slot] [id]", player, 255, 0, 0)
return
end

setPedClothes(player, slot, id)
end
addCommandHandler("setClothes", clothesCommand)
</syntaxhighlight>
</section>

Author: John

==See Also==
{{Useful_Functions}}

GetWeaponFiringRate

2013-07-19T16:16:03Z

Jaysds1: Added example header and Needs Example

__NOTOC__
{{Client function}}
{{Needs_Example}}
Gets the firing rate to be used when you set the custom weapon to the firing state.

==Syntax==
<syntaxhighlight lang="lua">int getWeaponFiringRate ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to modify the firing rate of.

===Returns===
Returns an ''integer'' with the firing rate of the custom weapon, ''false'' otherwise.

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

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}

MakePedUseGun

2013-07-19T16:13:17Z

Jaysds1: /* Example */

__NOTOC__
{{Client function}}
{{DeprecatedWithAlt|setPedControlState|}}
This function is used to force a ped to use a gun. '''This function does not appear to work,''' to make a ped use a weapon use [[setPedControlState]] instead.

==Syntax==
<syntaxhighlight lang="lua">
bool makePedUseGun ( ped thePed, int useType, element target )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] you wish to force the use of a gun upon.
*'''useType:''' How the weapon should be used, will accept the following values:
** '''0:''' Do nothing
** '''1:''' Aim weapon
** '''2:''' Fire
** '''3:''' Burst-fire
** '''4:''' Reload
** '''5:''' Pistolwhip (Weapon melee)
** '''6:''' Cancel use
** '''7:''' Cancel use immediately
*'''target:''' An [[element]] referring to the target that the ped will use its weapon against.

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

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

==See Also==
{{Client_ped_functions}}

IsElementDoubleSided

2013-07-19T16:12:35Z

Jaysds1:

{{Server client function}}
{{Needs_Example}}
__NOTOC__
This function checks whether an element is double-sided as set by [[setElementDoubleSided]] or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isElementDoubleSided ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element in which you'd like to check the double-sidedness of.

===Returns===
Returns ''true'' if the '''theElement''' is double-sided, ''false'' otherwise.

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

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