Multi Theft Auto: Wiki - User contributions [en]

OnPlayerScreenShot

2012-01-20T16:47:07Z

Alberto Alonso:

__NOTOC__
{{Server event}}
This event is triggered when the screen capture requested by [[takePlayerScreenShot]] has completed.

==Parameters==
<syntaxhighlight lang="lua">
resource theResource, string status, string imageData, int timestamp, string tag
</syntaxhighlight>

*'''theResource''': The resource which called [[takePlayerScreenShot]]
*'''status''': The status of the event which can be one of three values:
**''"ok"'' - The image capture was successful and imageData will contain a JPEG image.
**''"disabled"'' - The image capture failed because the player has disabled screen uploads.
**''"minimized"'' - The image capture failed because the player has minimized the screen. (i.e. alt-tabbed)
*'''imageData''': A string which contains the JPEG image data. This can be saved with the file functions, or sent to players with triggerClientEvent or even -oh my god- uploaded to a web site.
*'''timestamp''': The server tick count when the capture was taken.
*'''tag''': The tag string passed to [[takePlayerScreenShot]].

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

==Example==
This example captures the screen of a random player every 2 seconds and shows it to everyone:

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
--------------------------------------------------
-- Take screen shot every 2 seconds
function doTakeScreenShot()
takePlayerScreenShot( getRandomPlayer(), 320, 200 )
end
setTimer(doTakeScreenShot, 2000, 0)

--------------------------------------------------
-- Receive screen shot result
addEventHandler( "onPlayerScreenShot", root,
function ( theResource, status, imageData, timestamp, tag )
triggerClientEvent( root, "onMyClientScreenShot", resourceRoot, imageData ) -- Relay to all players
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--------------------------------------------------
-- Turn image data into a texture at the client
addEvent("onMyClientScreenShot",true)
addEventHandler( "onMyClientScreenShot", resourceRoot,
function( imageData )
local newFile = fileCreate("temp.jpg")
fileWrite(newFile, imageData )
fileClose(newFile)
if image then
destroyElement(image)
end
image = dxCreateTexture( "temp.jpg" )
end
)

--------------------------------------------------
-- Show image
addEventHandler( "onClientRender", root,
function()
if image then
dxDrawImage( 100, 250, 320, 200, image )
end
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3|n/a|}}

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

Template:Server functions

2011-08-05T09:57:05Z

Alberto Alonso: Added setMaxPlayers to the list.

*[[addCommandHandler]]
*[[executeCommandHandler]]
*[[fromJSON]]
*[[getFPSLimit]]
*[[getMaxPlayers]]
*[[getServerHttpPort]]
*[[getServerName]]
*[[getServerPassword]]
*[[getServerPort]]
*[[getVersion]]
*[[isGlitchEnabled]]
*[[outputChatBox]]
*[[outputConsole]]
*[[outputDebugString]]
*[[outputServerLog]]
*[[removeCommandHandler]]
*[[setFPSLimit]]
*[[setGlitchEnabled]]
*[[setMaxPlayers]]
*[[setServerPassword]]
*[[showChat]]
*[[shutdown]]
*[[toJSON]]

OnVehicleStartExit

2011-06-08T10:49:37Z

Alberto Alonso: Introduced the new event parameter: door

__NOTOC__
{{Server event}}
This event is triggered when a player starts to exit a vehicle. This event can be used to cancel exit, if necessary.

==Parameters==
<syntaxhighlight lang="lua">
player exitingPlayer, int seat, player jacked, int door
</syntaxhighlight>

*'''exitingPlayer''': A player element representing the player who is starting to exit a vehicle
*'''seat''': An integer representing the seat in which the player is exiting from
*'''jacked''': A player element representing who is jacking
{{New feature|3.0110|1.1|
*'''door''': An integer representing the door that the player is using to leave.
}}

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] in which a player began to exit.

===Canceling===
If this event is [[Event system #Canceling|canceled]], the player will not exit the vehicle.

==Example==
This example locks a player inside a police vehicle if he is a policeman.
<syntaxhighlight lang="lua">
policeVehicles { [598]=true,[596]=true,[597]=true,[599]=true }
policeSkins { [280]=true,[281]=true,[282]=true,[283]=true,[284]=true,[285]=true,[286]=true }

function exitVehicle ( thePlayer, seat, jacked ) --when a player enters a vehicle
if ( policeVehicles[getVehicleID ( source )] ) and ( policeSkins[getPlayerSkin ( thePlayer )] ) then -- if the vehicle is one of 4 police cars, and the skin is a police skin
cancelEvent()
outputChatBox ( "You're the cop! Don't exit the car!", thePlayer ) --and tell the player why
end
end
addEventHandler ( "onVehicleStartExit", getRootElement(), exitVehicle ) -- add an event handler for onVehicleStartExit
</syntaxhighlight>

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

OnClientVehicleStartExit

2011-06-08T10:48:56Z

Alberto Alonso: Introduced the new event parameter: door

[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is triggered when a player starts exiting a vehicle. Once the exiting animation completes, [[onClientVehicleExit]] is triggered.

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer, int seat, int door
</syntaxhighlight>
*'''thePlayer:''' the player who started exiting the vehicle.
*'''seat:''' the number of the seat that the player was sitting on.
{{New feature|3.0110|1.1|
*'''door:''' the number of the door that the player is using to leave.
}}

==Source==
The source of this event is the vehicle that the player started to exit.

==Example==

<syntaxhighlight lang="lua">

</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

GetElementMatrix

2011-02-27T14:56:11Z

Alberto Alonso: /* Example */

{{Client function}}
__NOTOC__
This function gets an element's transform matrix. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.

==Syntax==
<syntaxhighlight lang="lua">
table getElementMatrix ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element which you wish to retrieve the matrix for

===Returns===
Returns a multi-dimensional array containing a 4x4 matrix.

==Example==
This example creates a utility function that gets the position that is in front of a specified player. Note that it assumes you have the [http://lua-users.org/wiki/LuaMatrix Lua Matrix] library installed.
<syntaxhighlight lang="lua">
function getPositionInFrontOfElement(element)
--Get the position 5 units in front
local transformed = matrix{0,5,0} * matrix(getElementMatrix(element))
--Get our offset components
local offX,offY,offZ = transformed[1][1],transformed[2][1],transformed[3][1]
--Return the transformed point
return offX, offY, offZ
end
</syntaxhighlight>

This example is exactly the same as above, but without using the Lua Matrix library.
<syntaxhighlight lang="lua">
function getPositionInFrontOfElement(element)
-- Get the matrix
local matrix = getElementMatrix ( element )
-- Get the transformation of a point 5 units in front of the element
local offX = 0 * matrix[1][1] + 5 * matrix[2][1] + 0 * matrix[3][1] + 1 * matrix[4][1]
local offY = 0 * matrix[1][2] + 5 * matrix[2][2] + 0 * matrix[3][2] + 1 * matrix[4][2]
local offZ = 0 * matrix[1][3] + 5 * matrix[2][3] + 0 * matrix[3][3] + 1 * matrix[4][3]
--Return the transformed point
return offX, offY, offZ
end
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

GetVehicleDoorOpenRatio

2011-01-16T21:09:52Z

Alberto Alonso: Created page with "__NOTOC__ {{Server client function}} This function gets the door open ratio on a vehicle. ==Syntax== <syntaxhighlight lang="lua"> float getVehicleDoorOpenRatio ( vehicle theVehicle, int door )..."

__NOTOC__
{{Server client function}}
This function gets the door open ratio on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
float getVehicleDoorOpenRatio ( vehicle theVehicle, int door )
</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to get the door open ratio of.
*'''door:''' An integer between 0 and 5 specifying the door you want to get the open ratio of.

==Returns==
Returns the door open ratio, or ''false'' if invalid arguments are passed.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "carshowoff", function ( playerSource )
local vehicle = getPedOccupiedVehicle ( playerSource )
if vehicle then
for i=0,5 do
setVehicleDoorOpenRatio ( vehicle, i, 1 - getVehicleDoorOpenRatio ( vehicle, i ), 2500 )
end
end
end )
</syntaxhighlight>

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

SetVehicleDoorOpenRatio

2011-01-16T21:07:02Z

Alberto Alonso: Created page with "__NOTOC__ {{Server client function}} This function sets the door open ratio on a vehicle. ==Syntax== <syntaxhighlight lang="lua"> bool setVehicleDoorOpenRatio ( vehicle theVehicle, int door, f..."

__NOTOC__
{{Server client function}}
This function sets the door open ratio on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDoorOpenRatio ( vehicle theVehicle, int door, float ratio [, int time ] )
</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to change the door open ratio of.
*'''door:''' An integer between 0 and 5 specifying the door you want to change open ratio of.
*'''ratio:''' The ratio value, ranging from 0 (fully closed) to 1 (fully open).

==Optional Arguments==
{{OptionalArg}}
*'''time:''' The time that the change will take. A value of 0 will change the door open ratio inmediately.

==Returns==
Returns ''true'' if the door open ratio was successfully set, ''false'' if invalid arguments are passed.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "carshowoff", function ( playerSource )
local vehicle = getPedOccupiedVehicle ( playerSource )
if vehicle then
for i=0,5 do
setVehicleDoorOpenRatio ( vehicle, i, 1 - getVehicleDoorOpenRatio ( vehicle, i ), 2500 )
end
end
end )
</syntaxhighlight>

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

Template:Client vehicle functions

2011-01-16T21:00:02Z

Alberto Alonso: get/setVehicleDoorOpenRatio

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleRotation]]
*[[getVehicleSirensOn]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleWheelStates]]
{{New feature|3.0110|1.1|
*[[getVehicleDoorOpenRatio]]
}}
*[[isVehicleDamageProof]]
*[[isVehicleFrozen]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[removeVehicleUpgrade]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFrozen]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehicleRotation]]
*[[setVehicleSirensOn]]
{{New feature|3.0110|1.1|
*[[setVehicleTurretPosition]]
*[[setVehicleDoorOpenRatio]]
}}
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[getHelicopterRotorSpeed]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleGravity]]
*[[getVehicleHeadLightColor]]
*[[getVehicleModelFromName]]
*[[getVehicleNameFromModel]]
*[[getVehicleType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleTaxiLightOn]]
*[[setHelicopterRotorSpeed]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleTaxiLightOn]]

Template:Vehicle functions

2011-01-16T20:59:12Z

Alberto Alonso: get/setVehicleDoorOpenRatio

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getVehicleColor ]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehicleRotation]]
*[[getVehicleSirensOn]]
*[[getVehiclesOfType]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleWheelStates]]
{{New feature|3.0110|1.1|
*[[getVehicleDoorOpenRatio]]
}}
*[[isVehicleDamageProof]]
*[[isVehicleFrozen]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[removeVehicleUpgrade]]
*[[resetVehicleExplosionTime]]
*[[resetVehicleIdleTime]]
*[[respawnVehicle]]
*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFrozen]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleIdleRespawnDelay]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehicleRespawnDelay]]
*[[setVehicleRespawnPosition]]
*[[setVehicleRotation]]
*[[setVehicleSirensOn]]
{{New feature|3.0110|1.1|
*[[setVehicleTurretPosition]]
*[[setVehicleDoorOpenRatio]]
}}
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[spawnVehicle]]
*[[toggleVehicleRespawn]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleHeadLightColor]]
*[[getVehicleModelFromName]]
*[[getVehicleNameFromModel]]
*[[getVehicleType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleTaxiLightOn]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
*[[setVehicleHeadLightColor]]
*[[setVehicleTaxiLightOn]]

User:Alberto Alonso

2011-01-13T15:55:41Z

Alberto Alonso:

{{MTA Developer}}

ryden's '''TODO''' list:
* Extend superman script to create Peter Petrelli script.
* <strike>Fix (rewrite) MTA wikibot.</strike>
* <strike>Pass all my exams</strike>
* Get a girlfriend

Modules/MTA-MySQL/mysql null

2011-01-05T18:08:28Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a MySQL null type. MySQL NULL and lua nil are different concepts, and a table row can contain NULL values. In this case, you must check the value comparing it to mysql_null.

==Syntax==
<syntaxhighlight lang="lua">
MySQLNullValue mysql_null ( )
</syntaxhighlight>

===Returns===
A MySQL NULL type.

===Example===
'''Example 1:''' This example checks if the name of an account is null.
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account WHERE id='1' LIMIT 1") -- Execute the query
if (mysql_result(result, 1, 1) == mysql_null()) then
outputDebugString("The name of the account #1 is null")
end
mysql_free_result(result) -- Free the result
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql free result

2011-01-05T18:08:09Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Frees the last query result. This function should be called after every query, specially when these queries return any data.

==Syntax==
<syntaxhighlight lang="lua">
mysql_free_result ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
This function doesn't return any value.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql result

2011-01-05T18:07:55Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string with the value of the given field with the given offsets, being these:
* '''row_offset''': An integer value between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_rows|mysql_num_rows()]]'''
* '''field_offset''': An integer value between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_fields|mysql_num_fields()]]'''
If the offset is invalid it returns nil.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_result ( MySQLResult result, int row_offset, int field_offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
A string with the data contained in the given offset.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql num rows

2011-01-05T18:06:58Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the number of rows in the given query result.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_num_rows ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
The number of rows in the given query result.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql num fields

2011-01-05T18:06:46Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the number of fields in the given query result.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_num_fields ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
The number of fields in the given query result.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql field tell

2011-01-05T18:06:31Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the current field cursor position in the last executed query.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_field_tell ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
The current field cursor position.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql field seek

2011-01-05T18:06:18Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Sets the field cursor of a result in the given field offset. The offset must be a value between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_fields|mysql_num_fields()]]'''.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_field_seek ( MySQLResult result, int offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result
* '''offset:''' A valid field offset

===Returns===
The previous field cursor.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql field name

2011-01-05T18:06:00Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the name of a given field in the last executed query. The offset of the field must be an integer between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_rows/mysql_num_fields|mysql_num_fields()]]'''

==Syntax==
<syntaxhighlight lang="lua">
int mysql_field_name ( MySQLResult result, int offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result
* '''offset:''' A valid offset

===Returns===
The given field name.

===Example===
'''Example 1:'''
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account WHERE id='1' LIMIT 1") -- Execute the query
if (result) then
local str = mysql_field_name(result, 1)
outputDebugString(str) -- Will print 'name'
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql field length

2011-01-05T18:05:43Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the length of a given field in the last retreived row. The offset of the field must be an integer between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_fields|mysql_num_fields()]]'''

==Syntax==
<syntaxhighlight lang="lua">
int mysql_field_length ( MySQLResult result, int offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result
* '''offset:''' A valid offset

===Returns===
The given field data length.

===Example===
'''Example 1:'''
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account WHERE id='1' LIMIT 1") -- Execute the query
if (result) then
local row = mysql_fetch_row(result)
local length = mysql_field_length(result, 1)
outputDebugString("The length of " .. row[1] .. " is " .. length)
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql rows assoc

2011-01-05T18:05:23Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Creates an iterator for the result associative rows. When this function is called, the row cursor is set to the first result row.

==Syntax==
<syntaxhighlight lang="lua">
iterator mysql_rows_assoc ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
An iterator function to iterate all the result rows in associative tables.

===Example===
'''Example 1:''' This example prints all the accounts names
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT * FROM account") -- Execute the query
if (result) then
for result,row in mysql_rows_assoc(result) do
outputDebugString(row["name"])
end
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql fetch assoc

2011-01-05T18:05:05Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns an associative table containing the current row of the last executed query. You can call this function repeatedly to retreive all the result rows. When there aren't more rows in the result it returns nil. You can go to a specific row calling [[Modules/MTA-MySQL/mysql_data_seek|mysql_data_seek()]]

==Syntax==
<syntaxhighlight lang="lua">
table mysql_fetch_assoc ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
An associative table with the current row

===Example===
'''Example 1:''' This example shows the name of all the registered accounts
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT * FROM account") -- Execute the query
if (result) then
while true do
local row = mysql_fetch_assoc(result)
if (not row) then break end

outputDebugString(row["name"])
end
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql rows

2011-01-05T18:04:36Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Creates an iterator for the result rows. When this function is called, the row cursor is set to the first result row.

==Syntax==
<syntaxhighlight lang="lua">
iterator mysql_rows ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
An iterator function to iterate all the result rows.

===Example===
'''Example 1:''' This example prints all the accounts names
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account") -- Execute the query
if (result) then
for result,row in mysql_rows(result) do
outputDebugString(row[1])
end
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql fetch row

2011-01-05T18:04:18Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a table containing the current row of the last executed query. You can call this function repeatedly to retreive all the result rows. When there aren't more rows in the result it returns nil. You can go to a specific row calling [[Modules/MTA-MySQL/mysql_data_seek|mysql_data_seek()]]

==Syntax==
<syntaxhighlight lang="lua">
table mysql_fetch_row ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
A table with the current row

===Example===
'''Example 1:''' This example shows the name of all the registered accounts
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account") -- Execute the query
if (result) then
while true do
local row = mysql_fetch_row(result)
if (not row) then break end

outputDebugString(row[1])
end
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql fetch lengths

2011-01-05T18:04:05Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a table containing the length of the values of the last retreived row. If you didn't retreive any row or you are in the end of the result set, it returns nil.

==Syntax==
<syntaxhighlight lang="lua">
table mysql_fetch_lengths ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
A table with the length of the values of the last retreived row.

===Example===
'''Example 1:''' This example shows the length of an account name
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account WHERE id='1' LIMIT 1") -- Execute the query
if (result) then
local row = mysql_fetch_row(result) -- Return the resulting row
local lengths = mysql_fetch_lengths(result) -- Retreive the lengths of the result fields
outputDebugString("The length of " .. row[1] .. " is " .. lengths[1])
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql fields

2011-01-05T18:03:42Z

Alberto Alonso: Oh god, not again.

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Creates an iterator for the result fields. When this function is called, the field cursor is set to the first field.

==Syntax==
<syntaxhighlight lang="lua">
iterator mysql_fields ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
An iterator function to iterate all the result fields.

===Example===
'''Example 1:''' This example shows how to print the rows of a result set showing the field name.
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT * FROM account") -- Execute the query
for result,row in mysql_rows(result) do -- Iterate through all the result rows
local i = 1
for result,field in mysql_fields(result) do
if (row[i] ~= mysql_null()) then
outputDebugString("row[" .. field["name"] .. "] = " .. row[i])
else
outputDebugString("row[" .. field["name"] .. "] = NULL")
end
i = i + 1
end
end
mysql_free_result(result) -- Free the result
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql fields

2011-01-05T18:02:47Z

Alberto Alonso:

Modules/MTA-MySQL/mysql fetch field

2011-01-05T18:02:22Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a table with information about a field in a query result. You can call repeatedly this function to return all the result fields, and when it reaches the end returns nil. You can also go to a specific field using [[Modules/MTA-MySQL/mysql_field_seek|mysql_field_seek()]].

==Syntax==
<syntaxhighlight lang="lua">
table mysql_fetch_field ( MySQLResult result )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result

===Returns===
A table with information about a field with the following keys:
* '''name:''' The name of this field.
* '''org_name:''' If you used aliases in the query, the original name of the field.
* '''table:''' The table of this field.
* '''org_table:''' If you used aliases for the table, the original name of the table.
* '''length:''' The maximum length allowed by this field in the table definition.
* '''max_length:''' The maximum length of this field in all the result rows.
* '''not_null:''' True if the field can't be NULL (See [[Modules/MTA-MySQL/mysql_null|mysql_null()]]).
* '''primary_key:''' True if the field is the table primary key.
* '''unique_key:''' True if the field value is unique.
* '''multiple_key:''' True if the field is part of a key.
* '''numeric:''' True if the field is numeric.
* '''blob:''' True if the field is a BLOB.
* '''unsigned:''' True if the field is unsigned.
* '''zerofill:''' True if the field is zero filled.
* '''type:''' A string representing the type of this field.

===Example===
'''Example 1:''' This example shows how to print the rows of a result set showing the field name.
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT * FROM account") -- Execute the query
for result,row in mysql_rows(result) do -- Iterate through all the result rows
mysql_field_seek(result, 1) -- Reset the field cursor to the first field
for k,v in ipairs(row) do
local field = mysql_fetch_field(result) -- Retreive the field data
if (v ~= mysql_null()) then
outputDebugString("row[" .. field["name"] .. "] = " .. v)
else
outputDebugString("row[" .. field["name"] .. "] = NULL")
end
end
end
mysql_free_result(result) -- Free the result
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql data seek

2011-01-05T18:02:01Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Sets the row cursor of a result in the given row offset. The offset must be a value between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_rows|mysql_num_rows()]]'''.

==Syntax==
<syntaxhighlight lang="lua">
mysql_data_seek ( MySQLResult result, int offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result
* '''offset:''' A valid row offset

===Returns===
This function doesn't return any value.

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Modules/MTA-MySQL/mysql warning count

2011-01-05T18:00:28Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the last query number of warnings

==Syntax==
<syntaxhighlight lang="lua">
int mysql_warning_count ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
An integer showing the number of warning of the last query

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql stat

2011-01-05T17:59:55Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string containing information about the MySQL server current status.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_stat ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
A string containing information about the MySQL server current status.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql set character set

2011-01-05T17:59:26Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Changes the character set used for the current MySQL session.

==Syntax==
<syntaxhighlight lang="lua">
bool mysql_set_character_set ( MySQLConnection handler, string charset_name )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''charset_name:''' The new character set name

===Returns===
It it succeeds returns true, in other case returns false.

==Example==
'''Example 1:'''
<syntaxhighlight lang="lua">
handler = mysql_connect("localhost", "user", "password", "mta_users")
if (not handler) then
outputDebugString("Unable to connect to the MySQL server")
elseif (not mysql_set_character_set(handler, "utf8")) then -- Change the charset to UTF-8
outputDebugString("Unable to change the connection character set to utf8: ("
.. mysql_errno(handler) .. ")" .. mysql_error(handler))
mysql_close(handler) -- Close the connection afther the error
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql unbuffered query

2011-01-05T17:59:03Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Executes an unbuffered query in the server and retreives the result.

'''IMPORTANT:''' It is '''strongly''' recommended to call [[Modules/MTA-MySQL/mysql_free_result|mysql_free_result]] after a query,
specially if it returns some data. Query results can be automatically deleted
by the lua garbage collector, so if you '''forget''' to free a result it will be
freed at some time in the future, but it doesn't know the real result data size
in memory so it can delay the memory destroying more than it should.

'''IMPORTANT:''' Unbuffered queries are to iterate a set of results improving the
performance since they are not pre-loaded in memory, so if you execute an unbuffered
query you '''must''' iterate all the result rows. For more information about unbuffered
queries visit http://dev.mysql.com/doc/refman/5.0/en/mysql-use-result.html

==Syntax==
<syntaxhighlight lang="lua">
MySQLResult mysql_unbuffered_query ( MySQLConnection handler, string query )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''query:''' The executing query

===Returns===
In case of error this function returns nil. IF not, a MySQLResult handler. Check the MySQL result managing functions to see how to retreive the data from it.

==Example==
'''Example 1:'''
<syntaxhighlight lang="lua">
local result = mysql_unbuffered_query(handler, "SELECT * FROM some_table")
if (not result) then
outputDebugString("Error executing the query: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler))
else
local numrows = 0
for result,row in mysql_rows(result) do -- We MUST iterate all the query resulting rows
numrows = numrows + 1
end
outputDebugString("The query returned a total of " .. numrows .. " rows")
mysql_free_result(result) -- Freeing the result is IMPORTANT
end
</syntaxhighlight>

==See also==
===Result managing functions===
{{Modules/MTA-MySQL/Result_functions}}
===MySQL handler functions===
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql query

2011-01-05T17:45:37Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Executes a query in the server and retreives the result.

'''IMPORTANT:''' It is '''strongly''' recommended to call [[Modules/MTA-MySQL/mysql_free_result|mysql_free_result]] after a query,
specially if it returns some data. Query results can be automatically deleted
by the lua garbage collector, so if you '''forget''' to free a result it will be
freed at some time in the future, but it doesn't know the real result data size
in memory so it can delay the memory destroying more than it should.

==Syntax==
<syntaxhighlight lang="lua">
MySQLResult mysql_query ( MySQLConnection handler, string query )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''query:''' The executing query

===Returns===
In case of error this function returns nil. IF not, a MySQLResult handler. Check the MySQL result managing functions to see how to retreive the data from it.

==Example==
'''Example 1:'''
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT * FROM some_table")
if (not result) then
outputDebugString("Error executing the query: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler))
else
mysql_free_result(result) -- Freeing the result is IMPORTANT
end
</syntaxhighlight>

==See also==
===Result managing functions===
{{Modules/MTA-MySQL/Result_functions}}
===MySQL handler functions===
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql insert id

2011-01-05T17:44:59Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the value generated for an AUTO_INCREMENT field in the last query.

For more information about when is this value updated visit http://dev.mysql.com/doc/refman/5.0/en/mysql-insert-id.html

==Syntax==
<syntaxhighlight lang="lua">
int mysql_insert_id ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
The value generated for an AUTO_INCREMENT field in the last query.

==Example==
'''Example 1:''' This example creates an account for a player when they use /register, and tells them their database id.
<syntaxhighlight lang="lua">
function RegisterPlayer(playerSource, commandName, _password)
local name = mysql_escape_string(handler, getPlayerName(playerSource)) -- Escape the strings to avoid SQL-Injection
local password = mysql_escape_string(handler, _password)
local query = "INSERT INTO account SET name='" .. name .. "', password=MD5('" .. password .. "')"

if (mysql_query(handler, query)) then
outputChatBox("Account created successfuly with id #" .. mysql_insert_id(handler), playerSource)
else
outputChatBox("An error has occured when trying to create your account.", playerSource)
end
end

addCommandHandler("register", RegisterPlayer)
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql info

2011-01-05T17:44:41Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string with information of the last executed query.

For more information about the possible returned values please visit http://dev.mysql.com/doc/refman/5.0/en/mysql-info.html

==Syntax==
<syntaxhighlight lang="lua">
string mysql_info ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
A string with the last executed query information.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql hex string

2011-01-05T17:44:23Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Converts a string to an hexadecimal representation of it. It is useful to insert binary data in blob fields, or to retreive and show it in your resources. It doesn't append '0x' or 'X' to the retreived string, the programmer must add it.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_hex_string ( string theString )
</syntaxhighlight>
===Required arguments===
* '''theString:''' The string to convert

===Returns===
An hexadecimal formatted string.

==Example==
'''Example 1:''' This function receives a string with a binary file content and stores it in a blob field of the database.
<syntaxhighlight lang="lua">
function savePlayerAvatar(playerName, imgRawData)
local imgHexData = mysql_hex_string(imgRawData)
mysql_query(handler, "UPDATE account SET avatar='0x" .. imgHexData .. "' WHERE name='" .. playerName .. "'")
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get server version

2011-01-05T17:44:07Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a number that represents the MySQL server version in this format:
major_version*10000 + minor_version *100 + sub_version
For example, 5.0.12 is returned as 50012.

This function is useful in client programs for quickly determining whether some version-specific server capability exists.
==Syntax==
<syntaxhighlight lang="lua">
int mysql_get_server_version( MySQLConnection handler )
</syntaxhighlight>

===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
An integer representing the MySQL server version.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get server info

2011-01-05T17:43:52Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string that represents the server version number.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_get_server_info ( MySQLConnection handler )
</syntaxhighlight>

===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
A string that represents the server version number.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get proto info

2011-01-05T17:43:33Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns an integer representing the protocol version used by current connection.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_get_proto_info ( MySQLConnection handler )
</syntaxhighlight>

===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
The protocol version used by current connection.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get host info

2011-01-05T17:43:15Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string describing the type of connection in use, including the server hostname.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_get_host_info ( MySQLConnection handler )
</syntaxhighlight>

===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
A string describing the type of connection in use, including the server hostname.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get client version

2011-01-05T17:42:54Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns an integer that represents the client library version. The value has the format XYYZZ where X is the major version, YY is the release level, and ZZ is the version number within the release level. For example, a value of 40102 represents a client library version of 4.1.2.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_get_client_version ( )
</syntaxhighlight>

===Returns===
An integer representing the client version.

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get client info

2011-01-05T17:42:37Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns a string representing the client library version

==Syntax==
<syntaxhighlight lang="lua">
string mysql_get_client_info ( )
</syntaxhighlight>

===Returns===
A string with the client library version

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql get character set info

2011-01-05T17:42:14Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Retreives information about a character set

==Syntax==
<syntaxhighlight lang="lua">
string, string, string, string, int, int mysql_get_character_set_info ( MySQLConnection handler, string character_set_name )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''character_set_name:''' The character set name

===Returns===
The character set information:
* The charset name
* The charset collation
* The charset comment
* The charset directory
* Multi byte character min. length
* Multi byte character max. length

==Example==
'''Example 1:'''
<syntaxhighlight lang="lua">
local name, collation, comment, directory, mbminlen, mbmaxlen =
mysql_get_character_set_info(handler, "utf8") -- We will return information about the charset "utf8"

outputDebugString("UTF-8 charset information:\n" ..
"name: " .. name .. "\n" ..
"collation: " .. collation .. "\n" ..
"comment: " .. comment .. "\n" ..
"directory: " .. directory .. "\n" ..
"mbminlen: " .. mbminlen .. "\n" ..
"mbmaxlen: " .. mbmaxlen)
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql change user

2011-01-05T17:41:54Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Changes the current MySQL session authentication.

==Syntax==
<syntaxhighlight lang="lua">
bool mysql_change_user ( MySQLConnection handler, string new_username, string new_password [, string new_database ] )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''new_username:''' The new username
* '''new_password:''' The new username password
===Optional arguments===
{{OptionalArg}}
* '''new_database:''' Start the new session using a new default database

===Returns===
It it succeeds returns true, in other case returns false

==Example==
'''Example 1:'''
<syntaxhighlight lang="lua">
function resourceStart ( resource )
if (resouce == getThisResource()) then
myhandler = mysql_connect("localhost", "writer_user", "password", "mta_users") -- Start with a read-write username
if (not myhandler) then
outputDebugString("Unable to connect to the database: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler))
else
-- Apply some changes to the database here
if (not mysql_change_user(myhandler, "localhost", "reader_user", "password", "mta_users")) then -- Change to a read-only user
outputDebugString("Unable to set the database read-only user: (" ..
mysql_errno(handler) .. ") " .. mysql_error(handler))
mysql_close(myhandler) -- Close the MySQL connection
end
end
end
end

addEventHandler("onResourceStart", getRootElement(), resourceStart)
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql affected rows

2011-01-05T17:41:29Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the number of changed rows (for UPDATE), inserted rows (for INSERT) or deleted rows (for DELETE) in the last query. For SELECT statements it works like [[Modules/MTA-MySQL/mysql_num_rows|mysql_num_rows]].

==Syntax==
<syntaxhighlight lang="lua">
int mysql_affected_rows ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
The number of affected rows in the last query.

==Example==
'''Example 1:''' This example shows the number of deleted rows after deleting all accounts starting with 'A'
<syntaxhighlight lang="lua">
mysql_query(handler, "DELETE FROM account WHERE name LIKE 'A%'")
outputDebugString("We deleted a total of " .. mysql_affected_rows(handle) .. " accounts starting with 'A'")
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql escape string

2011-01-05T17:41:09Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Escapes a query string to avoid sql injection attacks. This function should be used for every executed query that uses any data given by the players.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_escape_string( MySQLConnection handler, string theString )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''theString:''' The string to escape

===Returns===
The escaped string

==Example==
'''Example 1:''' This example returns some offline player cash getting it from the database
<syntaxhighlight lang="lua">
function checkOfflineMoney(playerSource, commandName, targetName)
local escapedName = mysql_escape_string(handler, targetName) -- Escape the string to avoid security holes
local result = mysql_query(handler, "SELECT money FROM account WHERE name='" .. escapedName .. "'")
if (not result) then
outputDebugString("mysql_query failed: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler)) -- Some error occurred
else
if (mysql_num_rows(result) == 0) then outputChatBox("Account not found", playerSource) -- We haven't results with that name
else outputChatBox("The player has " .. mysql_result(result, 1, 1) .. "$", playerSource) end -- Send the money information
mysql_free_result(result) -- Free the query result
end
end
addCommandHandler("offlinecash", checkOfflineMoney)
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql select db

2011-01-05T17:40:50Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Changes the current default database.

==Syntax==
<syntaxhighlight lang="lua">
bool mysql_select_db ( MySQLConnection handler, string database )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link
* '''database:''' The new database name

===Returns===
It it succeeds returns true, in other case returns false

==Example==
'''Example 1:''' This example changes the current default database to another one
<syntaxhighlight lang="lua">
local handler = mysql_connect("localhost", "user", "password", "mta_users")
if ( not mysql_select_db(handler, "another_database") ) then
outputDebugString("Unable to change default database: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler))
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql ping

2011-01-05T17:40:33Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Checks if the given MySQL connection is still alive.

==Syntax==
<syntaxhighlight lang="lua">
bool mysql_ping ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
true is the connection is still alive, false if not.

==Example==
'''Example 1:''' This example checks if the MySQL connection is still alive when a player connects, to be able to fetch their data.
<syntaxhighlight lang="lua">
myhandler = mysql_connect("localhost", "user", "password", "mta_users")

function checkMySQLConnection ( )
if (mysql_ping(myhandler) == false) then -- We lost the connection to the MySQL server
outputDebugString("Lost connection to the MySQL server, reconnecting ...")
mysql_close(myhandler)
myhandler = mysql_connect("localhost", "user", "password", "mta_users") -- Reconnect to the MySQL server
end
end

addEventHandler("onPlayerJoin", getRootElement(), checkMySQLConnection)
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql error

2011-01-05T17:39:51Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the last error string of a MySQL connection.

==Syntax==
<syntaxhighlight lang="lua">
string mysql_error ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
The last error string. Visit http://dev.mysql.com/doc/refman/5.0/en/error-handling.html for a list of error codes.

==Example==
'''Example 1:''' This example sends a query to the server and if it fails, shows the reason.
<syntaxhighlight lang="lua">
result = mysql_query(handler, "SELECT FROM table") -- We have a syntax error in the query
if (not result) then -- The query failed
outputDebugString("mysql_query failed: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler)) -- Show the reason
else
mysql_free_result(result) -- Free the last query result data
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}

Modules/MTA-MySQL/mysql errno

2011-01-05T17:39:29Z

Alberto Alonso:

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the last error number of a MySQL connection.

==Syntax==
<syntaxhighlight lang="lua">
int mysql_errno ( MySQLConnection handler )
</syntaxhighlight>
===Required arguments===
* '''handler:''' A valid MySQL link

===Returns===
The last error number, zero if nothing failed. Visit http://dev.mysql.com/doc/refman/5.0/en/error-handling.html for a list of error codes.

==Example==
'''Example 1:''' This example sends a query to the server and if it fails, shows the reason.
<syntaxhighlight lang="lua">
result = mysql_query(handler, "SELECT FROM table") -- We have a syntax error in the query
if (not result) then -- The query failed
outputDebugString("mysql_query failed: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler)) -- Show the reason
else
mysql_free_result(result) -- Free the last query result data
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Handler_functions}}