Multi Theft Auto: Wiki - User contributions [en]

SetVehicleHandling

2021-11-02T09:08:11Z

NOki: Added reference to helicopters and other aircraft as per #2426

{{Server client function}}
__NOTOC__
This function is used to change the handling data of a vehicle.

{{New feature/item|3.0156|1.5.5|12009|Implemented also for client-sided vehicles.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHandling(element theVehicle, string property, var value)
</syntaxhighlight>

Syntaxes for reset configurations:
<syntaxhighlight lang="lua">
bool setVehicleHandling(element theVehicle, string property, nil, false) -- Reset one property to model handling value
bool setVehicleHandling(element theVehicle, string property, nil, true) -- Reset one property to GTA default value
bool setVehicleHandling(element theVehicle, false) -- Reset all properties to model handling value
bool setVehicleHandling(element theVehicle, true) -- Reset all properties to GTA default value
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to set the handling of.
*'''property:''' The property you wish to set the handling of the vehicle to.

{{Note|For functionality reasons, suspension modification is disabled on monster trucks, trains, boats and trailers.
Additionally, helicopters are not affected by custom handling. The vehicle-on-wheels handling does not affect planes when they are on the ground either.}}
{{Warning|To change handling values of aircraft like ''maxVelocity'', you must first set [[SetAircraftMaxVelocity|setAircraftMaxVelocity]].}}

{{Handling Properties}}
*'''value:''' The value of the property you wish to set the handling of the vehicle to.

===Returns===
Returns ''true'' if the handling was set successfully, ''false'' otherwise. See below a list of valid properties and their required values:

==Example==
This example will make Infernus handling very fast and also make it damage proof from collision (handling by Mr.unpredictable).
this example will help you in creating your own vehicle handling.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function vhandling ( theVehicle )
if getElementModel(theVehicle) == 411 then -------------- vehicle Id
setVehicleHandling(theVehicle, "mass", 300.0)
setVehicleHandling(theVehicle, "turnMass", 200)
setVehicleHandling(theVehicle, "dragCoeff", 4.0 )
setVehicleHandling(theVehicle, "centerOfMass", { 0.0,0.08,-0.09 } )
setVehicleHandling(theVehicle, "percentSubmerged", 103)
setVehicleHandling(theVehicle, "tractionMultiplier", 1.8)
setVehicleHandling(theVehicle, "tractionLoss", 1.0)
setVehicleHandling(theVehicle, "tractionBias", 0.48)
setVehicleHandling(theVehicle, "numberOfGears", 5)
setVehicleHandling(theVehicle, "maxVelocity", 300.0)
setVehicleHandling(theVehicle, "engineAcceleration", 90.0 )
setVehicleHandling(theVehicle, "engineInertia", 5.0)
setVehicleHandling(theVehicle, "driveType", "rwd")
setVehicleHandling(theVehicle, "engineType", "petrol")
setVehicleHandling(theVehicle, "brakeDeceleration", 20.0)
setVehicleHandling(theVehicle, "brakeBias", 0.60)
-----abs----
setVehicleHandling(theVehicle, "steeringLock", 35.0 )
setVehicleHandling(theVehicle, "suspensionForceLevel", 0.85)
setVehicleHandling(theVehicle, "suspensionDamping", 0.15 )
setVehicleHandling(theVehicle, "suspensionHighSpeedDamping", 0.0)
setVehicleHandling(theVehicle, "suspensionUpperLimit", 0.15 )
setVehicleHandling(theVehicle, "suspensionLowerLimit", -0.16)
setVehicleHandling(theVehicle, "suspensionFrontRearBias", 0.5 )
setVehicleHandling(theVehicle, "suspensionAntiDiveMultiplier", 0.0)
setVehicleHandling(theVehicle, "seatOffsetDistance", 0.0)
setVehicleHandling(theVehicle, "collisionDamageMultiplier", 0.00)
--setVehicleHandling(theVehicle, "monetary", 10000) This one is disabled for now
setVehicleHandling(theVehicle, "modelFlags", 1002000)
setVehicleHandling(theVehicle, "handlingFlags", 1000002)
--setVehicleHandling(theVehicle, "headLight", 3) This one is disabled for now
--setVehicleHandling(theVehicle, "tailLight", 2) This one is disabled for now
--setVehicleHandling(theVehicle, "animGroup", 4) This one is disabled for now
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), vhandling )
</syntaxhighlight></section>

This example will add a command for players with which they can change the mass of the vehicle.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function massChange ( me, command, mass )
local mass = tonumber ( mass ) -- Convert mass to a number
local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

if mass and veh then -- If valid mass and in a vehicle
local success = setVehicleHandling ( veh, "mass", mass) -- Set the vehicle's mass, and check if successful

if success then -- If successful
outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
else -- Too bad failure is still an option
outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
end
elseif not veh then -- If not in a vehicle
outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
elseif not mass then -- If not a valid mass
outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
end
end
addCommandHandler ( "changemass", massChange )
</syntaxhighlight></section>

This example will apply custom handling as defined for each specific vehicle (ID) in below table
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local predefinedHandling = {
[411] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[415] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[562] = { -- Universal drift handling
["driveType"] = "rwd",
["engineAcceleration"] = 200,
["dragCoeff"] = 1.5,
["maxVelocity"] = 300,
["tractionMultiplier"] = 0.7,
["tractionLoss"] = 0.8,
["collisionDamageMultiplier"] = 0.4,
["engineInertia"] = -175,
["steeringLock"] = 75,
["numberOfGears"] = 4,
["suspensionForceLevel"] = 0.8,
["suspensionDamping"] = 0.8,
["suspensionUpperLimit"] = 0.33,
["suspensionFrontRearBias"] = 0.3,
["mass"] = 1800,
["turnMass"] = 3000,
["centerOfMass"] = { [1]=0, [2]=-0.2, [3]=-0.5 }, -- Good example to understand centerOfMass parameter usage
},

--next model below etc (copy rows)
}

for i,v in pairs (predefinedHandling) do
if i then
for handling, value in pairs (v) do
if not setModelHandling (i, handling, value) then
outputDebugString ("* Predefined handling '"..tostring(handling).."' for vehicle model '"..tostring(i).."' could not be set to '"..tostring(value).."'")
end
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v and predefinedHandling[getElementModel(v)] then
for k,vl in pairs (predefinedHandling[getElementModel(v)]) do
setVehicleHandling (v, k, vl)
end
end
end

function resetHandling()
for model in pairs (predefinedHandling) do
if model then
for k in pairs(getOriginalHandling(model)) do
setModelHandling(model, k, nil)
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v then
local model = getElementModel(v)
if predefinedHandling[model] then
for k,h in pairs(getOriginalHandling(model)) do
setVehicleHandling(v, k, h)
end
end
end
end
end
addEventHandler("onResourceStop", resourceRoot, resetHandling)
</syntaxhighlight></section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12009|Added for vehicles created on client-side.}}

==See other vehicle functions==
{{Vehicle functions}}

OnSettingChange

2021-11-02T07:36:30Z

NOki: Improved clarity of example code

__NOTOC__
{{Server event}}
This event is triggered when resource setting has been changed. For instance, this event would trigger if you would edit the settings of the Race resource through the Admin panel.

==Parameters==
<syntaxhighlight lang="lua">
string setting, string oldValue, string newValue
</syntaxhighlight>

*'''setting''': The setting which was changed. For instance: "*race.ghostmode"
*'''oldValue''': The previous value. Please note that this value is in [[JSON]]. To get a normal Lua value, use [[fromJSON]]
*'''newValue''': The new value. Also in [[JSON]]

==Source==
The [[event system#Event source|source]] of this event is the [[root element]].

==Example==
<syntaxhighlight lang="lua">
function makeSettingsChangesVisible(setting, oldValue, newValue)
local whatItWas = fromJSON(oldValue)
local whatItsNow = fromJSON(newValue)
outputDebugString("The setting "..setting.." was "..whatItWas.." and has been changed to "..whatItsNow..".") -- Making the setting change visible in debug (use /debugscript [number] to see it)
end
addEventHandler("onSettingChange", root, makeSettingsChangesVisible)
</syntaxhighlight>

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

SetGlitchEnabled

2018-04-05T09:53:23Z

NOki: Cleaned example code

__NOTOC__
{{Server function}}
This function enables or disables glitches that are found in the original Single Player game that can be used to gain an advantage in multiplayer.
{{Note|By default all these glitches are disabled - use this function to '''enable''' them.}}

Users of the '''fastmove''' glitch may additionally want to install [https://community.mtasa.com/index.php?p=resources&s=details&id=13368 this resource to disable crouchsliding].

==Syntax==
<syntaxhighlight lang="lua">bool setGlitchEnabled ( string glitchName, bool enable )</syntaxhighlight>

===Required Arguments===
*'''glitchName:''' the name of the property to set. Possible values are:
{{Glitches}}
*'''enable:''' whether or not to enable the glitch.

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

==Example==
This example enables all glitches in the server once the resource is loaded.
<syntaxhighlight lang="lua">
local glitches = {"quickreload", "fastmove", "fastfire", "crouchbug", "highcloserangedamage", "hitanim", "fastsprint", "baddrivebyhitbox", "quickstand"}

function enableGlitches()
for _, glitch in ipairs(glitches) do
setGlitchEnabled(glitch, true)
end
end
addEventHandler("onResourceStart", resourceRoot, enableGlitches)
</syntaxhighlight>

==See Also==
{{Server functions}}

DxGetTextWidth

2016-07-25T11:30:14Z

NOki: Added a note about this function being relative to client screen size

__NOTOC__
{{Client function}}
This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].

'''NOTE:''' This function is relative to the client's screen resolution.

==Syntax==
<syntaxhighlight lang="lua">
float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.1|6942|{{OOP|This syntax requires you to ignore the font argument above| [[Element/DX font|font]]:getTextWidth}}}}
===Required Arguments===
* '''text:''' A string representing the text for which you wish to retrieve with width for.

==Optional Arguments==
{{OptionalArg}}
* '''scale:''' The size of the text.
* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}
* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

===Returns===
Returns the float of the width of the text.

==Example==
<section name="Example" class="client" show="true">
This will show you the width of a message in a normal chatbox sent by a player
<syntaxhighlight lang="lua">
function dxwidth(msg)
chatbox = getChatboxLayout()
local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
outputChatBox(tostring(length))
end
addEventHandler("onClientChatMessage",root,dxwidth)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

GuiGetScreenSize

2016-07-25T11:29:29Z

NOki:

__NOTOC__
{{Client function}}
This function retrieves the local screen size according to the resolution they are using.

==Syntax==
<syntaxhighlight lang="lua">
float float guiGetScreenSize()
</syntaxhighlight>

===Returns===
This returns two floats representing the player's screen resolution, ''width'' and ''height''.

==Example==
This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect.
<syntaxhighlight lang="lua">
--setup a function when the resource starts
function checkResolutionOnStart ()
local x,y = guiGetScreenSize() --get their screen size
if ( x <= 640 ) and ( y <= 480 ) then --if their resolution is lower or equal to 640x480
--warn them about GUI problems.
outputChatBox ( "WARNING: You are running on a low resolution. Some GUI may be placed or appear incorrectly." )
end
end
--attach the function to the event handler
addEventHandler ( "onClientResourceStart", resourceRoot, checkResolutionOnStart )
</syntaxhighlight>

==Using guiGetScreenSize to fit GUI & DX drawing in all resolutions==
To get the precise coordinates of a GUI element or DX drawings, you need to decide which edges of the screen you want to have them positioned against, then you just need to find the difference between your screen size and your position values.

For example, there is a DX text. It fits on 1024x768 resolution.
<syntaxhighlight lang="lua">
function DXtext ()
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientRender", getRootElement(), DXtext )
</syntaxhighlight>
Now if you want it to fit on all resolutions. Then follow these steps:

1. Add ''width'' and ''height'' variables to get GUI's screen size, here we use sWidth and sHeight.
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText( "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

2. Divide each of the DX text's position values by the screen size manually (remembering the resolution is 1024x768):

*'''Left''' position value is 684, 684/1024 = 0.668
*'''Top''' position value is 731, 731/768 = 0.952
*'''Right''' position values is 732, 732/1024 = 0.715
*'''Bottom''' position value is 766, 766/768 = 0.997

You may want to use a calculator to help you count.

3. Now with the answer above remove all of the position values and replace it with the width or height variable multiplied by the answer. Which would be:
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText("Hello World!",sWidth*0.668, sHeight*0.952, sWidth*0.715, sHeight*0.997,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

So the final results will be a DX text which will fit on all resolutions which will be:
<syntaxhighlight lang="lua">
function DXtext ()
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText("Hello World!",sWidth*0.668, sHeight*0.952, sWidth*0.715, sHeight*0.997,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientRender", getRootElement(), DXtext )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

TextDisplayRemoveText

2016-07-06T08:20:25Z

NOki: Changed argument order

__NOTOC__
{{Server function}}
This function removes a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].

==Syntax==
<syntaxhighlight lang="lua">
void textDisplayRemoveText ( textdisplay displayToRemoveFrom, textitem itemToRemove )
</syntaxhighlight>

===Required Arguments===
* '''displayToRemoveFrom''': The [[textdisplay]] to remove the [[textitem]] from.
* '''itemToRemove''': The [[textitem]] to remove from the display.

==Example==
This example creates a text display and adds a "Hello World" text item to it. It then removes that text item 5 seconds later.
<syntaxhighlight lang="lua">
-- Create a text display.
myTextDisplay = textCreateDisplay ( )
-- Add a player as an observer, i.e. this player will see everything added to this display
textDisplayAddObserver ( myTextDisplay, aPlayer )
-- Create a new text item with the text 'Hello World' and a priority of 'low' and colored red.
myTextItem = textCreateTextItem ( "Hello World", 0.5, 0.5, "low", 255, 0, 0, 0, 1.0 )
-- Add the newly created text item to the display
textDisplayAddText ( myTextDisplay, myTextItem )
-- Remove the text item from the display
setTimer ( textDisplayRemoveText, 5000, 1, myTestDispay, myTextItem )
</syntaxhighlight>

==See Also==
{{Text functions}}

GetPedWeapon

2016-03-30T06:18:43Z

NOki: /* Syntax */

__NOTOC__
{{Server client function}}
This function tells you which weapon type is in a certain weapon slot of a ped. See [[weapon|Weapon Info]]

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeapon ( ped thePed, [ int weaponSlot = current ] )
</syntaxhighlight>
{{OOP|||[[ped]]:getWeapon()|}}

===Required Arguments===
*'''thePed''': the [[ped]] you want to get the weapon type from.

===Optional Arguments===
*'''weaponSlot''': an integer representing the weapon slot (set to the ped's current slot if not given).

===Returns===
Returns an [[int]] indicating the type of the weapon the ped has in the specified slot. If the slot is empty, it returns 0.

It should be noted that if a ped runs out of ammo for a weapon, it will still return the ID of that weapon in the slot (even if it appears as if the ped does not have a weapon at all), though [[getPedTotalAmmo]] will return '''0'''. Therefore, [[getPedTotalAmmo]] should be used in conjunction with [[getPedWeapon]] in order to check if a ped has a weapon.

==Example==
This example will display a player's current weapon type. In this case,a random player.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- Find a player called someguy and find his current weapon id.
local weaponType = getPedWeapon ( getRandomPlayer() )
-- If a weapon type was returned then
if ( weaponType ) then
outputChatBox ( "someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
end
</syntaxhighlight>
</section>

==See Also==
{{Client_ped_functions}}

FileGetSize

2016-01-22T00:08:00Z

NOki:

__NOTOC__
{{Server client function}}

Returns the total size in bytes of the given file.

==Syntax==
<syntaxhighlight lang="lua">
int fileGetSize ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:getSize|size}}

===Required Arguments===
*'''theFile:''' the file handle you wish to get the size of.

===Returns===
Returns the file size if successful, or ''false'' if an error occured (e.g. an invalid file handle was passed).

==Example==
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
local size = fileGetSize(newFile) -- get size
if size then
outputChatBox("Size of test.txt is: "..size, source) -- output size
end
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight>

==See Also==
{{File functions}}

OnColShapeHit

2016-01-09T08:23:54Z

NOki:

__NOTOC__
{{Server event}}
This event is triggered when a physical [[element]] hits a [[colshape]].

'''NOTE''': The hit won't be detected if the [[element]] that entered the colshape is a colshape.
==Parameters==
<syntaxhighlight lang="lua">
element hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': the [[element]] that entered the colshape.
*'''matchingDimension''': a boolean referring to whether the hit collision shape was in the same dimension as the element.

==Source==
The [[event system#Event source|source]] of this event is the [[colshape]] that got hit by a player or vehicle.

==Example==
This example creates a hill area for a ''King of the hill'' gamemode. When a player enters or leaves the area, it's announced in the chatbox.
<syntaxhighlight lang="lua">
-- create our hill area for our gamemode
local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 )

-- add hill_Enter as a handler for when a player enters the hill area
function hill_Enter ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that entered was player
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--announce to everyone that the player entered the hill
outputChatBox ( nameOfThePlayer.." entered the zone!", getRootElement(), 255, 255, 109 )
end
end
addEventHandler ( "onColShapeHit", hillArea, hill_Enter )

-- add hill_Enter as a handler for when a player leaves the hill area
function hill_Exit ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that left was player
--check if the player is not dead
if isPlayerDead ( thePlayer ) ~= true then
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--if he was alive, announce to everyone that the player has left the hill
outputChatBox ( nameOfThePlayer.." left the zone!", getRootElement(), 255, 255, 109 )
end
end
end
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )
</syntaxhighlight>

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

SetControlState

2016-01-08T13:01:22Z

NOki:

{{Server client function}}
__NOTOC__
Sets a state of a specified player's control, as if they pressed or released it.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool setControlState ( player thePlayer, string control, bool state ) </syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player you wish to set the control state of.
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
*'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool setControlState ( string control, bool state ) </syntaxhighlight>
===Required Arguments===
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
*'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
</section>

===Returns===
Returns ''true'' if the control state was successfully set, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
toggleControl ( source, "accelerate", false ) -- disable the accelerate key
toggleControl ( source, "brake_reverse", false ) -- disable the brake_reverse key
toggleControl ( source, "handbrake", false ) -- disable the handbrake key
setControlState ( source, "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), onPlayerEnterVehicle )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
<syntaxhighlight lang="lua">

function onClientPlayerEnterVehicle ( theVehicle, seat, jacked )
toggleControl ( "accelerate", false ) -- disable the accelerate key
toggleControl ( "brake_reverse", false ) -- disable the brake_reverse key
toggleControl ( "handbrake", false ) -- disable the handbrake key
setControlState ( "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onClientPlayerVehicleEnter", getRootElement(), onClientPlayerEnterVehicle )
</syntaxhighlight>
</section>

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

CreateBlipAttachedTo

2016-01-03T09:53:11Z

NOki: Changed : to . because this is a static function.

__NOTOC__
{{Server client function}}
This function creates a [[blip]] that is attached to an [[element]]. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255, int ordering=0, float visibleDistance=99999.0, visibleTo = getRootElement()] )
</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]].createAttachedTo||}}

===Required Arguments===
*'''elementToAttachTo:''' The [[element]] to attach the marker to.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default value is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible (0 - 65535)
}}
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0,
int a=255, int ordering=0, float visibleDistance=99999.0] )
</syntaxhighlight>

===Required Arguments===
*'''elementToAttachTo:''' The [[element]] to attach the marker to.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. 'Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible
}}
</section>

===Returns===
Returns a [[blip]] if the blip was created succesfully, or ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player.
<syntaxhighlight lang="lua">
-- Pick a random player
function setupRandomRobber ()
local myPlayer = getRandomPlayer ()
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
local myBlip = createBlipAttachedTo ( myPlayer, 52 )
end
</syntaxhighlight>
</section>

==See Also==
{{Blip_functions}}

OnClientGUITabSwitched

2015-12-23T23:40:34Z

NOki:

{{Client event}}
__NOTOC__
This event is triggered each time the user switch from GUI tab.

==Parameters==
<syntaxhighlight lang="lua">
element theElement
</syntaxhighlight>
* '''theElement''': The tab which was selected.

==Source==
The [[event system#Event source|source]] of this event is the tab.

==Example==
This example creates a window with a tabpanel with two tabs. Every time a user changes tabpage a notification will be shown.

First we'll create the window. Then add a tabpanel and couple tabs with some labels in them. Qoute: [[GuiCreateWindow#Example]]
<syntaxhighlight lang="lua">
local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true ) -- create a window which has "Information" in the title bar.
local tabPanel = guiCreateTabPanel ( 0, 0.1, 1, 1, true, myWindow ) -- create a tab panel which fills the whole window
local tabMap = guiCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = guiCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'

-- adds a label (text) to each tab
guiCreateLabel( 0.02, 0.04, 0.94, 0.2, "This is information about the current map", true, tabMap )
guiCreateLabel( 0.02, 0.04, 0.94, 0.92, "This is help text.", true, tabHelp )
</syntaxhighlight>

Now let's add the event handler.
<syntaxhighlight lang="lua">

function OnChange(selectedTab)
-- If there is a selected tab.
if selectedTab ~= nil then
outputChatBox( "You've changed your active tab." )
end
end

addEventHandler("onClientGUITabSwitched", root, OnChange)
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

HasObjectPermissionTo

2015-12-20T23:06:47Z

NOki: /* Syntax */

__NOTOC__
{{Server function}}
This function returns whether or not the given object has access to perform the given action.
{{Note|Only certain action names work. This function seems to return ''nil'' and output a bad argument error when checking if an object has rights for an action which doesn't start with ''function.'', ''command.'' or ''resource.'' keywords.}}

Scripts frequently wish to limit access to features to particular users. The naïve way to do this would be to check if the player who is attempting to perform an action is in a particular group (usually the Admin group). The main issue with doing this is that the Admin group is not guaranteed to exist. It also doesn't give the server admin any flexibility. He might want to allow his 'moderators' access to the function you're limiting access to, or he may want it disabled entirely.

This is where using the ACL properly comes in, and luckily this is very easy. It all comes down to using this function. This, somewhat confusingly named function lets you check if an ACL object (a player or a resource) has a particular ACL right. In this case, we just care about players.

So, first of all, think of a name for your 'right'. Let's say we want a private area only certain people can go in, we'll call our right accessPrivateArea. Then, all you need to do is add one 'if' statement to your code:
<syntaxhighlight lang="lua">if hasObjectPermissionTo ( player, "resource.YourResourceName.accessPrivateArea", false ) then
-- Whatever you want to happen if they're allowed in
else
-- Whatever you want to happen if they aren't
end
</syntaxhighlight>

Notice that we've named the ''right'' using ''resource.YourResourceName.accessPrivateArea'' - this is just for neatness, so that the admin knows what resource the right belongs to. It's strongly advised you follow this convention. The ''false'' argument specifies the 'defaultPermission', false indicating that if the user hasn't had the right allowed or dissallowed (i.e. the admin hasn't added it to the config), that it should default to being not allowed.

The only downside of using this method is that the admin has to modify his config. The upsides are that the admin has much more control and your script will work for any server, however the admin has configured it.

==Syntax==
<syntaxhighlight lang="lua">
bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )
</syntaxhighlight>

{{OOP|This function is also a static function underneath the ACL class.|[[ACL]].hasObjectPermissionTo||}}
===Required Arguments===
*'''theObject:''' The object to test if has permission to. This can be a client element (ie. a player), a resource or a string in the form "user.<name>" or "resource.<name>".
*'''theAction:''' The action to test if the given object has access to. Ie. "function.kickPlayer".

===Optional Arguments===
{{OptionalArg}}
*'''defaultPermission:''' The default permission if none is specified in either of the groups the given object is a member of. If this is left to true, the given object will have permissions to perform the action unless the opposite is explicitly specified in the [[ACL]]. If false, the action will be denied by default unless explicitly approved by the [[Access Control List]].

===Returns===
Returns ''true'' if the given object has permission to perform the given action, ''false'' otherwise. Returns ''nil'' if the function failed because of bad arguments.

==Example==
This example kicks a player if the user using it has access to the kickPlayer function.
<syntaxhighlight lang="lua">
-- Kick command
function onKickCommandHandler ( playerSource, commandName, playerToKick, stringReason )
-- Does the calling user have permission to kick the player? Default
-- to false for safety reasons. We do this so any user can't use us to
-- kick players.
if ( hasObjectPermissionTo ( playerSource, "function.kickPlayer", false ) ) then

-- Do we have permission to kick the player? We do this so we can fail
-- nicely if this resource doesn't have access to call that function.
if ( hasObjectPermissionTo ( getThisResource (), "function.kickPlayer", true ) ) then
-- Kick him
kickPlayer ( playerToKick, playerSource, stringReason )
else
-- Resource doesn't have any permissions, sorry
outputChatBox ( "kick: The admin resource is not able to kick players. Please give this resource access to 'function.kickPlayer' in the ACL to use this function.", playerSource )
end
else
-- User doesn't have any permissions
outputChatBox ( "kick: You don't have permissions to use this command.", playerSource )
end
end
addCommandHandler ( "kick", onKickCommandHandler )
</syntaxhighlight>

==See Also==

{{ACL_functions}}

OnClientFileDownloadComplete

2015-12-18T10:54:38Z

NOki:

{{Client event}}
{{New items|3.0140|1.4|
__NOTOC__
This event is triggered when a file has been downloaded after [[downloadFile]] has been successfully called.
}}
==Parameters==
<syntaxhighlight lang="lua">
string fileName, bool success
</syntaxhighlight>

*'''fileName''': the file downloaded.
*'''success''': whether successful or not.

==Source==
The [[event system#Event source|source]] of this event is the [[root element]] of the resource that called [[downloadFile]].

==Example==
This example plays a sound if it was downloaded successfully
<syntaxhighlight lang="lua">
function onDownloadFinish ( file, success )
if ( source == resourceRoot ) then -- if the file relates to this resource
if ( success ) then -- if the file was downloaded successfully
if ( file == "test.mp3" ) then -- if the file name is what we were expecting
currentTrack = playSound ( "test.mp3" )
end
else -- if the file wasn't downloaded successfully
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
end
addEventHandler ( "onClientFileDownloadComplete", root, onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

CreateWeapon

2015-12-15T12:40:53Z

NOki: /* Returns */

__NOTOC__
{{Client function}}
Creates a [[Element/Weapon|custom weapon]] that can fire bullets. '''Do not confuse this with player held weapons'''.
{{Tip|Some weapons (such as the minigun) visually point to a slightly different direction to where they fire. To adjust this, use [[setWeaponProperty]] with 'fire_rotation'. See the example below.}}

==Syntax==
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight>
{{OOP||[[Element/Weapon|Weapon]]}}

===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 [[Element/Weapon|custom weapon]] element, which represents a weapon floating at that position.

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

==Example==
This example adds a ''/createminigun'' command to create a weapon that is always firing.
<syntaxhighlight lang="lua">
function createMinigunWeapon()
-- Create the weapon 1 meter above the player
local x, y, z = getElementPosition(getLocalPlayer())
local weapon = createWeapon("minigun", x, y, z + 1)
-- Give it some ammo and fire it
setWeaponClipAmmo(weapon, 99999)
setWeaponState(weapon, "firing")

-- Optionally adjust for model rotation (this value will be different for other weapons)
setWeaponProperty(weapon, "fire_rotation", 0, -30, 0)
end
addCommandHandler("createminigun", createMinigunWeapon)
</syntaxhighlight>

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

GetKeyState

2015-12-09T04:05:54Z

NOki:

__NOTOC__
{{Client function}}
This function determines if a certain key is pressed or not.

'''Note:''' 'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr

==Syntax==
<syntaxhighlight lang="lua">
bool getKeyState ( string keyName )
</syntaxhighlight>

===Required Arguments===
*'''keyName:''' The name of the key you're checking state of. See [[Key names]].

===Returns===
Returns ''true'' if the specified key is pressed, ''false'' if it isn't or if an invalid key name is passed.

==Example==
This clientside example prints a message when "p" is pressed, and a different one for the "control+p" combination.
<syntaxhighlight lang="lua">
-- define a function that outputs a message if control is pressed, and a different one if it isn't
function printMessageFunction()
-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
if getKeyState( "lctrl" ) == true or getKeyState( "rctrl" ) == true then
outputChatBox ( "You have pressed 'control+p'." )
-- if none of those were pressed, he just pressed the "p" key
else
outputChatBox ( "You have pressed 'p'." )
end
end
-- bind the "p" key to our function
bindKey( "p", "down", "Print message", printMessageFunction )
</syntaxhighlight>

==See Also==
{{Client_input_functions}}

Installing and Running MTASA Server on GNU Linux

2015-12-09T01:57:27Z

NOki: /* Main binary */

== Installation ==

=== Main binary ===
Download the latest stable Linux binaries from here:
rm multitheftauto_linux-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/151/multitheftauto_linux-{{Current Version|full}}.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux-{{Current Version|full}}.tar.gz

=== Default config ===
Download the default config files:
rm baseconfig-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/151/baseconfig-{{Current Version|full}}.tar.gz

Unpack and move into the deathmatch directory:<br/>
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig-{{Current Version|full}}.tar.gz
mv baseconfig/* multitheftauto_linux-{{Current Version|full}}/mods/deathmatch

Change to the MTA server install directory:
cd multitheftauto_linux-{{Current Version|full}}

=== Test ===
You can now test if the server will start correctly:
./mta-server
or if using the 64 bit server:
./mta-server64

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from http://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
<br/>
'''Make sure you are in the MTA server install directory when following this example:'''
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm mtasa-resources-latest.zip
wget <nowiki>http</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
rm mtasa-resources-latest.zip

== Running with 32 or 64 bit Linux==
=== Make sure your server libraries and stuff are up to date ===
On Debian/Ubuntu this is done with:
apt-get update
apt-get upgrade

== Running with 32 bit Linux ==
===32 bit Troubleshooting===
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libreadline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

== Running with 64 bit Linux ==
===Debian 7 (wheezy) 64 bit===
Before running MTASA Server, use this command line for installation of 32 bit libs :<br/>

apt-get install lib32ncursesw5 lib32readline5

===Install 32 bit libs for your 64 bit distro===
For 64 bit Debian 6, this is achieved with:<br/>
''(Some 64 bit distros have 32 bit libs already installed for you. So this step might not be required)''

apt-get install ia32-libs

===64 bit Troubleshooting===
====64 bit Debian/Ubuntu====
* If you get a problem with such as "libstdc++.so.6: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32stdc++6

* If you get a problem with such as "libz.so.1: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32z1

* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32readline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32ncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

** If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

**NOTE: If you are running the experimental MTA x64 server, you will need [http://nightly.mtasa.com/files/x64/libmysqlclient.so.16 this file] instead:

====64 bit CentOS 6====
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", edit '''''/etc/yum.conf''''' and add this line:
multilib_policy=all
Then issue this command:
yum install compat-readline5
* Further 64 bit solutions can be found [http://forum.mtasa.com/viewtopic.php?f=106&t=35328#p367282 on the forums]

== MySQL Troubleshooting==
* If you are using the inbuild MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* If you can't get '''libmysqlclient.so.16''' installed by conventional means, then try [http://nightly.mtasa.com/files/libmysqlclient.so.16 downloading the file from here] and copying it to your Linux server '''/usr/lib/''' directory.

==Cent OS Troubleshooting==
* If you are using Cent OS and you get something like /usr/lib/libstdc++.so.6: version `GLIBCXX_3.4.9' not found (required by xmll.so) this can be resolved by doing downloading the archive [[http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/9/Fedora/i386/os/Packages/libstdc++-4.3.0-8.i386.rpm here]] and unpacking it with the following command:

rpm2cpio libstdc++-4.3.0-8.i386.rpm | cpio -i --make-directories

==[Optional] Installing and Configuring an External Web Server==
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]

== Server crashes ==

If your Linux server crashes, please obtain a backtrace and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace:====
===Do you have a core dump file in the the MTA server directory?===
It's usually called 'core', and usually over 100MB, and looks something like this:
[[Image:Core.png]]
====If you have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA install directory do this command
gdb mta-server -c core
*When gdb launches, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

====If you do not have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a crash. (Ignore any weird screen output in the meantime)
*When a crash occurs, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

== '''Server freezes''' ==

If your Linux server freezes, please obtain a backtrace with thread information and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace with thread information:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a freeze. (Ignore any weird screen output in the meantime)
*When a freeze occurs, press ctrl-c to start gdb
*Then do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*And then this command to get thread information:
info threads
*Save the output
*(To exit gdb, use the quit command)

Installing and Running MTASA Server on GNU Linux

2015-12-09T01:57:17Z

NOki: /* Default config */

== Installation ==

=== Main binary ===
Download the latest stable Linux binaries from here:
rm multitheftauto_linux-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/15/multitheftauto_linux-{{Current Version|full}}.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux-{{Current Version|full}}.tar.gz

=== Default config ===
Download the default config files:
rm baseconfig-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/151/baseconfig-{{Current Version|full}}.tar.gz

Unpack and move into the deathmatch directory:<br/>
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig-{{Current Version|full}}.tar.gz
mv baseconfig/* multitheftauto_linux-{{Current Version|full}}/mods/deathmatch

Change to the MTA server install directory:
cd multitheftauto_linux-{{Current Version|full}}

=== Test ===
You can now test if the server will start correctly:
./mta-server
or if using the 64 bit server:
./mta-server64

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from http://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
<br/>
'''Make sure you are in the MTA server install directory when following this example:'''
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm mtasa-resources-latest.zip
wget <nowiki>http</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
rm mtasa-resources-latest.zip

== Running with 32 or 64 bit Linux==
=== Make sure your server libraries and stuff are up to date ===
On Debian/Ubuntu this is done with:
apt-get update
apt-get upgrade

== Running with 32 bit Linux ==
===32 bit Troubleshooting===
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libreadline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

== Running with 64 bit Linux ==
===Debian 7 (wheezy) 64 bit===
Before running MTASA Server, use this command line for installation of 32 bit libs :<br/>

apt-get install lib32ncursesw5 lib32readline5

===Install 32 bit libs for your 64 bit distro===
For 64 bit Debian 6, this is achieved with:<br/>
''(Some 64 bit distros have 32 bit libs already installed for you. So this step might not be required)''

apt-get install ia32-libs

===64 bit Troubleshooting===
====64 bit Debian/Ubuntu====
* If you get a problem with such as "libstdc++.so.6: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32stdc++6

* If you get a problem with such as "libz.so.1: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32z1

* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32readline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32ncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

** If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

**NOTE: If you are running the experimental MTA x64 server, you will need [http://nightly.mtasa.com/files/x64/libmysqlclient.so.16 this file] instead:

====64 bit CentOS 6====
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", edit '''''/etc/yum.conf''''' and add this line:
multilib_policy=all
Then issue this command:
yum install compat-readline5
* Further 64 bit solutions can be found [http://forum.mtasa.com/viewtopic.php?f=106&t=35328#p367282 on the forums]

== MySQL Troubleshooting==
* If you are using the inbuild MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* If you can't get '''libmysqlclient.so.16''' installed by conventional means, then try [http://nightly.mtasa.com/files/libmysqlclient.so.16 downloading the file from here] and copying it to your Linux server '''/usr/lib/''' directory.

==Cent OS Troubleshooting==
* If you are using Cent OS and you get something like /usr/lib/libstdc++.so.6: version `GLIBCXX_3.4.9' not found (required by xmll.so) this can be resolved by doing downloading the archive [[http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/9/Fedora/i386/os/Packages/libstdc++-4.3.0-8.i386.rpm here]] and unpacking it with the following command:

rpm2cpio libstdc++-4.3.0-8.i386.rpm | cpio -i --make-directories

==[Optional] Installing and Configuring an External Web Server==
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]

== Server crashes ==

If your Linux server crashes, please obtain a backtrace and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace:====
===Do you have a core dump file in the the MTA server directory?===
It's usually called 'core', and usually over 100MB, and looks something like this:
[[Image:Core.png]]
====If you have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA install directory do this command
gdb mta-server -c core
*When gdb launches, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

====If you do not have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a crash. (Ignore any weird screen output in the meantime)
*When a crash occurs, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

== '''Server freezes''' ==

If your Linux server freezes, please obtain a backtrace with thread information and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace with thread information:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a freeze. (Ignore any weird screen output in the meantime)
*When a freeze occurs, press ctrl-c to start gdb
*Then do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*And then this command to get thread information:
info threads
*Save the output
*(To exit gdb, use the quit command)

OnClientPlayerChangeNick

2015-12-04T06:05:05Z

NOki: /* Example */

{{Client event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.

==Source==
The source of this event is the player that changed his nick

==Example==
This example snippet sends a lame message every time the local player changes his nick.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientPlayerChangeNick", getLocalPlayer(),
function ( oldNick, newNick )
outputChatBox ( "Hi " .. oldNick .. "! Oh... You're not " .. oldNick .. " anymore, are you?", 0, 255, 0 )
outputChatBox ( "I like your new name, " .. newNick .. "!", 0, 255, 0 )
end
)
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

GetVersion

2015-11-25T21:24:17Z

NOki: Made example code look nice. getPlayerSkin --> getElementModel

__NOTOC__
{{Server client function}}

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

''Note:'' Clientside will return the version from the player, and the server-sided will return version from the server.

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

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

==Example==
'''Example 1:''' This example will make a script compatible only with version 1.0:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function setHoboSkin(playerSource)
local version = getVersion()
if version.number < 256 then -- MTA 1.0 version number is 0x0100
setElementModel(playerSource, 137)
else
setElementModel(playerSource, 137)
end
end
addCommandHandler("hobo", setHoboSkin)
</syntaxhighlight>
</section>

'''Example 2:''' This client and server example will kick players that have anything earlier than the final released version of 1.0.3:
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function sendVersion()
-- Send local player version to the server
triggerServerEvent("onNotifyPlayerVersion", resourceRoot, getVersion())
end
addEventHandler("onClientResourceStart", resourceRoot, sendVersion)
</syntaxhighlight>
</section><section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function handlePlayerVersion(version)
if version.number > 256 + 3 then -- Allow anything above 1.0.3
return
end
if version.number == 256 + 3 then -- Check further if it is exactly 1.0.3
if version.type == "Release" then -- Check further if it is the "Release" type
local _, _, buildnumber = string.find(version.tag or "", "(%d)$") -- Extract the build number if there
buildnumber = tonumber(buildnumber) or 0
if buildnumber >= 9 then -- Allow 9 and above
return
end
end
end
outputConsole("Kicking player as below 1.0.3 Release build 9")
kickPlayer(client, "Upgrade your version at www.mtasa.com")
end
addEvent("onNotifyPlayerVersion", true)
addEventHandler("onNotifyPlayerVersion", resourceRoot, handlePlayerVersion)
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

Light

2015-10-26T11:49:37Z

NOki: Redirected page to Element/Light

#REDIRECT [[Element/Light]]

Light

2015-10-26T11:44:13Z

NOki: Redirected page to Https://wiki.multitheftauto.com/wiki/Element/Light

#REDIRECT [[https://wiki.multitheftauto.com/wiki/Element/Light]]

User:NOki

2015-10-01T07:06:58Z

NOki:

==Contributions==

- Addition of Tunisian flag to admin and admin2 [via GitHub].

GetVehicleColor

2015-09-08T11:15:40Z

NOki: Changed set to get (function name doesn't involving setting anything)

__NOTOC__
{{Server client function}}
This function returns the color of the specified vehicle. A vehicle can have up to four colors.

==Syntax==
<syntaxhighlight lang="lua">
int int int int getVehicleColor ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getColor}}
===Required Arguments===
*'''theVehicle:''' the [[vehicle]] element.

===Returns===
Returns 4 [[int|ints]] indicating the color of the vehicle. Returns ''false'' if the vehicle doesn't exist.

Valid color ids:
{{Vehicle_colors}}
<br>
{{New feature|3.0110|1.1|
From 1.1, as well as the above syntax, colors can also be retrieved as RGB values:
==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int, int, int, int, int, int, int, int = getVehicleColor ( vehicle theVehicle, bool bRGB )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the color of.
*'''bRGB :''' A boolean specifying whether to return RGB values. A setting of ''false'' will result in the function returning color ids instead.

===Returns===
*Returns 12 [[int|ints]] (if bRGB is ''true'') indicating the red, green and blue components of each of the 4 vehicle colors.
*Returns 4 [[int|ints]] (if bRGB is ''false'') indicating the color ids of each of the 4 vehicle colors.
*Returns ''false'' if the vehicle doesn't exist.

}}

==Example==
<section name="Server" class="server" show="true">
This will output the 4 colors of any car that the player enters.
<syntaxhighlight lang="lua">
function playerEnterVehicle ( theVehicle, seat, jacked )
-- Get the colors of the car and store them to 4 seperate variables
local color1, color2, color3, color4 = getVehicleColor ( theVehicle )
-- Output the four retrieved car colors into the chatbox
outputChatBox ( "Car color 1: " .. color1 )
outputChatBox ( "Car color 2: " .. color2 )
outputChatBox ( "Car color 3: " .. color3 )
outputChatBox ( "Car color 4: " .. color4 )
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), playerEnterVehicle )
</syntaxhighlight>
</section>

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

GetPedTarget

2015-09-05T15:02:48Z

NOki: /* Syntax */

__NOTOC__
{{Server client function}}
This function is used to get the element a [[ped]] is currently targeting.

==Syntax==
<syntaxhighlight lang="lua">
element getPedTarget ( ped thePed )
</syntaxhighlight>

{{OOP||[[ped]]:getTarget}}
===Required Arguments===
*'''thePed:''' The [[ped]] whose target you want to retrieve.

===Returns===
Returns the [[element]] that's being targeted, or ''false'' if there isn't one.

This is only effective on physical GTA elements, namely:
* Players
* Vehicles
* Objects

==Example==
<section name="Server" class="server" show="true">
This example blows up any vehicle a player targets (aims at).
<syntaxhighlight lang="lua">
function playerTargetCheck ( )
local target
for i, thePlayer in ipairs ( getElementsByType("player") ) do -- iterate over all players
target = getPedTarget ( thePlayer ) -- get the target of the current player
if ( target ) then -- if there was a target
if ( getElementType ( target ) == "vehicle" ) then -- and the target is a vehicle
blowVehicle ( target ) -- blow it up
end
end
end
end
setTimer ( playerTargetCheck, 1000, 0 ) -- call the check function every second
</syntaxhighlight>
''Note: A more efficient way to do this would be to use the [[onPlayerTarget]] event.''
</section>

==See Also==
{{Ped_functions}}

SetVehicleColor

2015-09-05T13:26:57Z

NOki: Corrected wrong OOP syntax

__NOTOC__
{{Server client function}}
This function will set the color of a vehicle. Colors are in RGB format, vehicles can have up to 4 colors. Most vehicles have 2 colors only.

{{New feature|3.0110|1.1|
==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int r1, int g1, int b1, [int r2, int g2, int b2, int r3, int g3, int b3, int r4, int g4, int b4] )
</syntaxhighlight>

{{OOP||[[vehicle]]:setColor}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''r1, g1, b1:''' Three integers indicating the red, green and blue components of the first (main) color for the vehicle
===Optional Arguments===
*'''r2, g2, b2:''' Three integers indicating the red, green and blue components of the second color for the vehicle
*'''r3, g3, b3:''' Three integers indicating the red, green and blue components of the third color for the vehicle
*'''r4, g4, b4:''' Three integers indicating the red, green and blue components of the fourth color for the vehicle
}}
===Returns===
Returns ''true'' if vehicle's color was set, ''false'' if an invalid vehicle or invalid colors were specified.

==Example==
<section name="Example 1" class="server" show="true">
This example implements a serverside ''random_color'' console command.
<syntaxhighlight lang="lua">
addCommandHandler( 'random_color',
function( uPlayer )
if isPedInVehicle( uPlayer ) then
local uVehicle = getPedOccupiedVehicle( uPlayer )
if uVehicle then
local r, g, b = math.random( 255 ), math.random( 255 ), math.random( 255 )
setVehicleColor( uVehicle, r, g, b )
end
end
end
)
</syntaxhighlight>
</section>

{{Warning|Informations below apply to MTA:SA v1.0.5 and older!|true}}

This function will set the color of a vehicle. Each vehicle can have up to 4 colors, for different aspects of the vehicle. Most vehicles only use two of the colors.
==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int color1, int color2, int color3, int color4 )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''color1:''' An integer indicating the first (main) color for the vehicle
*'''color2:''' An integer indicating the second color for the vehicle
*'''color3:''' An integer indicating the third color for the vehicle
*'''color4:''' An integer indicating the fourth color for the vehicle

The table below shows valid color ids:
{{Vehicle_colors}}
<br>
<section name="Example 1" class="server" show="false">
This example implements a serverside ''set_vehicle_color'' console command.
<syntaxhighlight lang="lua">
-- Define our function that will handle the command
function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )
-- If a player triggered this in-game
if ( playerSource ) then
-- Get the player's vehicle
playerVehicle = getPlayerOccupiedVehicle ( playerSource )
-- If the player is in a vehicle and we've got at least 1 parameter
if ( playerVehicle and col1 ) then
-- Get the vehicle's existing color and use it if fewer than 4 arguments were passed
exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )

if not col2 then col2 = exCol2 end
if not col3 then col3 = exCol3 end
if not col4 then col4 = exCol4 end

-- Set the vehicle's color
setVehicleColor ( playerVehicle, col1, col2, col3, col4 )
else
-- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text
outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )
outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )
outputConsole ( "You must be in a vehicle to use this function.", playerSource )
end
end
end

-- Register the command handler and attach it to the consoleSetVehicleColor function
addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="false">
This example changes all vehicles color to random every 0.5 sec.
<syntaxhighlight lang="lua">
function randomVehColors()
for i, car in ipairs( getElementsByType( "vehicle" ) ) do
local color = {}
color[1] = math.random(0,126) -- random from 0 to 126, because colors is from 0 to 126
color[2] = math.random(0,126)
color[3] = math.random(0,126)
color[4] = math.random(0,126) -- we take 4 random numbers because setVehicleColor have parameters with 4 colors
setVehicleColor ( car, color[1], color[2], color[3], color[4] ) -- setting color to vehicle
end
end

setTimer( randomVehColors, 500, 0 ) -- timer changes all vehicles colors to random every 0.5 sec.
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

SetVehicleColor

2015-09-05T13:26:00Z

NOki: Added OOP syntax

__NOTOC__
{{Server client function}}
This function will set the color of a vehicle. Colors are in RGB format, vehicles can have up to 4 colors. Most vehicles have 2 colors only.

{{New feature|3.0110|1.1|
==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int r1, int g1, int b1, [int r2, int g2, int b2, int r3, int g3, int b3, int r4, int g4, int b4] )
</syntaxhighlight>

{{OOP||[[vehicle]]:setVehicleColor}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''r1, g1, b1:''' Three integers indicating the red, green and blue components of the first (main) color for the vehicle
===Optional Arguments===
*'''r2, g2, b2:''' Three integers indicating the red, green and blue components of the second color for the vehicle
*'''r3, g3, b3:''' Three integers indicating the red, green and blue components of the third color for the vehicle
*'''r4, g4, b4:''' Three integers indicating the red, green and blue components of the fourth color for the vehicle
}}
===Returns===
Returns ''true'' if vehicle's color was set, ''false'' if an invalid vehicle or invalid colors were specified.

==Example==
<section name="Example 1" class="server" show="true">
This example implements a serverside ''random_color'' console command.
<syntaxhighlight lang="lua">
addCommandHandler( 'random_color',
function( uPlayer )
if isPedInVehicle( uPlayer ) then
local uVehicle = getPedOccupiedVehicle( uPlayer )
if uVehicle then
local r, g, b = math.random( 255 ), math.random( 255 ), math.random( 255 )
setVehicleColor( uVehicle, r, g, b )
end
end
end
)
</syntaxhighlight>
</section>

{{Warning|Informations below apply to MTA:SA v1.0.5 and older!|true}}

This function will set the color of a vehicle. Each vehicle can have up to 4 colors, for different aspects of the vehicle. Most vehicles only use two of the colors.
==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int color1, int color2, int color3, int color4 )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''color1:''' An integer indicating the first (main) color for the vehicle
*'''color2:''' An integer indicating the second color for the vehicle
*'''color3:''' An integer indicating the third color for the vehicle
*'''color4:''' An integer indicating the fourth color for the vehicle

The table below shows valid color ids:
{{Vehicle_colors}}
<br>
<section name="Example 1" class="server" show="false">
This example implements a serverside ''set_vehicle_color'' console command.
<syntaxhighlight lang="lua">
-- Define our function that will handle the command
function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )
-- If a player triggered this in-game
if ( playerSource ) then
-- Get the player's vehicle
playerVehicle = getPlayerOccupiedVehicle ( playerSource )
-- If the player is in a vehicle and we've got at least 1 parameter
if ( playerVehicle and col1 ) then
-- Get the vehicle's existing color and use it if fewer than 4 arguments were passed
exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )

if not col2 then col2 = exCol2 end
if not col3 then col3 = exCol3 end
if not col4 then col4 = exCol4 end

-- Set the vehicle's color
setVehicleColor ( playerVehicle, col1, col2, col3, col4 )
else
-- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text
outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )
outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )
outputConsole ( "You must be in a vehicle to use this function.", playerSource )
end
end
end

-- Register the command handler and attach it to the consoleSetVehicleColor function
addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="false">
This example changes all vehicles color to random every 0.5 sec.
<syntaxhighlight lang="lua">
function randomVehColors()
for i, car in ipairs( getElementsByType( "vehicle" ) ) do
local color = {}
color[1] = math.random(0,126) -- random from 0 to 126, because colors is from 0 to 126
color[2] = math.random(0,126)
color[3] = math.random(0,126)
color[4] = math.random(0,126) -- we take 4 random numbers because setVehicleColor have parameters with 4 colors
setVehicleColor ( car, color[1], color[2], color[3], color[4] ) -- setting color to vehicle
end
end

setTimer( randomVehColors, 500, 0 ) -- timer changes all vehicles colors to random every 0.5 sec.
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

GetVehicleType

2015-09-05T10:44:17Z

NOki: /* Required Arguments */

__NOTOC__
{{Server client function}}
{{New feature|3|1.0|
This function retrieves the type of a vehicle (such as if it is a car or a boat).
}}
==Syntax==
<syntaxhighlight lang="lua">
string getVehicleType ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getVehicleType|vehicleType}}
'''OR'''

<syntaxhighlight lang="lua">
string getVehicleType ( int modelId )
</syntaxhighlight>

===Required Arguments===
*'''vehicle:''' The vehicle element to get the type of.

'''OR'''

*'''modelID:''' A vehicle model ID

===Returns===
Returns a ''string'' with vehicle type or ''false'' if an invalid modelID has been supplied, or an empty string if the vehicle is blocked internally (some trailers).

Possible strings returned:
* '''Automobile''': Cars, vans and trucks
* '''Plane'''
* '''Bike''': Motorbikes
* '''Helicopter'''
* '''Boat'''
* '''Train'''
* '''Trailer''': A trailer for a truck
* '''BMX'''
* '''Monster Truck'''
* '''Quad''': Quadbikes

==Example==
'''Example 1:''' In this example when a player enters an airplane, it displays a message welcoming the player onboard.
<syntaxhighlight lang="lua">
function enterPlane(theVehicle, seat, jacked)
if (getVehicleType(theVehicle) == "Plane") then
outputChatBox("Welcome onboard!", source)
end
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enterPlane)
</syntaxhighlight>

'''Example 2:''' In this example player gets message what type of vehicle he just entered.
<syntaxhighlight lang="lua">
function enteredVehicleType(theVehicle, seat, jacked)
outputChatBox("You entered ".. getVehicleType(theVehicle) ..".", source)
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enteredVehicleType)
</syntaxhighlight>

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

ExecuteSQLQuery

2015-02-22T08:25:28Z

NOki:

__NOTOC__
{{Server function}}

This function executes an arbitrary SQL query and returns the result rows if there are any. It allows parameter binding for security (SQL injection is rendered impossible).

'''NOTE: This function only acts upon registry.db. Use dbQuery to query a custom SQL databse.'''

==Syntax==
<syntaxhighlight lang="lua">
table executeSQLQuery(string query [, var param1 [, var param2 ...]])
</syntaxhighlight>

===Required Arguments===
*'''query:''' An SQL query. Positions where parameter values will be inserted are marked with a "?".

===Optional Arguments===
*'''paramX:''' A variable number of parameters. These must be strings or numbers - it is important to make sure they are of the correct type. Also, the number of parameters passed must be equal to the number of "?" characters in the query string.
String parameters are automatically escaped by adding a backslash (\) before ' and \ characters.

===Returns===
Returns a table with the result of the query if it was a SELECT query, or ''false'' if otherwise. In case of a SELECT query the result table may be empty (if there are no result rows). The table is of the form:

<syntaxhighlight lang="lua">
{
{ colname1=value1, colname2=value2, ... },
{ colname1=value3, colname2=value4, ... },
...
}
</syntaxhighlight>

==Example==
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.

Example equivalents for executeSQLCreateTable:
<syntaxhighlight lang="lua">
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")
</syntaxhighlight>

Example equivalents for executeSQLDelete:
<syntaxhighlight lang="lua">
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)
</syntaxhighlight>

Example equivalents for executeSQLDropTable:
<syntaxhighlight lang="lua">
executeSQLQuery("DROP TABLE players" )
executeSQLQuery("DROP TABLE `players`" )
</syntaxhighlight>

Example equivalents for executeSQLSelect:
<syntaxhighlight lang="lua">
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )
</syntaxhighlight>

Example equivalents for executeSQLInsert:
<syntaxhighlight lang="lua">
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )
</syntaxhighlight>

Example equivalents for executeSQLUpdate:
<syntaxhighlight lang="lua">
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )
</syntaxhighlight>

This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.

<syntaxhighlight lang="lua">
function listPlayersWithMoreMoneyThan(thePlayer, command, amount)
local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))
outputConsole("Players with more money than " .. amount .. ":", thePlayer)
for i, playerdata in ipairs(players) do
outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)
end
end

addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)
</syntaxhighlight>

This example shows the amount of money a certain registered player has.

<syntaxhighlight lang="lua">
function showPlayerMoney(thePlayer, command, playerName)
local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)
if(#result == 0) then
outputConsole("No player named " .. playerName .. " is registered.", thePlayer)
else
outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)
end
end
addCommandHandler("playermoney", showPlayerMoney)
</syntaxhighlight>

Notice the lack of single quotes around the "?" in this example, even though it represents a string. executeSQLQuery will see that the playerName variable is a string and take care of the correct execution of the query by itself.

The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.

==See Also==
{{Registry_functions}}

ExecuteSQLQuery

2015-02-22T08:24:32Z

NOki:

__NOTOC__
{{Server function}}

This function executes an arbitrary SQL query and returns the result rows if there are any. It allows parameter binding for security (SQL injection is rendered impossible).

'''NOTE: This function only acts upon registry.db'''

==Syntax==
<syntaxhighlight lang="lua">
table executeSQLQuery(string query [, var param1 [, var param2 ...]])
</syntaxhighlight>

===Required Arguments===
*'''query:''' An SQL query. Positions where parameter values will be inserted are marked with a "?".

===Optional Arguments===
*'''paramX:''' A variable number of parameters. These must be strings or numbers - it is important to make sure they are of the correct type. Also, the number of parameters passed must be equal to the number of "?" characters in the query string.
String parameters are automatically escaped by adding a backslash (\) before ' and \ characters.

===Returns===
Returns a table with the result of the query if it was a SELECT query, or ''false'' if otherwise. In case of a SELECT query the result table may be empty (if there are no result rows). The table is of the form:

<syntaxhighlight lang="lua">
{
{ colname1=value1, colname2=value2, ... },
{ colname1=value3, colname2=value4, ... },
...
}
</syntaxhighlight>

==Example==
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.

Example equivalents for executeSQLCreateTable:
<syntaxhighlight lang="lua">
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")
</syntaxhighlight>

Example equivalents for executeSQLDelete:
<syntaxhighlight lang="lua">
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)
</syntaxhighlight>

Example equivalents for executeSQLDropTable:
<syntaxhighlight lang="lua">
executeSQLQuery("DROP TABLE players" )
executeSQLQuery("DROP TABLE `players`" )
</syntaxhighlight>

Example equivalents for executeSQLSelect:
<syntaxhighlight lang="lua">
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )
</syntaxhighlight>

Example equivalents for executeSQLInsert:
<syntaxhighlight lang="lua">
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )
</syntaxhighlight>

Example equivalents for executeSQLUpdate:
<syntaxhighlight lang="lua">
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )
</syntaxhighlight>

This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.

<syntaxhighlight lang="lua">
function listPlayersWithMoreMoneyThan(thePlayer, command, amount)
local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))
outputConsole("Players with more money than " .. amount .. ":", thePlayer)
for i, playerdata in ipairs(players) do
outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)
end
end

addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)
</syntaxhighlight>

This example shows the amount of money a certain registered player has.

<syntaxhighlight lang="lua">
function showPlayerMoney(thePlayer, command, playerName)
local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)
if(#result == 0) then
outputConsole("No player named " .. playerName .. " is registered.", thePlayer)
else
outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)
end
end
addCommandHandler("playermoney", showPlayerMoney)
</syntaxhighlight>

Notice the lack of single quotes around the "?" in this example, even though it represents a string. executeSQLQuery will see that the playerName variable is a string and take care of the correct execution of the query by itself.

The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.

==See Also==
{{Registry_functions}}

ExecuteSQLQuery

2015-02-22T08:23:55Z

NOki: Added registry.db information (http://forum.mtasa.com/viewtopic.php?f=91&t=85455#p774295)

__NOTOC__
{{Server function}}

This function executes an arbitrary SQL query and returns the result rows if there are any. It allows parameter binding for security (SQL injection is rendered impossible).
'''NOTE: This function only acts upon registry.db'''

==Syntax==
<syntaxhighlight lang="lua">
table executeSQLQuery(string query [, var param1 [, var param2 ...]])
</syntaxhighlight>

===Required Arguments===
*'''query:''' An SQL query. Positions where parameter values will be inserted are marked with a "?".

===Optional Arguments===
*'''paramX:''' A variable number of parameters. These must be strings or numbers - it is important to make sure they are of the correct type. Also, the number of parameters passed must be equal to the number of "?" characters in the query string.
String parameters are automatically escaped by adding a backslash (\) before ' and \ characters.

===Returns===
Returns a table with the result of the query if it was a SELECT query, or ''false'' if otherwise. In case of a SELECT query the result table may be empty (if there are no result rows). The table is of the form:

<syntaxhighlight lang="lua">
{
{ colname1=value1, colname2=value2, ... },
{ colname1=value3, colname2=value4, ... },
...
}
</syntaxhighlight>

==Example==
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.

Example equivalents for executeSQLCreateTable:
<syntaxhighlight lang="lua">
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")
</syntaxhighlight>

Example equivalents for executeSQLDelete:
<syntaxhighlight lang="lua">
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)
</syntaxhighlight>

Example equivalents for executeSQLDropTable:
<syntaxhighlight lang="lua">
executeSQLQuery("DROP TABLE players" )
executeSQLQuery("DROP TABLE `players`" )
</syntaxhighlight>

Example equivalents for executeSQLSelect:
<syntaxhighlight lang="lua">
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )
</syntaxhighlight>

Example equivalents for executeSQLInsert:
<syntaxhighlight lang="lua">
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )
</syntaxhighlight>

Example equivalents for executeSQLUpdate:
<syntaxhighlight lang="lua">
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )
</syntaxhighlight>

This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.

<syntaxhighlight lang="lua">
function listPlayersWithMoreMoneyThan(thePlayer, command, amount)
local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))
outputConsole("Players with more money than " .. amount .. ":", thePlayer)
for i, playerdata in ipairs(players) do
outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)
end
end

addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)
</syntaxhighlight>

This example shows the amount of money a certain registered player has.

<syntaxhighlight lang="lua">
function showPlayerMoney(thePlayer, command, playerName)
local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)
if(#result == 0) then
outputConsole("No player named " .. playerName .. " is registered.", thePlayer)
else
outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)
end
end
addCommandHandler("playermoney", showPlayerMoney)
</syntaxhighlight>

Notice the lack of single quotes around the "?" in this example, even though it represents a string. executeSQLQuery will see that the playerName variable is a string and take care of the correct execution of the query by itself.

The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.

==See Also==
{{Registry_functions}}

Installing and Running MTASA Server on GNU Linux

2015-02-15T04:38:59Z

NOki: /* Default config */

== Installation ==

=== Main binary ===
Download the latest stable Linux binaries from here:
rm multitheftauto_linux-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/141/multitheftauto_linux-{{Current Version|full}}.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux-{{Current Version|full}}.tar.gz

=== Default config ===
Download the default config files:
rm baseconfig-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/141/baseconfig-{{Current Version|full}}.tar.gz

Unpack and move into the deathmatch directory:<br/>
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig-{{Current Version|full}}.tar.gz
mv baseconfig/* multitheftauto_linux-{{Current Version|full}}/mods/deathmatch


=== Test ===
You can now test if the server will start correctly, by entering the install directory:
cd multitheftauto_linux-{{Current Version|full}}

and launching:
./mta-server

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from http://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
For example:
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm mtasa-resources-latest.zip
wget <nowiki>http</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
rm mtasa-resources-latest.zip

== Running with 32 or 64 bit Linux==
=== Make sure your server libraries and stuff are up to date ===
On Debian/Ubuntu this is done with:
apt-get update
apt-get upgrade

== Running with 32 bit Linux ==
===32 bit Troubleshooting===
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libreadline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

== Running with 64 bit Linux ==
===Debian 7 (wheezy) 64 bit===
Before running MTASA Server, use this command line for installation of 32 bit libs :<br/>

apt-get install lib32ncursesw5 lib32readline5

===Install 32 bit libs for your 64 bit distro===
For 64 bit Debian 6, this is achieved with:<br/>
''(Some 64 bit distros have 32 bit libs already installed for you. So this step might not be required)''

apt-get install ia32-libs

===64 bit Troubleshooting===
====64 bit Debian/Ubuntu====
* If you get a problem with such as "libstdc++.so.6: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32stdc++6

* If you get a problem with such as "libz.so.1: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32z1

* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32readline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32ncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

** If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

**NOTE: If you are running the experimental MTA x64 server, you will need [http://nightly.mtasa.com/files/x64/libmysqlclient.so.16 this file] instead:

====64 bit CentOS 6====
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", edit '''''/etc/yum.conf''''' and add this line:
multilib_policy=all
Then issue this command:
yum install compat-readline5
* Further 64 bit solutions can be found [http://forum.mtasa.com/viewtopic.php?f=106&t=35328#p367282 on the forums]

== MySQL Troubleshooting==
* If you are using the inbuild MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* If you can't get '''libmysqlclient.so.16''' installed by conventional means, then try [http://nightly.mtasa.com/files/libmysqlclient.so.16 downloading the file from here] and copying it to your Linux server '''/usr/lib/''' directory.

==Cent OS Troubleshooting==
* If you are using Cent OS and you get something like /usr/lib/libstdc++.so.6: version `GLIBCXX_3.4.9' not found (required by xmll.so) this can be resolved by doing downloading the archive [[http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/9/Fedora/i386/os/Packages/libstdc++-4.3.0-8.i386.rpm here]] and unpacking it with the following command:

rpm2cpio libstdc++-4.3.0-8.i386.rpm | cpio -i --make-directories

==[Optional] Installing and Configuring an External Web Server==
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]

== Server crashes ==

If your Linux server crashes, please obtain a backtrace and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace:====
===Do you have a core dump file in the the MTA server directory?===
It's usually called 'core', and usually over 100MB, and looks something like this:
[[Image:Core.png]]
====If you have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA install directory do this command
gdb mta-server -c core
*When gdb launches, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

====If you do not have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a crash. (Ignore any weird screen output in the meantime)
*When a crash occurs, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

== '''Server freezes''' ==

If your Linux server freezes, please obtain a backtrace with thread information and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace with thread information:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a freeze. (Ignore any weird screen output in the meantime)
*When a freeze occurs, press ctrl-c to start gdb
*Then do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*And then this command to get thread information:
info threads
*Save the output
*(To exit gdb, use the quit command)

Installing and Running MTASA Server on GNU Linux

2015-02-15T04:38:04Z

NOki: /* Main binary */

== Installation ==

=== Main binary ===
Download the latest stable Linux binaries from here:
rm multitheftauto_linux-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/141/multitheftauto_linux-{{Current Version|full}}.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux-{{Current Version|full}}.tar.gz

=== Default config ===
Download the default config files:
rm baseconfig-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/140/baseconfig-{{Current Version|full}}.tar.gz

Unpack and move into the deathmatch directory:<br/>
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig-{{Current Version|full}}.tar.gz
mv baseconfig/* multitheftauto_linux-{{Current Version|full}}/mods/deathmatch


=== Test ===
You can now test if the server will start correctly, by entering the install directory:
cd multitheftauto_linux-{{Current Version|full}}

and launching:
./mta-server

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from http://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
For example:
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm mtasa-resources-latest.zip
wget <nowiki>http</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
rm mtasa-resources-latest.zip

== Running with 32 or 64 bit Linux==
=== Make sure your server libraries and stuff are up to date ===
On Debian/Ubuntu this is done with:
apt-get update
apt-get upgrade

== Running with 32 bit Linux ==
===32 bit Troubleshooting===
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libreadline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

== Running with 64 bit Linux ==
===Debian 7 (wheezy) 64 bit===
Before running MTASA Server, use this command line for installation of 32 bit libs :<br/>

apt-get install lib32ncursesw5 lib32readline5

===Install 32 bit libs for your 64 bit distro===
For 64 bit Debian 6, this is achieved with:<br/>
''(Some 64 bit distros have 32 bit libs already installed for you. So this step might not be required)''

apt-get install ia32-libs

===64 bit Troubleshooting===
====64 bit Debian/Ubuntu====
* If you get a problem with such as "libstdc++.so.6: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32stdc++6

* If you get a problem with such as "libz.so.1: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32z1

* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32readline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 64 bit Debian/Ubuntu by doing this:

apt-get install lib32ncursesw5

* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

** If that fails, download [http://nightly.mtasa.com/files/libmysqlclient.so.16 libmysqlclient.so.16] and put it in '''/usr/lib/'''

**NOTE: If you are running the experimental MTA x64 server, you will need [http://nightly.mtasa.com/files/x64/libmysqlclient.so.16 this file] instead:

====64 bit CentOS 6====
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", edit '''''/etc/yum.conf''''' and add this line:
multilib_policy=all
Then issue this command:
yum install compat-readline5
* Further 64 bit solutions can be found [http://forum.mtasa.com/viewtopic.php?f=106&t=35328#p367282 on the forums]

== MySQL Troubleshooting==
* If you are using the inbuild MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* If you can't get '''libmysqlclient.so.16''' installed by conventional means, then try [http://nightly.mtasa.com/files/libmysqlclient.so.16 downloading the file from here] and copying it to your Linux server '''/usr/lib/''' directory.

==Cent OS Troubleshooting==
* If you are using Cent OS and you get something like /usr/lib/libstdc++.so.6: version `GLIBCXX_3.4.9' not found (required by xmll.so) this can be resolved by doing downloading the archive [[http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/9/Fedora/i386/os/Packages/libstdc++-4.3.0-8.i386.rpm here]] and unpacking it with the following command:

rpm2cpio libstdc++-4.3.0-8.i386.rpm | cpio -i --make-directories

==[Optional] Installing and Configuring an External Web Server==
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]

== Server crashes ==

If your Linux server crashes, please obtain a backtrace and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace:====
===Do you have a core dump file in the the MTA server directory?===
It's usually called 'core', and usually over 100MB, and looks something like this:
[[Image:Core.png]]
====If you have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA install directory do this command
gdb mta-server -c core
*When gdb launches, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

====If you do not have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a crash. (Ignore any weird screen output in the meantime)
*When a crash occurs, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

== '''Server freezes''' ==

If your Linux server freezes, please obtain a backtrace with thread information and post a report on our [http://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace with thread information:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb mta-server -ex "set print thread-events off" --eval-command run
*Now wait for a freeze. (Ignore any weird screen output in the meantime)
*When a freeze occurs, press ctrl-c to start gdb
*Then do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*And then this command to get thread information:
info threads
*Save the output
*(To exit gdb, use the quit command)

FileGetPos

2014-12-27T08:08:33Z

NOki: /* Syntax */

__NOTOC__
{{Server client function}}

Returns the current read/write position in the given file.

==Syntax==
<syntaxhighlight lang="lua"> int fileGetPos ( file theFile, bool readOnly ) </syntaxhighlight>

===Required Arguments===
*'''theFile:''' the file handle you wish to get the position of.
*'''readOnly:''' is file handled as read only.

===Returns===
Returns the file position if successful, or ''false'' if an error occured (e.g. an invalid handle was passed).

==Example==
This example opens the file test.txt and outputs its contents and current read position to the console.
<syntaxhighlight lang="lua">local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer.."Current Position: "..fileGetPos(hFile)) -- ... and output them to the console and outputs the current read position
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==See Also==
{{File functions}}

FileGetPos

2014-12-27T08:08:17Z

NOki: /* Required Arguments */

__NOTOC__
{{Server client function}}

Returns the current read/write position in the given file.

==Syntax==
<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>

===Required Arguments===
*'''theFile:''' the file handle you wish to get the position of.
*'''readOnly:''' is file handled as read only.

===Returns===
Returns the file position if successful, or ''false'' if an error occured (e.g. an invalid handle was passed).

==Example==
This example opens the file test.txt and outputs its contents and current read position to the console.
<syntaxhighlight lang="lua">local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer.."Current Position: "..fileGetPos(hFile)) -- ... and output them to the console and outputs the current read position
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==See Also==
{{File functions}}

FileGetPos

2014-12-27T08:08:02Z

NOki: /* Required Arguments */

__NOTOC__
{{Server client function}}

Returns the current read/write position in the given file.

==Syntax==
<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>

===Required Arguments===
*'''theFile:''' the file handle you wish to get the position of.
*'''readOnly:''' ''boolean'' is file handled as read only.

===Returns===
Returns the file position if successful, or ''false'' if an error occured (e.g. an invalid handle was passed).

==Example==
This example opens the file test.txt and outputs its contents and current read position to the console.
<syntaxhighlight lang="lua">local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer.."Current Position: "..fileGetPos(hFile)) -- ... and output them to the console and outputs the current read position
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==See Also==
{{File functions}}

FileGetPos

2014-12-27T08:07:35Z

NOki: /* Required Arguments */

GetElementHealth

2014-05-07T09:20:58Z

NOki: /* Example */

{{Server client function}}
__NOTOC__
This function returns the current health for the specified [[element]]. This can be a [[player]], a [[ped]], or a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
float getElementHealth ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[player]] or [[vehicle]] whose health you want to check.

===Returns===
Returns a float indicating the element's health, or ''false'' if invalid arguments were passed.

==Example==
<section name="Clientside example" class="client" show="true">
This example outputs the health of the player who enters the command 'showhealth', and their vehicle's health.
<syntaxhighlight lang="lua">
function showLocalHealth()
-- get the player's health and output it
local playerHealth = getElementHealth ( getLocalPlayer() )
outputChatBox ( "Your health: " .. playerHealth )

-- get the player's vehicle: if he is in one, output its health as well
local playerVehicle = getPedOccupiedVehicle ( getLocalPlayer() )
if playerVehicle then
local vehicleHealth = getElementHealth ( playerVehicle ) / 10 -- Divide this by 10, as default the denominator is 1000
outputChatBox ( "Your vehicle's health: " .. vehicleHealth )
end
end
addCommandHandler ( "showhealth", showLocalHealth )
</syntaxhighlight>
</section>

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

User:Noki

2014-04-14T04:17:12Z

NOki: Created page with "See [https://wiki.multitheftauto.com/wiki/User:NOki User:NOki]"

See [https://wiki.multitheftauto.com/wiki/User:NOki User:NOki]

GetPlayerPing

2014-04-14T02:24:12Z

NOki: /* Example */

__NOTOC__
{{Server client function}}
This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa.

==Syntax==
<syntaxhighlight lang="lua">int getPlayerPing ( player thePlayer )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose ping you want to determine.

===Returns===
Returns the ping as an [[int]], or ''false'' if the player is invalid.

==Example==
<section name="Server" class="server" show="true">
This example checks thePlayer's ping, and if it's over 500, kicks him/her.
<syntaxhighlight lang="lua">
function kickPing() -- Creates a function called kickPing
if (getPlayerPing(thePlayer) >= 500) then -- If thePlayer's ping is over 500
kickPlayer(thePlayer, "Ping over 500!") -- Kick them
end
end
setTimer(kickPing, 5000, 0) -- Every 5 seconds, the kickPing function is called.
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example checks the ping of every player entering the 'ping' command and warns him if it's over 100.
<syntaxhighlight lang="lua">
function checkPing()
local ping = getPlayerPing(getLocalPlayer()) -- get the ping from the source element (the player who joined)
if (ping > 100) then -- if it's higher than 100...
outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player
end
end
addCommandHandler("ping", checkPing)
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

SetPlayerMoney

2014-04-14T02:18:50Z

NOki: /* Example */

__NOTOC__
{{Server client function}}
Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.
{{Note|Using this function client side (not recommended) will not change a players money server side.}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( player thePlayer, int amount ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' Which player to set the money of.
*'''amount:''' A whole integer specifying the new amount of money the player will have.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( int amount ) </syntaxhighlight>

===Required Arguments===
*'''amount:''' A whole integer specifying the new amount of money the local player will have.
</section>

===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.

==Example==
'''Example 1:''' This example sets the player's money to the desired amount when he types "setcash" in console.
<syntaxhighlight lang="lua">
function setCash(thePlayer, command, amount) -- when the setcash function is called
setPlayerMoney(thePlayer, tonumber(amount)) -- change player's money to the desired amount
end
addCommandHandler("setcash", setCash) -- add a command handler for setcash
</syntaxhighlight>
'''Example 2:''' This sets all players the amount of 1337 money when "leet" is typed in console.
<syntaxhighlight lang="lua">
function leetmoney()
setPlayerMoney(root, 1337)
end
addCommandHandler("leet", leetmoney)
</syntaxhighlight>

==See Also==
{{Player functions}}

RenameResource

2014-04-14T02:12:51Z

NOki: /* Example */

__NOTOC__
{{Server function}}
This function renames a resource.

==Syntax==
<syntaxhighlight lang="lua">
bool renameResource ( string resourceName, string newResourceName, [ string organizationalPath ] )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of resource to rename.
*'''newResourceName:''' The name of what the resource should be renamed to.

===Optional Arguments===
*'''organizationalPath:''' If you want to store the new resource inside a category.

===Returns===
Returns ''true'' if the resource has been renamed successfully, ''false'' otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons. Won't work on a started resource or if the resource is not loaded (not known by MTA (use /refresh))

==Example==
This example renames the resource "reload" to "reload2":
<syntaxhighlight lang="lua">function renameReloadResource()
renameResource("reload", "reload2");
end
addEventHandler("onResourceStart", resourceRoot, renameReloadResource);
</syntaxhighlight>

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

==See Also==
{{Resource_functions}}

RenameResource

2014-04-14T02:12:19Z

NOki: /* Example */

__NOTOC__
{{Server function}}
This function renames a resource.

==Syntax==
<syntaxhighlight lang="lua">
bool renameResource ( string resourceName, string newResourceName, [ string organizationalPath ] )
</syntaxhighlight>

===Required Arguments===
*'''resourceName:''' The name of resource to rename.
*'''newResourceName:''' The name of what the resource should be renamed to.

===Optional Arguments===
*'''organizationalPath:''' If you want to store the new resource inside a category.

===Returns===
Returns ''true'' if the resource has been renamed successfully, ''false'' otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons. Won't work on a started resource or if the resource is not loaded (not known by MTA (use /refresh))

==Example==
This example renames the resource "reload" to "reload2":
<syntaxhighlight lang="lua">function renameReloadResource()
renameResource("reload", reload2");
end
addEventHandler("onResourceStart", resourceRoot, renameReloadResource);
</syntaxhighlight>

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

==See Also==
{{Resource_functions}}

User:NOki

2014-04-14T02:10:13Z

NOki: /* Contributions */

NOki, also known as Lewis Watson, is an avid MTA Lua scripter.
==Contributions==

None as of yet.

User:NOki

2014-04-14T02:09:25Z

NOki: Created page with "==Contributions== None as of yet."

==Contributions==

None as of yet.

GetTeamFromName

2014-04-11T07:28:18Z

NOki: /* Example */

{{Server client function}}
__NOTOC__
This function finds a team object by the team's name.

==Syntax==
<syntaxhighlight lang="lua">
team getTeamFromName ( string teamName )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string determining the name of the team you wish to find.

===Returns===
Returns the team object if it was found, ''false'' otherwise.

==Example==
This example creates a team, and sets the player's team to it's partial name:
<syntaxhighlight lang="lua">
-- Creates a red team
createTeam("Red", 255, 0, 0)

function joinRedTeam (source)
if (redteam) then -- If the team was successfully created
-- Sets the player's team by getting the partial name of the red team.
setPlayerTeam(client, getTeamFromName("Red"))
outputChatBox("You are now in the 'Red' team", source)
else
outputChatBox("Sorry, we can't set your team. An error occurred!", source)
end
end

--Add console command to join the team when 'joinTeam' is typed.
addCommandHandler("jointeam", joinRedTeam)
</syntaxhighlight>

==See Also==
{{Team_functions}}

CenterWindow

2014-04-11T07:23:23Z

NOki: /* Code */

{{Useful Function}}
__NOTOC__
This function center the window in any resolution.<br>
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">string centerWindow( element TheElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element you want to center it.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function centerWindow (center_window)
local screenW, screenH = guiGetScreenSize()
local windowW, windowH = guiGetSize(center_window, false)
local x, y = (screenW - windowW) /2,(screenH - windowH) /2
guiSetPosition(center_window, x, y, false)
end
</syntaxhighlight>
</section>

==Example==
This example center the window.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot, function()
myWindow = guiCreateWindow( 350, 100, 200, 250, "Window Title", false )
end )

addCommandHandler( "center", function()
if myWindow then
centerWindow( myWindow )
end
end )
</syntaxhighlight>

Author: laserlaser

==See Also==
{{Useful_Functions}}

GetPlayerFromNamePart

2014-04-10T06:26:42Z

NOki: moved GetPlayerFromNamePart to GetPlayerFromPartialName: Grammar needed fixing (heil grammar)!

#REDIRECT [[GetPlayerFromPartialName]]

GetPlayerFromPartialName

2014-04-10T06:26:42Z

NOki: moved GetPlayerFromNamePart to GetPlayerFromPartialName: Grammar needed fixing (heil grammar)!

{{Useful Function}}
__NOTOC__
This function allows you to get player from their partial name.

==Syntax==
<syntaxhighlight lang="lua">
player getPlayerFromPartialName ( string Name )
</syntaxhighlight>

===Required Arguments===
* '''Name''': A string containing the partial name of a player you want to reference.

===Returns===
Returns a [[player]] if the partial name exists, ''nil'' otherwise.

==Code==
<syntaxhighlight lang="lua">function getPlayerFromPartialName(name)
local name = name and name:gsub("#%x%x%x%x%x%x", ""):lower() or nil
if name then
for _, player in ipairs(getElementsByType("player")) do
local name_ = getPlayerName(player):gsub("#%x%x%x%x%x%x", ""):lower()
if name_:find(name, 1, true) then
return player
end
end
end
end</syntaxhighlight>

'''Author: TAPL'''

==See Also==
{{Useful_Functions}}

GetPlayerFromPartialName

2014-04-10T06:25:03Z

NOki: