Multi Theft Auto: Wiki - User contributions [en]

ConvertTextToSpeech

2019-07-11T12:16:09Z

Hassan saad:

__NOTOC__
{{Useful Function}}<lowercasetitle/>


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
local URL = "https://code.responsivevoice.org/getvoice.php?tl=" .. lang .. "&t=" .. 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: ''Al Obaidi Hassan''.
*Skype: ''hassan.saad2000''
*Discord: ''HassoN#2709''

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

User:Hassan saad

2019-07-05T21:14:51Z

Hassan saad:

Hello there!
Welcome to my own profile page. Feel free to contact me on Skype: '''''hassan.saad2000''''' or Discord: '''''HassoN#2709''''' for any scripting related stuff.

'''''Some of my works:'''''

[[ConvertTextToSpeech]]

[[RenameAclGroup]]

[[DxDrawTextOnElement]]

[[DxDrawImageOnElement]]

ConvertTextToSpeech

2018-01-14T20:42:51Z

Hassan saad: /* Function source */

__NOTOC__
{{Useful Function}}<lowercasetitle/>


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
local URL = "https://code.responsivevoice.org/getvoice.php?tl=" .. lang .. "&t=" .. 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: ''Al Obaidi Hassan''.
*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}}

DxDrawTextOnElement

2018-01-14T20:42:40Z

Hassan saad: /* Function source */

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws a text on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element TheElement, string text [, int height = 1, int distance = 20, int R = 255, int G = 255, int B = 255, int alpha = 255, int size = 1, string font = "arial", bool checkBuildings = true, bool checkVehicles = false, bool checkPeds = false, bool checkDummies = true, bool seeThroughStuff = true, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] )</syntaxhighlight>
[[Image:dxDrawTextOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the text on it.
* ''text'': The text you want.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the text from, it's 20 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.
* ''size'': The size of the text, it's 1 by default.
* ''font'': Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
It's arial by default.
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTextOnElement(TheElement,text,height,distance,R,G,B,alpha,size,font,checkBuildings,checkVehicles,checkPeds,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawText(text, sx+2, sy+2, sx, sy, tocolor(R or 255, G or 255, B or 255, alpha or 255), (size or 1)-(distanceBetweenPoints / distance), font or "arial", "center", "center")
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Al Obaidi Hassan''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates a text on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2476.91406,-1665.31799,13.32435)

addEventHandler("onClientRender", getRootElement(),
function ()
dxDrawTextOnElement(randomPed,"SWATTEAM Officer",1,20,0,0,255,255,1,"pricedown")
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates a text 'HassoN' on all the players are in a team named HassoN.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", getRootElement(),
function ()
for k,v in ipairs(getElementsByType("player")) do
if getPlayerTeam(v) == getTeamFromName("HassoN") then
if v == localPlayer then return end
dxDrawTextOnElement(v,"HassoN",1,20,0,0,255,255,1,"arial")
end
end
end)
</syntaxhighlight>
</section>

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

DxDrawImageOnElement

2018-01-14T20:42:27Z

Hassan saad: /* Function source */

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws an image on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawImageOnElement(element TheElement, element Image [, int distance = 20, int height = 1, int width = 1, int R = 255, int G = 255, int B = 255, int alpha = 255, bool checkBuildings = true, bool checkVehicles = false, bool checkPeds = false, bool checkDummies = true, bool seeThroughStuff = true, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] ) </syntaxhighlight>

[[File:DxDrawImageOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the image on it.
* ''Image'': The image you want. Use [[dxCreateTexture]] to create it.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the image from, it's 20 by default.
* ''height'': The height of the image, it's 1 by default.
* ''width'': The width of the image, it's 1 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the image, it's 255 by default.

*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawImageOnElement(TheElement,Image,distance,height,width,R,G,B,alpha)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local width = width or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawMaterialLine3D(x, y, z+1+height-(distanceBetweenPoints/distance), x, y, z+height, Image, width-(distanceBetweenPoints/distance), tocolor(R or 255, G or 255, B or 255, alpha or 255))
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Al Obaidi Hassan''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates an image on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2506.83423,-1684.89941,13.55648)
tag = dxCreateTexture("crown.png")

addEventHandler("onClientPreRender", root,
function()
dxDrawImageOnElement(randomPed,tag)
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates an image on all the vehicles in the game.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local tag = dxCreateTexture("bike.png")

addEventHandler("onClientPreRender", root,
function()
for k,v in ipairs(getElementsByType("vehicle")) do
dxDrawImageOnElement(v,tag)
end
end)
</syntaxhighlight>
</section>

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

RenameAclGroup

2018-01-14T20:40:59Z

Hassan saad: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is used to rename an [[Aclgroup|ACL group]].

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup ( string old, string new )</syntaxhighlight>

==Required Arguments==
* '''old:''' name of the ACL group you want to change
* '''new:''' the name we want the group to be changed to

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

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup( old, new )
if ( type( old ) ~= "string" ) then
outputDebugString( "Bad argument 1 @ renameAclGroup [ string expected, got " .. type( old ) .. " ] ", 2 )
return false
end

if ( type( new ) ~= "string" ) then
outputDebugString( "Bad argument 2 @ renameAclGroup [ string expected, got " .. type( new ) .. " ] ", 2 )
return false
end

local oldACLGroup = aclGetGroup( old )

if ( not oldACLGroup ) then
outputDebugString( "Bad argument 1 @ renameAclGroup [ no acl group found with this name ] ", 2 )
return false
end

if ( aclGetGroup( new ) ) then
outputDebugString( "Bad argument 2 @ renameAclGroup [ there is already a group with this name ] ", 2 )
return false
end

local oldACL = aclGroupListACL( oldACLGroup )
local oldObjects = aclGroupListObjects( oldACLGroup )
local newACLGroup = aclCreateGroup( new )

for _,nameOfACL in pairs( oldACL ) do
aclGroupAddACL( newACLGroup, nameOfACL )
end

for _,nameOfObject in pairs( oldObjects ) do
aclGroupAddObject( newACLGroup, nameOfObject )
end

aclDestroyGroup( oldACLGroup )
aclSave( )
aclReload( )

return true
end
</syntaxhighlight>
</section>

*Original author: ''Al Obaidi Hassan''
*Skype: ''hassan.saad2000''

==Example==
This example changes a group named ''Moderator'' to ''HassoN'' when the script is loaded.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function( )
renameAclGroup( "Moderator", "HassoN" )
end
)
</syntaxhighlight>
</section>

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

DxDrawTextOnElement

2016-03-13T14:04:07Z

Hassan saad:

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws a text on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element TheElement, string text [, int height = 1, int distance = 20, int R = 255, int G = 255, int B = 255, int alpha = 255, int size = 1, string font = "arial", bool checkBuildings = true, bool checkVehicles = false, bool checkPeds = false, bool checkDummies = true, bool seeThroughStuff = true, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] )</syntaxhighlight>
[[Image:dxDrawTextOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the text on it.
* ''text'': The text you want.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the text from, it's 20 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.
* ''size'': The size of the text, it's 1 by default.
* ''font'': Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
It's arial by default.
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTextOnElement(TheElement,text,height,distance,R,G,B,alpha,size,font,checkBuildings,checkVehicles,checkPeds,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawText(text, sx+2, sy+2, sx, sy, tocolor(R or 255, G or 255, B or 255, alpha or 255), (size or 1)-(distanceBetweenPoints / distance), font or "arial", "center", "center")
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates a text on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2476.91406,-1665.31799,13.32435)

addEventHandler("onClientRender", getRootElement(),
function ()
dxDrawTextOnElement(randomPed,"SWATTEAM Officer",1,20,0,0,255,255,1,"pricedown")
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates a text 'HassoN' on all the players are in a team named HassoN.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", getRootElement(),
function ()
for k,v in ipairs(getElementsByType("player")) do
if getPlayerTeam(v) == getTeamFromName("HassoN") then
if v == localPlayer then return end
dxDrawTextOnElement(v,"HassoN",1,20,0,0,255,255,1,"arial")
end
end
end)
</syntaxhighlight>
</section>

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

DxDrawImageOnElement

2016-03-13T14:01:43Z

Hassan saad:

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws an image on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawImageOnElement(element TheElement, element Image [, int distance = 20, int height = 1, int width = 1, int R = 255, int G = 255, int B = 255, int alpha = 255, bool checkBuildings = true, bool checkVehicles = false, bool checkPeds = false, bool checkDummies = true, bool seeThroughStuff = true, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] ) </syntaxhighlight>

[[File:DxDrawImageOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the image on it.
* ''Image'': The image you want. Use [[dxCreateTexture]] to create it.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the image from, it's 20 by default.
* ''height'': The height of the image, it's 1 by default.
* ''width'': The width of the image, it's 1 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the image, it's 255 by default.

*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawImageOnElement(TheElement,Image,distance,height,width,R,G,B,alpha)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local width = width or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawMaterialLine3D(x, y, z+1+height-(distanceBetweenPoints/distance), x, y, z+height, Image, width-(distanceBetweenPoints/distance), tocolor(R or 255, G or 255, B or 255, alpha or 255))
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates an image on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2506.83423,-1684.89941,13.55648)
tag = dxCreateTexture("crown.png")

addEventHandler("onClientPreRender", root,
function()
dxDrawImageOnElement(randomPed,tag)
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates an image on all the vehicles in the game.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local tag = dxCreateTexture("bike.png")

addEventHandler("onClientPreRender", root,
function()
for k,v in ipairs(getElementsByType("vehicle")) do
dxDrawImageOnElement(v,tag)
end
end)
</syntaxhighlight>
</section>

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

DxDrawTextOnElement

2016-03-12T01:50:58Z

Hassan saad:

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws a text on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element TheElement, string text [, int height, int distance, int R, int G, int B, int alpha, int size, string font, bool checkBuildings, bool checkVehicles, bool checkPeds, bool checkDummies, bool seeThroughStuff, bool ignoreSomeObjectsForCamera, element ignoredElement ] )</syntaxhighlight>
[[Image:dxDrawTextOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the text on it.
* ''text'': The text you want.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the text from, it's 20 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.
* ''size'': The size of the text, it's 1 by default.
* ''font'': Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
It's arial by default.
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTextOnElement(TheElement,text,height,distance,R,G,B,alpha,size,font,checkBuildings,checkVehicles,checkPeds,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawText(text, sx+2, sy+2, sx, sy, tocolor(R or 255, G or 255, B or 255, alpha or 255), (size or 1)-(distanceBetweenPoints / distance), font or "arial", "center", "center")
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates a text on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2476.91406,-1665.31799,13.32435)

addEventHandler("onClientRender", getRootElement(),
function ()
dxDrawTextOnElement(randomPed,"SWATTEAM Officer",1,20,0,0,255,255,1,"pricedown")
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates a text 'HassoN' on all the players are in a team named HassoN.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", getRootElement(),
function ()
for k,v in ipairs(getElementsByType("player")) do
if getPlayerTeam(v) == getTeamFromName("HassoN") then
if v == localPlayer then return end
dxDrawTextOnElement(v,"HassoN",1,20,0,0,255,255,1,"arial")
end
end
end)
</syntaxhighlight>
</section>

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

DxDrawImageOnElement

2016-03-12T01:50:57Z

Hassan saad:

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws an image on any element you choose.
{{Note|You have to use [[onClientRender]] or [[onClientPreRender]] events with this function.}}

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawImageOnElement(element TheElement, element Image [, int distance, int height, int width, int R, int G, int B, int alpha, bool checkBuildings, bool checkVehicles, bool checkPeds, bool checkDummies, bool seeThroughStuff, bool ignoreSomeObjectsForCamera, element ignoredElement ] ) </syntaxhighlight>

[[File:DxDrawImageOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the image on it.
* ''Image'': The image you want. Use [[dxCreateTexture]] to create it.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the image from, it's 20 by default.
* ''height'': The height of the image, it's 1 by default.
* ''width'': The width of the image, it's 1 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the image, it's 255 by default.

*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawImageOnElement(TheElement,Image,distance,height,width,R,G,B,alpha)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local width = width or 1
local checkBuildings = checkBuildings or true
local checkVehicles = checkVehicles or false
local checkPeds = checkPeds or false
local checkObjects = checkObjects or true
local checkDummies = checkDummies or true
local seeThroughStuff = seeThroughStuff or false
local ignoreSomeObjectsForCamera = ignoreSomeObjectsForCamera or false
local ignoredElement = ignoredElement or nil
if (isLineOfSightClear(x, y, z, x2, y2, z2, checkBuildings, checkVehicles, checkPeds , checkObjects,checkDummies,seeThroughStuff,ignoreSomeObjectsForCamera,ignoredElement)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawMaterialLine3D(x, y, z+1+height-(distanceBetweenPoints/distance), x, y, z+height, Image, width-(distanceBetweenPoints/distance), tocolor(R or 255, G or 255, B or 255, alpha or 255))
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates an image on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2506.83423,-1684.89941,13.55648)
tag = dxCreateTexture("crown.png")

addEventHandler("onClientPreRender", root,
function()
dxDrawImageOnElement(randomPed,tag)
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates an image on all the vehicles in the game.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local tag = dxCreateTexture("bike.png")

addEventHandler("onClientPreRender", root,
function()
for k,v in ipairs(getElementsByType("vehicle")) do
dxDrawImageOnElement(v,tag)
end
end)
</syntaxhighlight>
</section>

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

Installing and Running MTASA Server on GNU Linux

2016-02-26T18:57:15Z

Hassan saad: /* Default resources */

== Installation 32 bit ==

=== Main binary===
Download the latest stable 32 bit Linux binaries:
rm multitheftauto_linux-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/{{Current Version|fullnodots}}/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/{{Current Version|fullnodots}}/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

=== 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
wget http://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
rm mtasa-resources-latest.zip

== Installation 64 bit ==

=== Main binary ===
Download the latest stable 64 bit Linux binaries:
rm multitheftauto_linux_x64-{{Current Version|full}}.tar.gz
wget <nowiki>http</nowiki>://linux.mtasa.com/dl/{{Current Version|fullnodots}}/multitheftauto_linux_x64-{{Current Version|full}}.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux_x64-{{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/{{Current Version|fullnodots}}/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_x64-{{Current Version|full}}/mods/deathmatch

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

=== Test ===
You can now test if the server will start correctly:
./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

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

== MySQL Troubleshooting==
* If you are using the inbuilt MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* 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:
* For 32 bit Linux, download [http://nightly.mtasa.com/files/modules/32/libmysqlclient.so.16 32 bit libmysqlclient.so.16] and put it in '''/usr/lib/'''
* For 64 bit Linux, download [http://nightly.mtasa.com/files/modules/64/libmysqlclient.so.16 64 bit libmysqlclient.so.16] and put it in '''/usr/lib/'''

==[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)

DxDrawImageOnElement

2016-02-02T10:11:30Z

Hassan saad: /* Optional arguments */

DxDrawImageOnElement

2016-02-01T22:52:34Z

Hassan saad: /* Syntax */

DxDrawImageOnElement

2016-02-01T18:38:29Z

Hassan saad:

DxDrawTextOnElement

2016-02-01T18:38:19Z

Hassan saad:

Template:Useful Functions

2016-02-01T18:05:52Z

Hassan saad:

*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span>
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span>
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span>
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span>
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span>
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span>
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span>
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span>
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span>
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span>
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span>
*[[dxDrawCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a number of 2D lines in order to achieve a circle shape on the screen.</span>
*[[dxDrawEmptyRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an empty 2D rectangle on the screen.</span>
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span>
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span>
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span>
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span>
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span>
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span>
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span>
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span>
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span>
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span>
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span>
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span>
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span>
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span>
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span>
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span>
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span>
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span>
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span>
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span>
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span>
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span>
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span>
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span>
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span>
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string of all logged-in administrators separated by two whitespace characters.</span>
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span>
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span>
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span>
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span>
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span>
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span>
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span>
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span>
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span>
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span>
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span>
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span>
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span>
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span>
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span>
*[[getVehicleRespawnPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get the respawn position of a vehicle.</span>
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span>
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span>
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span>
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span>
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span>
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span>
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span>
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span>
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span>
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span>
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span>
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span>
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span>
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span>
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span>
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span>
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span>
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span>
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span>
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span>
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span>
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span>
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span>
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span>
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span>
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span>
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span>
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span>
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span>
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span>
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span>
*[[setAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to change an existing account's name.</span>
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span>
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span>
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span>
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span>
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span>
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span>
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span>
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span>
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span>
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span>
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span>
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span>
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span>
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span>
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span>
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span>
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span>
[[Category:Useful Functions]]

RenameAclGroup

2016-02-01T15:53:42Z

Hassan saad: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is used to rename an [[Aclgroup|ACL group]].

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup ( string old, string new )</syntaxhighlight>

==Required Arguments==
* '''old:''' name of the ACL group you want to change
* '''new:''' the name we want the group to be changed to

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

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup( old, new )
if ( type( old ) ~= "string" ) then
outputDebugString( "Bad argument 1 @ renameAclGroup [ string expected, got " .. type( old ) .. " ] ", 2 )
return false
end

if ( type( new ) ~= "string" ) then
outputDebugString( "Bad argument 2 @ renameAclGroup [ string expected, got " .. type( new ) .. " ] ", 2 )
return false
end

local oldACLGroup = aclGetGroup( old )

if ( not oldACLGroup ) then
outputDebugString( "Bad argument 1 @ renameAclGroup [ no acl group found with this name ] ", 2 )
return false
end

if ( aclGetGroup( new ) ) then
outputDebugString( "Bad argument 2 @ renameAclGroup [ there is already a group with this name ] ", 2 )
return false
end

local oldACL = aclGroupListACL( oldACLGroup )
local oldObjects = aclGroupListObjects( oldACLGroup )
local newACLGroup = aclCreateGroup( new )

for _,nameOfACL in pairs( oldACL ) do
aclGroupAddACL( newACLGroup, nameOfACL )
end

for _,nameOfObject in pairs( oldObjects ) do
aclGroupAddObject( newACLGroup, nameOfObject )
end

aclDestroyGroup( oldACLGroup )
aclSave( )
aclReload( )

return true
end
</syntaxhighlight>
</section>

*Original author: ''Has[S]oN''
*Skype: ''hassan.saad2000''

==Example==
This example changes a group named ''Moderator'' to ''HassoN'' when the script is loaded.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function( )
renameAclGroup( "Moderator", "HassoN" )
end
)
</syntaxhighlight>
</section>

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

ConvertTextToSpeech

2016-02-01T15:53:36Z

Hassan saad: /* Function source */

{{Useful Function}}<lowercasetitle/>
__NOTOC__
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}}

User:Hassan saad

2016-02-01T15:12:23Z

Hassan saad:

Hello there!
Welcome to my own profile page. Feel free to contact me on Skype: '''''hassan.saad2000''''' for any scripting related stuff.

'''''Some of my works:'''''

[[ConvertTextToSpeech]]

[[RenameAclGroup]]

[[DxDrawTextOnElement]]

[[DxDrawImageOnElement]]

DxDrawImageOnElement

2016-02-01T15:07:56Z

Hassan saad: Created page with "{{Useful Function}}<lowercasetitle/> __NOTOC__ This useful client function draws an image on any element you choose. ==Syntax== <syntaxhighlight lang="lua">boolean dxDrawImageOnElement(elem..."

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws an image on any element you choose.

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawImageOnElement(element TheElement, string Image [, int distance, int height, int width, int R, int G, int B, int alpha ] ) </syntaxhighlight>

[[File:DxDrawImageOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the image on it.
* ''Image'': The image you want. Use [[dxCreateTexture]] to create it.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the image from, it's 20 by default.
* ''height'': The height of the image, it's 1 by default.
* ''width'': The width of the image, it's 1 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawImageOnElement(TheElement,Image,distance,height,width,R,G,B,alpha)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
local width = width or 1
if (isLineOfSightClear(x, y, z, x2, y2, z2, true, false, false, false)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawMaterialLine3D(x, y, z+1+height-(distanceBetweenPoints/distance), x, y, z+height, Image, width-(distanceBetweenPoints/distance), tocolor(R or 255, G or 255, B or 255, alpha or 255))
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates an image on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2506.83423,-1684.89941,13.55648)
tag = dxCreateTexture("crown.png")

addEventHandler("onClientPreRender", root,
function()
dxDrawImageOnElement(randomPed,tag)
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates an image on all the vehicles in the game.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local tag = dxCreateTexture("bike.png")

addEventHandler("onClientPreRender", root,
function()
for k,v in ipairs(getElementsByType("vehicle")) do
dxDrawImageOnElement(v,tag)
end
end)
</syntaxhighlight>
</section>

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

File:DxDrawImageOnElement.png

2016-02-01T14:57:12Z

Hassan saad:

DxDrawTextOnElement

2016-02-01T13:02:16Z

Hassan saad: /* Function source */

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws a text on any element you choose.

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element TheElement, string text [, int height, int distance, int R, int G, int B, int alpha, int size, string font ] )</syntaxhighlight>
[[Image:dxDrawTextOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the text on it.
* ''text'': The text you want.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the text from, it's 20 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.
* ''size'': The size of the text, it's 1 by default.
* ''font'': Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
It's arial by default.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTextOnElement(TheElement,text,height,distance,R,G,B,alpha,size,font)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
local height = height or 1
if (isLineOfSightClear(x, y, z, x2, y2, z2, true, true, false, true)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawText(text, sx+2, sy+2, sx, sy, tocolor(R or 255, G or 255, B or 255, alpha or 255), (size or 1)-(distanceBetweenPoints / distance), font or "arial", "center", "center")
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates a text on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2476.91406,-1665.31799,13.32435)

addEventHandler("onClientRender", getRootElement(),
function ()
dxDrawTextOnElement(randomPed,"SWATTEAM Officer",1,20,0,0,255,255,1,"pricedown")
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates a text 'HassoN' on all the players are in a team named HassoN.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", getRootElement(),
function ()
for k,v in ipairs(getElementsByType("player")) do
if getPlayerTeam(v) == getTeamFromName("HassoN") then
if v == localPlayer then return end
dxDrawTextOnElement(v,"HassoN",1,20,0,0,255,255,1,"arial")
end
end
end)
</syntaxhighlight>
</section>

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

User:Hassan saad

2016-02-01T11:59:33Z

Hassan saad: Created page with "Hello there! Welcome to my own profile page. Feel free to contact me on Skype: '''''hassan.saad2000''''' for any scripting related stuff. '''''Some of my works:''''' Conve..."

DxDrawTextOnElement

2016-01-31T21:43:44Z

Hassan saad: Created page with "{{Useful Function}}<lowercasetitle/> __NOTOC__ This useful client function draws a text on any element you choose. ==Syntax== <syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element..."

{{Useful Function}}<lowercasetitle/>
__NOTOC__
This useful client function draws a text on any element you choose.

==Syntax==
<syntaxhighlight lang="lua">boolean dxDrawTextOnElement(element TheElement, string text [, int height, int distance, int R, int G, int B, int alpha, int size, string font ] )</syntaxhighlight>
[[Image:dxDrawTextOnElement.png|thumb|Example of how it should looks like.|284x230px]]

==Required arguments==
* ''TheElement'': The element you want to draw the text on it.
* ''text'': The text you want.

==Optional arguments==
* ''height'': The height of the text, it's 1 by default.
* ''distance'': The distance you will be able to view the text from, it's 20 by default.
* ''R'': The Red color code (0-255), it's 255 by default.
* ''G'': The Green color code (0-255), it's 255 by default.
* ''B'': The Blue color code (0-255), it's 255 by default.
* ''alpha'': The alpha of the text, it's 255 by default.
* ''size'': The size of the text, it's 1 by default.
* ''font'': Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
It's arial by default.

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

==Function source==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTextOnElement(TheElement,text,height,distance,R,G,B,alpha,size,font)
local x, y, z = getElementPosition(TheElement)
local x2, y2, z2 = getElementPosition(localPlayer)
local distance = distance or 20
if (isLineOfSightClear(x, y, z, x2, y2, z2, true, true, false, true)) then
local sx, sy = getScreenFromWorldPosition(x, y, z+height or 1)
if(sx) and (sy) then
local distanceBetweenPoints = getDistanceBetweenPoints3D(x, y, z, x2, y2, z2)
if(distanceBetweenPoints < distance) then
dxDrawText(text, sx+2, sy+2, sx, sy, tocolor(R or 255, G or 255, B or 255, alpha or 255), (size or 1)-(distanceBetweenPoints / distance), font or "arial", "center", "center")
end
end
end
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.
*Skype: ''hassan.saad2000''

==Example #1==
This example creates a text on a random ped in the Grove street.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
randomPed = createPed(285,2476.91406,-1665.31799,13.32435)

addEventHandler("onClientRender", getRootElement(),
function ()
dxDrawTextOnElement(randomPed,"SWATTEAM Officer",1,20,0,0,255,255,1,"pricedown")
end)
</syntaxhighlight>
</section>

==Example #2==
This example creates a text 'HassoN' on all the players are in a team named HassoN.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", getRootElement(),
function ()
for k,v in ipairs(getElementsByType("player")) do
if getPlayerTeam(v) == getTeamFromName("HassoN") then
if v == localPlayer then return end
dxDrawTextOnElement(v,"HassoN",1,20,0,0,255,255,1,"arial")
end
end
end)
</syntaxhighlight>
</section>

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

File:DxDrawTextOnElement.png

2016-01-31T21:38:19Z

Hassan saad:

RenameAclGroup

2014-08-29T23:06:07Z

Hassan saad: /* Example */

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup(string old , string new )</syntaxhighlight>

==Required arguments==
* ''old '': old name of acl group you want to change
* ''new '': the new name of acl group

==Function source==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(old,new)
if (type(old) ~= "string" ) then
outputDebugString("Bad argument 1 @ renameAclGroup [ string expected, got " .. type(old) .. "] ",2)
end
if (type(new) ~= "string" ) then
outputDebugString("Bad argument 2 @ renameAclGroup [ string expected, got " .. type(new) .. "] ",2)
end
if (not aclGetGroup(old) ) then
return outputDebugString("Bad argument 1 @ renameAclGroup [ we cant found this Group Name ] ",2)
end
if ( aclGetGroup(new) ) then
return outputDebugString("Bad argument 2 @ renameAclGroup [ already there is this group Name ] ",2)
end
oldObjects = aclGroupListObjects(aclGetGroup(old))
oldacl = aclGroupListACL(aclGetGroup(old))
aclDestroyGroup(aclGetGroup (old))
aclCreateGroup(new)
for Ha,nameofacl in pairs(oldacl) do
aclGroupAddACL(aclGetGroup(new),nameofacl)
end
for Yo,nameofObject in pairs(oldObjects) do
aclGroupAddObject(aclGetGroup(new),nameofObject)
end
aclSave ()
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.

==Example==
this Example change Group the Name of Group Moderator From "Moderator" to "HassoN"

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
setTimer( function ()
renameAclGroup("Moderator","HassoN")
end,5000,1)
</syntaxhighlight>
</section>

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

RenameAclGroup

2014-08-29T22:53:21Z

Hassan saad: /* Function source */

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup(string old , string new )</syntaxhighlight>

==Required arguments==
* ''old '': old name of acl group you want to change
* ''new '': the new name of acl group

==Function source==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(old,new)
if (type(old) ~= "string" ) then
outputDebugString("Bad argument 1 @ renameAclGroup [ string expected, got " .. type(old) .. "] ",2)
end
if (type(new) ~= "string" ) then
outputDebugString("Bad argument 2 @ renameAclGroup [ string expected, got " .. type(new) .. "] ",2)
end
if (not aclGetGroup(old) ) then
return outputDebugString("Bad argument 1 @ renameAclGroup [ we cant found this Group Name ] ",2)
end
if ( aclGetGroup(new) ) then
return outputDebugString("Bad argument 2 @ renameAclGroup [ already there is this group Name ] ",2)
end
oldObjects = aclGroupListObjects(aclGetGroup(old))
oldacl = aclGroupListACL(aclGetGroup(old))
aclDestroyGroup(aclGetGroup (old))
aclCreateGroup(new)
for Ha,nameofacl in pairs(oldacl) do
aclGroupAddACL(aclGetGroup(new),nameofacl)
end
for Yo,nameofObject in pairs(oldObjects) do
aclGroupAddObject(aclGetGroup(new),nameofObject)
end
aclSave ()
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.

==Example==
this Example change Group the Name of Group Admin From "Admin" to "HassoN"

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
setTimer( function ()
renameAclGroup("Admin","HassoN")
end,5000,1)
</syntaxhighlight>
</section>

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

RenameAclGroup

2014-08-29T20:36:58Z

Hassan saad: /* Example */

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup(string old , string new )</syntaxhighlight>

==Required arguments==
* ''old '': old name of acl group you want to change
* ''new '': the new name of acl group

==Function source==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(old,new)
if (type(old) ~= "string" ) then
outputDebugString("Bad argument 1 @ renameAclGroup [ string expected, got " .. type(old) .. "] ",2)
end
if (type(new) ~= "string" ) then
outputDebugString("Bad argument 2 @ renameAclGroup [ string expected, got " .. type(new) .. "] ",2)
end
if aclGetGroup(old) then
oldObjects = aclGroupListObjects(aclGetGroup(old))
oldacl = aclGroupListACL(aclGetGroup(old))
aclDestroyGroup(aclGetGroup (old))
aclCreateGroup(new)
end
for Ha,nameofacl in pairs(oldacl) do
aclGroupAddACL(aclGetGroup(new),nameofacl)
end
for Yo,nameofObject in pairs(oldObjects) do
aclGroupAddObject(aclGetGroup(new),nameofObject)
end
aclSave ()
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.

==Example==
this Example change Group the Name of Group Admin From "Admin" to "HassoN"

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
setTimer( function ()
renameAclGroup("Admin","HassoN")
end,5000,1)
</syntaxhighlight>
</section>

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

RenameAclGroup

2014-08-29T20:06:25Z

Hassan saad: this function is changed the acl Group Name..

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup(string old , string new )</syntaxhighlight>

==Required arguments==
* ''old '': old name of acl group you want to change
* ''new '': the new name of acl group

==Function source==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(old,new)
if (type(old) ~= "string" ) then
outputDebugString("Bad argument 1 @ renameAclGroup [ string expected, got " .. type(old) .. "] ",2)
end
if (type(new) ~= "string" ) then
outputDebugString("Bad argument 2 @ renameAclGroup [ string expected, got " .. type(new) .. "] ",2)
end
if aclGetGroup(old) then
oldObjects = aclGroupListObjects(aclGetGroup(old))
oldacl = aclGroupListACL(aclGetGroup(old))
aclDestroyGroup(aclGetGroup (old))
aclCreateGroup(new)
end
for Ha,nameofacl in pairs(oldacl) do
aclGroupAddACL(aclGetGroup(new),nameofacl)
end
for Yo,nameofObject in pairs(oldObjects) do
aclGroupAddObject(aclGetGroup(new),nameofObject)
end
aclSave ()
end
</syntaxhighlight>
</section>
*Original author: ''Has[S]oN''.

==Example==
this Example change Group the Name of Group Console From "Console" to "HassoN"

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
setTimer( function ()
renameAclGroup("Console","HassoN")
end,5000,1)
</syntaxhighlight>
</section>

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

Useful Functions/convertWordsToSound

2014-08-24T21:52:08Z

Hassan saad: Hassan saad moved page Useful Functions/convertWordsToSound to Multi Theft Auto: Wiki:Useful Functions/convertWordsToSound

#REDIRECT [[Multi Theft Auto: Wiki:Useful Functions/convertWordsToSound]]

ConvertTextToSpeech

2014-08-24T21:52:08Z

Hassan saad: Hassan saad moved page Useful Functions/convertWordsToSound to Multi Theft Auto: Wiki:Useful Functions/convertWordsToSound

'''
== * convertWordsToSound ==
'''

*only Server Side
*Author: Has[S]oN

Syntax:
----
<syntaxhighlight lang="lua">convertWordsToSound(string text)</syntaxhighlight>

'''
== Required Arguments: ==
'''

* text: the Text you want to convert it from word to sound
'''

== Code: ==
'''

<syntaxhighlight lang="lua">--Server Side

function convertWordsToSound(str)
local str2 = ""
str2 = "http://translate.google.com/translate_tts?tl=en&q="..str..""
triggerClientEvent(source,"VoiceClient",source,str2)
end

--Client Side

function sayVoice(str)
currentVoice = playSound(str)
end
addEvent("VoiceClient",true)
addEventHandler("VoiceClient",localPlayer,sayVoice)
</syntaxhighlight>

'''
== Example: ==
'''

'''Server Side:'''

<syntaxhighlight lang="lua">function convertWordsToSound(str)
local str2 = ""
str2 = "http://translate.google.com/translate_tts?tl=en&q="..str..""
triggerClientEvent(source,"VoiceClient",source,str2)
end

addEventHandler("onPlayerChat",root,
function (messag)
convertWordsToSound(messag)
end)</syntaxhighlight>

Client Side:

<syntaxhighlight lang="lua">function sayVoice(str)
currentVoice = playSound(str)
end
addEvent("VoiceClient",true)
addEventHandler("VoiceClient",localPlayer,sayVoice)</syntaxhighlight>

----

Of course the function Very clear from his name
convert any word to sound

For do the function work with arabic please replace

<syntaxhighlight lang="lua">str2 = "http://translate.google.com/translate_tts?tl=en&q="..str..""</syntaxhighlight>

to

<syntaxhighlight lang="lua">str2 = "http://translate.google.com/translate_tts?tl=ar&q="..str..""</syntaxhighlight>

thx and sorry for bad english :)

ConvertTextToSpeech

2014-08-24T21:46:18Z

Hassan saad: this function is convert any word to sound

AR/createBlip

2014-07-29T22:15:58Z

Hassan saad: /* Example */

__NOTOC__
{{Server client function}}
هذه الوظيفة تقوم بعمل أيقونة في الخريطة تراها في الرادار مثل الأيقونات الموجوده على الاعبين

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z, [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>

===Required Arguments===
*'''x:''' للأيقونة x احداثيات الـ
*'''y:''' للأيقونة y احداثيات الـ
*'''z:''' للأيقونة z احداثيات الـ

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' شكل الأيقونة اختارها من الارقام التالية
{{Blip_Icons}}
*'''size:''' حجم العلامة و الحجم الافتراضي 2
*'''r:''' مقدار لون العلامة الاحمر من 0 الى 255. المقدار الافتراضي هو 255
*'''g:''' مقدار لون العلامة الاخضر من 0 الى 255. المقدار الافتراضي هو 0
*'''b:''' مقدار لون العلامة الازرق من 0 الى 255. المقدار الافتراضي هو 0
*'''a:''' مقدار الوضوح للعلامة من 0 الى 255. المقدار البدائي هو 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
}}
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255,
int ordering=0, float visibleDistance ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' للأيقونة x احداثيات الـ
*'''y:''' للأيقونة y احداثيات الـ
*'''z:''' للأيقونة z احداثيات الـ

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' شكل الأيقونة اختارها من الارقام التالية
{{Blip_Icons}}
*'''size:''' حجم العلامة و الحجم الافتراضي هو 2
*'''r:''' مقدار لون العلامة الاحمر من 0 الى 255. المقدار الافتراضي هو 255
*'''g:''' مقدار لون العلامة الاخضر من 0 الى 255. المقدار الافتراضي هو 0
*'''b:''' مقدار لون العلامة الازرق من 0 الى 255. المقدار الافتراضي هو 0
*'''a:''' مقدار الوضوح للعلامة من 0 الى 255. المقدار البدائي هو 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 an [[element]] of the [[blip]] if it was created successfully, ''false'' otherwise.

==مثال==
<section name="Server" class="server" show="true">
'''Example 1:''' هذا المثال تقوم بصنع علامة على لاعب عشوائي يتظهر العلامة للاعب فقط
<syntaxhighlight lang="lua">
myPlayer = getRandomPlayer () -- احضار لاعب عشوائي
x,y,z = getElementPosition ( myPlayer ) -- حضار احداثيات الاعب
myBlip = createBlip ( x, y, z, 52, 0, 0, 0, 255, myPlayer ) -- صنع علامة نقود على احداثيات الاعب
</syntaxhighlight>

'''Example 2:''' This example attaches a blip to a player. You can attach a blip to an element by just setting the blip's parent to that element.
<syntaxhighlight lang="lua">
-- Pick a random player
myPlayer = getRandomPlayer ()
-- Create a radar blip in the middle of the map
myBlip = createBlip ( 0, 0, 0 )
-- Make the player the parent of the blip, so that the blip follows the player around
setElementParent ( myBlip, myPlayer )
</syntaxhighlight>

'''Example 3:''' هذا المثال يقول بصنع علامة في احداثيات 0,0,0
<syntaxhighlight lang="lua">
createBlip ( 0 , 0 , 0 , 37 ) -- صنع علامة في احداثيات 0,0,0
</syntaxhighlight>
</section>

==See Also==
{{AR/Blip_functions}}

[[en:CreateBlip]]

AR/setSoundEffectEnabled

2014-07-29T22:13:14Z

Hassan saad: /* Example */

__NOTOC__
{{Client function}}
Used to enable or disable specific sound effects.
{{New_feature|3.0139|1.3.2|
Use a player element to control a players voice with this function.
}}
==Syntax==
<syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool bEnable )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.
*'''effectName:''' the effect you want to enable or disable
{{Sound_Effects}}
*'''bEnable:''' ''true'' if you want to enable the effect, ''false'' if you want to disable it.

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

==مثال==
This example creates a sound and set's the flanger sound effect enabled.
<syntaxhighlight lang="lua">addCommandHandler("flanger",function(cmd,enabled)
if(isElement(waterSplashes))then
setSoundEffectEnabled(waterSplashes,cmd,enabled)
else
waterSplashes = playSound("splashes.mp3",true)
setSoundEffectEnabled(waterSplashes,cmd,enabled)
end
end,true) --set it case sensitive as we are going to get the command name and use it in the setSoundEffectEnabled
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==أنظر أيضاً==
{{AR/Audio_functions}}