Multi Theft Auto: Wiki - User contributions [en]

DbPoll

2016-10-29T22:09:33Z

Joaosilva099: affected rows and last insert id are also returned when using multiple statements

__NOTOC__
{{Server function}}
This function checks the progress of a database query.

==Syntax==
<syntaxhighlight lang="lua">
table dbPoll ( handle queryHandle, int timeout[, bool multipleResults = false ] )
</syntaxhighlight>
{{OOP||queryHandle:poll}}
===Required Arguments===
*'''queryHandle:''' A query handle previously returned from [[dbQuery]]
*'''timeout:''' How many milliseconds to wait for a result. Use 0 for an instant response (which may return nil). Use -1 to wait until a result is ready. Note: A wait here will freeze the entire server just like the executeSQL* functions

===Optional Arguments===
{{New items|3.0160|1.5.2|
*'''multipleResults:''' Set to true to enable the return values from multiple statements
|7972}}

===Returns===
*''nil:'' Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call [[dbFree]])
*''false:'' Returns false if the query string contained an error, the connection has been lost or the query handle is incorrect. This automatically frees the query handle, so you do not have to call [[dbFree]].
** This also returns two extra values: (See the example on how the retrieve them)
***''int:'' error code
***''string'' error message
*''table:'' Returns a table when the query has successfully completed. This automatically frees the query handle, so you do not have to call [[dbFree]].
** This also returns extra values:
***''int:'' number of affected rows
***''int:'' last insert id

==Example==
This example waits until a result is ready:
<syntaxhighlight lang="lua">
local result = dbPoll ( qh, -1 )
</syntaxhighlight>

This example shows the possible return values:
<syntaxhighlight lang="lua">
local result, num_affected_rows, last_insert_id = dbPoll ( qh, -1 )

if result == nil then
outputConsole( "dbPoll result not ready yet" )
elseif result == false then
local error_code,error_msg = num_affected_rows,last_insert_id
outputConsole( "dbPoll failed. Error code: " .. tostring(error_code) .. " Error message: " .. tostring(error_msg) )
else
outputConsole( "dbPoll succeeded. Number of affected rows: " .. tostring(num_affected_rows) .. " Last insert id: " .. tostring(last_insert_id) )
end
</syntaxhighlight>

This example shows how to handle the result if the query selected data:
<syntaxhighlight lang="lua">
local result = dbPoll ( qh, -1 )

if result then
for _, row in ipairs ( result ) do

-- by using a second loop (use it if you want to get the values of all columns the query selected):
for column, value in pairs ( row ) do
-- column = the mysql column of the table in the query
-- value = the value of that column in this certain row
end

-- or without a second loop (use it if you want to handle every value in a special way):
outputChatBox ( row["column"] ) -- it will output the value of the column "column" in this certain row
end
end
</syntaxhighlight>

{{New items|3.0153|1.5.2|
This example shows how to handle the result of a multiple statement query: (See [[dbConnect]] option '''multi_statements''')
<syntaxhighlight lang="lua">
local multiResults = dbPoll ( qh, -1, true )

if multiResults then
for sidx, statementResult in ipairs ( multiResults ) do
local resultRows, numAffectedRows, lastInsertId = unpack(statementResult)
for ridx, row in ipairs ( resultRows ) do
for column, value in pairs ( row ) do
outputDebugString( ""
.. " statement#" .. sidx
.. " row#" .. ridx
.. " column:" .. tostring(column)
.. " value:" .. tostring(value)
)
end
end
end
end
</syntaxhighlight>
|7972}}

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

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.4-9.05862|Added 'last insert id' return value}}
{{ChangelogItem|1.5.2-9.07972|Added 'multipleResults' argument}}

==See Also==
{{Registry_functions}}

ConvertTextToSpeech

2016-08-23T22:52:13Z

Joaosilva099:

{{Useful Function}}<lowercasetitle/>
__NOTOC__
'''THIS FUNCTION IS NOT WORKING ANYMORE DUE TO GOOGLE BLOCKING NON-USER CALLS TO THEIR TTS API'''

This useful shared function converts some text to audible speech using Google's TTS.

==Syntax==
<syntaxhighlight lang="lua">boolean, element, string convertTextToSpeech ( string text [, table/element broadcastTo = root, string language = "en" ] )</syntaxhighlight>

==Required arguments==
* ''text'': the text to convert to speech.

==Optional arguments==
* ''broadcastTo'': if it's a regular indexed table, the speech will be broadcasted to the players contained in it. If it's a element, the speech will be heard by the players which are children of that element. This parameter is '''ONLY''' serverside; if you're using this function clientside this will be considered as the ''language'' argument.
* ''language'': defines the language of the TTS output.

==Returns==
* This function returns ''[[nil]]'' and outputs an error if an argument it's not valid.
* If called serverside and if all arguments are valid, this function returns ''true'' if the client was successully told to play the TTS (althrough this doesn't mean that the client will always play the speech); ''false'' otherwise.
* If called clientside and if all arguments are valid, this function returns ''true'', the corresponding [[sound]] element and its URL if the sound could theorically be played (althrough it may not play); ''[[nil]]'' otherwise.

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent("playTTS", true) -- Add the event

local function playTTS(text, lang)
local URL = "http://translate.google.com/translate_tts?tl=" .. lang .. "&q=" .. text
-- Play the TTS. BASS returns the sound element even if it can not be played.
return true, playSound(URL), URL
end
addEventHandler("playTTS", root, playTTS)
</syntaxhighlight>
</section>
<section name="Shared (server and client)" class="both" show="true">
<syntaxhighlight lang="lua">
function convertTextToSpeech(text, broadcastTo, lang)
-- Ensure first argument is valid
assert(type(text) == "string", "Bad argument 1 @ convertTextToSpeech [ string expected, got " .. type(text) .. "]")
assert(#text <= 100, "Bad argument 1 @ convertTextToSpeech [ too long string; 100 characters maximum ]")
if triggerClientEvent then -- Is this function called serverside?
-- Ensure second and third arguments are valid
assert(broadcastTo == nil or type(broadcastTo) == "table" or isElement(broadcastTo), "Bad argument 2 @ convertTextToSpeech [ table/element expected, got " .. type(broadcastTo) .. "]")
assert(lang == nil or type(lang) == "string", "Bad argument 3 @ convertTextToSpeech [ string expected, got " .. type(lang) .. "]")
-- Tell the client to play the speech
return triggerClientEvent(broadcastTo or root, "playTTS", root, text, lang or "en")
else -- This function is executed clientside
local lang = broadcastTo
-- Ensure second argument is valid
assert(lang == nil or type(lang) == "string", "Bad argument 2 @ convertTextToSpeech [ string expected, got " .. type(lang) .. "]")
return playTTS(text, lang or "en")
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example==
This example disables text chat and converts that text to a speech audible to nearby players. '''NOTE''': this example requires 1.4 in order to work.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local function tellClientsToPlayTTS(text, type)
if type == 0 and #text <= 100 then -- We only want to replace normal chat if possible
local x, y, z = getElementPosition(source)
local col = createColSphere(x, y, z, 30) -- We need this to get nearby players
triggerClientEvent(getElementsWithinColShape(col, "player"), "playChatTTS", source, text) -- Tell the nearby clients to play the sound
destroyElement(col)
cancelEvent() -- Replace text chat
end
end
addEventHandler("onPlayerChat", root, tellClientsToPlayTTS)</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent("playChatTTS", true) -- Add the event

local function playChatTTS(text)
local lang = (getLocalization().code):sub(1, 2) -- Output the TTS in the local player language, but don't bother about variants
local _, speech, URL = convertTextToSpeech(text, lang)
-- Convert that speech to a 3D sound
destroyElement(speech)
local x, y, z = getElementPosition(source)
local speech = playSound3D(URL, x, y, z)
attachElements(speech, source) -- Make the sound follow the player
setElementDimension(speech, getElementDimension(source))
setSoundMinDistance(speech, 15)
setSoundMaxDistance(speech, 30)
-- Tricky thing ahead: make the player mouth move, but without rendering him unable to move
setPedAnimation(source, "ped", "factalk", 0, true)
setPedAnimation(source, "ped", "factalk", 0, true)
-- Reset the player mouth after the speech has ended
setTimer(function(player)
if isElement(player) then
setPedAnimation(player) -- Clear the animation
end
end, math.max(getSoundLength(speech) * 1000, 50), 1, source)
end
addEventHandler("playChatTTS", root, playChatTTS)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

ConvertTextToSpeech

2016-08-23T22:51:59Z

Joaosilva099:

{{Useful Function}}<lowercasetitle/>
__NOTOC__

'''THIS FUNCTION IS NOT WORKING ANYMORE DUE TO GOOGLE BLOCKING NON-USER CALLS TO THEIR TTS API'''

This useful shared function converts some text to audible speech using Google's TTS.

==Syntax==
<syntaxhighlight lang="lua">boolean, element, string convertTextToSpeech ( string text [, table/element broadcastTo = root, string language = "en" ] )</syntaxhighlight>

==Required arguments==
* ''text'': the text to convert to speech.

==Optional arguments==
* ''broadcastTo'': if it's a regular indexed table, the speech will be broadcasted to the players contained in it. If it's a element, the speech will be heard by the players which are children of that element. This parameter is '''ONLY''' serverside; if you're using this function clientside this will be considered as the ''language'' argument.
* ''language'': defines the language of the TTS output.

==Returns==
* This function returns ''[[nil]]'' and outputs an error if an argument it's not valid.
* If called serverside and if all arguments are valid, this function returns ''true'' if the client was successully told to play the TTS (althrough this doesn't mean that the client will always play the speech); ''false'' otherwise.
* If called clientside and if all arguments are valid, this function returns ''true'', the corresponding [[sound]] element and its URL if the sound could theorically be played (althrough it may not play); ''[[nil]]'' otherwise.

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent("playTTS", true) -- Add the event

local function playTTS(text, lang)
local URL = "http://translate.google.com/translate_tts?tl=" .. lang .. "&q=" .. text
-- Play the TTS. BASS returns the sound element even if it can not be played.
return true, playSound(URL), URL
end
addEventHandler("playTTS", root, playTTS)
</syntaxhighlight>
</section>
<section name="Shared (server and client)" class="both" show="true">
<syntaxhighlight lang="lua">
function convertTextToSpeech(text, broadcastTo, lang)
-- Ensure first argument is valid
assert(type(text) == "string", "Bad argument 1 @ convertTextToSpeech [ string expected, got " .. type(text) .. "]")
assert(#text <= 100, "Bad argument 1 @ convertTextToSpeech [ too long string; 100 characters maximum ]")
if triggerClientEvent then -- Is this function called serverside?
-- Ensure second and third arguments are valid
assert(broadcastTo == nil or type(broadcastTo) == "table" or isElement(broadcastTo), "Bad argument 2 @ convertTextToSpeech [ table/element expected, got " .. type(broadcastTo) .. "]")
assert(lang == nil or type(lang) == "string", "Bad argument 3 @ convertTextToSpeech [ string expected, got " .. type(lang) .. "]")
-- Tell the client to play the speech
return triggerClientEvent(broadcastTo or root, "playTTS", root, text, lang or "en")
else -- This function is executed clientside
local lang = broadcastTo
-- Ensure second argument is valid
assert(lang == nil or type(lang) == "string", "Bad argument 2 @ convertTextToSpeech [ string expected, got " .. type(lang) .. "]")
return playTTS(text, lang or "en")
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example==
This example disables text chat and converts that text to a speech audible to nearby players. '''NOTE''': this example requires 1.4 in order to work.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local function tellClientsToPlayTTS(text, type)
if type == 0 and #text <= 100 then -- We only want to replace normal chat if possible
local x, y, z = getElementPosition(source)
local col = createColSphere(x, y, z, 30) -- We need this to get nearby players
triggerClientEvent(getElementsWithinColShape(col, "player"), "playChatTTS", source, text) -- Tell the nearby clients to play the sound
destroyElement(col)
cancelEvent() -- Replace text chat
end
end
addEventHandler("onPlayerChat", root, tellClientsToPlayTTS)</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent("playChatTTS", true) -- Add the event

local function playChatTTS(text)
local lang = (getLocalization().code):sub(1, 2) -- Output the TTS in the local player language, but don't bother about variants
local _, speech, URL = convertTextToSpeech(text, lang)
-- Convert that speech to a 3D sound
destroyElement(speech)
local x, y, z = getElementPosition(source)
local speech = playSound3D(URL, x, y, z)
attachElements(speech, source) -- Make the sound follow the player
setElementDimension(speech, getElementDimension(source))
setSoundMinDistance(speech, 15)
setSoundMaxDistance(speech, 30)
-- Tricky thing ahead: make the player mouth move, but without rendering him unable to move
setPedAnimation(source, "ped", "factalk", 0, true)
setPedAnimation(source, "ped", "factalk", 0, true)
-- Reset the player mouth after the speech has ended
setTimer(function(player)
if isElement(player) then
setPedAnimation(player) -- Clear the animation
end
end, math.max(getSoundLength(speech) * 1000, 50), 1, source)
end
addEventHandler("playChatTTS", root, playChatTTS)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

IsTextInGridList

2016-07-17T03:29:38Z

Joaosilva099: It needs to be -1 ! Check your other function "guiGridListGetRowIndexFromText" you did correctly there

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
As the tile says, this function checks if some text exist or not in the GridList.
==Syntax==
<syntaxhighlight lang="lua">bool isTextInGridList (element gridList,string text)</syntaxhighlight>

===Required arguments===
* '''gridList''': The grid list element.
* '''text''': The text that you are looking for.

===Return===
Returns true if the text exist in the GridList, false if otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isTextInGridList(gridList, text)
for i=0, guiGridListGetRowCount(gridlist)-1 do
local t = guiGridListGetItemText(gridlist, i, 1)
if (t) then
if (t == text) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function ()
playerList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true)
local column = guiGridListAddColumn(playerList, "Player", 0.85)
if (column) then
for id, players in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow(playerList)
guiGridListSetItemText(playerList, row, column, getPlayerName(players), false, false)
end
end
end)

function findText(cmd,text)
if not tostring(text) then return end
if isTextInGridList(playerList, tostring(text)) then
outputChatBox("Text exist!",0,255,0)
end
end
addCommandHandler("check",findText)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}

IsTextInGridList

2016-07-15T23:16:53Z

Joaosilva099: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
As the tile says, this function checks if some text exist or not in the GridList.
==Syntax==
<syntaxhighlight lang="lua">bool isTextInGridList (element gridList,string text)</syntaxhighlight>

===Required arguments===
* '''gridList''': The grid list element.
* '''text''': The text that you are looking for.

===Return===
Returns true if the text exist in the GridList, false if otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isTextInGridList(gridList, text)
for i=0, guiGridListGetRowCount(gridlist)-1 do --We need to remove 1 from the total row count because rows starts at 0 and not 1
local t = guiGridListGetItemText(gridlist, i, 1)
if (t) then
if (t == text) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function ()
playerList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true)
local column = guiGridListAddColumn(playerList, "Player", 0.85)
if (column) then
for id, players in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow(playerList)
guiGridListSetItemText(playerList, row, column, getPlayerName(players), false, false)
end
end
end)

function findText(cmd,text)
if not tostring(text) then return end
if isTextInGridList(playerList, tostring(text)) then
outputChatBox("Text exist!",0,255,0)
end
end
addCommandHandler("check",findText)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}