Multi Theft Auto: Wiki - User contributions [en]

SecondsToTimeDesc

2014-01-19T13:14:21Z

Prime: Undo revision 38556 by Prime (talk)

{{Useful Function}}
{{Needs_Example}}
__NOTOC__
This function converts plain seconds-integer into a user-friendly time description.

==Syntax==
<syntaxhighlight lang="lua">string secondsToTimeDesc(int seconds)</syntaxhighlight>

===Required Arguments===
* '''seconds''': The integer of seconds to convert into a user-friendly description.

===Returns===
Returns a user-friendly-description, or an empty string if the seconds were invalid/negative.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function secondsToTimeDesc( seconds )
if seconds then
local days = 0
local hours = 0
local minutes = 0
local secs = 0
local theseconds = seconds
if theseconds >= 60*60*24 then
days = math.floor(theseconds / (60*60*24))
theseconds = theseconds - ((60*60*24)*days)
end
if theseconds >= 60*60 then
hours = math.floor(theseconds / (60*60))
theseconds = theseconds - ((60*60)*hours)
end
if theseconds >= 60 then
minutes = math.floor(theseconds / (60))
theseconds = theseconds - ((60)*minutes)
end
if theseconds >= 1 then
secs = theseconds
theseconds = theseconds - theseconds
end
local results = {}
if days > 1 then table.insert(results, days.." days") end
if days == 1 then table.insert(results, days.." day") end
if hours > 1 then table.insert(results, hours.." hours") end
if hours == 1 then table.insert(results, hours.." hour") end
if minutes > 1 then table.insert(results, minutes.." minutes") end
if minutes == 1 then table.insert(results, minutes.." minute") end
if secs > 1 then table.insert(results, secs.." seconds") end
if secs == 1 then table.insert(results, secs.." second") end
if seconds == 0 then table.insert(results, "0 seconds") end
return table.concat(results, ", "):reverse():gsub((", "):reverse(), (" and "):reverse(), 1):reverse() --Replace last ", " with an " and "
end
return ""
end
</syntaxhighlight>
</section>
Author: MrTasty

==Example==
Example required

==See Also==
{{Useful_Functions}}

SecondsToTimeDesc

2014-01-19T13:13:47Z

Prime:

{{Useful Function}}
__NOTOC__
This function converts plain seconds-integer into a user-friendly time description.

==Syntax==
<syntaxhighlight lang="lua">string secondsToTimeDesc(int seconds)</syntaxhighlight>

===Required Arguments===
* '''seconds''': The integer of seconds to convert into a user-friendly description.

===Returns===
Returns a user-friendly-description, or an empty string if the seconds were invalid/negative.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function secondsToTimeDesc( seconds )
if seconds then
local days = 0
local hours = 0
local minutes = 0
local secs = 0
local theseconds = seconds
if theseconds >= 60*60*24 then
days = math.floor(theseconds / (60*60*24))
theseconds = theseconds - ((60*60*24)*days)
end
if theseconds >= 60*60 then
hours = math.floor(theseconds / (60*60))
theseconds = theseconds - ((60*60)*hours)
end
if theseconds >= 60 then
minutes = math.floor(theseconds / (60))
theseconds = theseconds - ((60)*minutes)
end
if theseconds >= 1 then
secs = theseconds
theseconds = theseconds - theseconds
end
local results = {}
if days > 1 then table.insert(results, days.." days") end
if days == 1 then table.insert(results, days.." day") end
if hours > 1 then table.insert(results, hours.." hours") end
if hours == 1 then table.insert(results, hours.." hour") end
if minutes > 1 then table.insert(results, minutes.." minutes") end
if minutes == 1 then table.insert(results, minutes.." minute") end
if secs > 1 then table.insert(results, secs.." seconds") end
if secs == 1 then table.insert(results, secs.." second") end
if seconds == 0 then table.insert(results, "0 seconds") end
return table.concat(results, ", "):reverse():gsub((", "):reverse(), (" and "):reverse(), 1):reverse() --Replace last ", " with an " and "
end
return ""
end
</syntaxhighlight>
</section>
Author: MrTasty

==Example==
Example required

==See Also==
{{Useful_Functions}}

IT/getProjectileForce

2014-01-18T18:55:09Z

Prime:

{{IT/MainP}}
__NOTOC__
{{IT/Funzioni client}}
Questa funzione restituisce la forza del proiettile specificato.

==Sintassi==
<syntaxhighlight lang="lua">
float getProjectileForce ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' L'elemento [[IT/Elemento/Proiettile| proiettile]] la quale forza si vuole recuperare.

==Valori restituiti==
Restituisce un [[IT/Float|float]] in caso di successo, altrimenti restituisce ''false''.

==Esempio==
'''Example 1:''' This example would outputs the force of the projectile on 1-100 scale. This function just works with projectiles which you throw so just grenades, satchel charge etc
<syntaxhighlight lang="lua">

addEventHandler("onClientProjectileCreation", getRootElement(),
--The source of this event is the projectile that was created.
function ()
local getForce = getProjectileForce(source)
outputChatBox(getForce*100) -- outputs the force of the projectile on 1-100 scale
end
)
</syntaxhighlight>

==Vedere anche==
{{IT/Client projectile functions}}
[[en:getProjectileForce]]

IT/getProjectileForce

2014-01-18T18:55:01Z

Prime:

{{IT/MainP}}
__NOTOC__
{{IT/Funzioni client}}
Questa funzione restituisce la forza del proiettile specificato.

==Sintassi==
<syntaxhighlight lang="lua">
float getProjectileForce ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' L'elemento [[IT/Elemento/Proiettile| proiettile]] la quale forza si vuole recuperare.

==Valori restituiti==
Restituisce un [[IT/Float|float]] in caso di successo, altrimenti restituisce ''false''.

==Esempio==
==Example==
'''Example 1:''' This example would outputs the force of the projectile on 1-100 scale. This function just works with projectiles which you throw so just grenades, satchel charge etc
<syntaxhighlight lang="lua">

addEventHandler("onClientProjectileCreation", getRootElement(),
--The source of this event is the projectile that was created.
function ()
local getForce = getProjectileForce(source)
outputChatBox(getForce*100) -- outputs the force of the projectile on 1-100 scale
end
)
</syntaxhighlight>

==Vedere anche==
{{IT/Client projectile functions}}
[[en:getProjectileForce]]

IT/getProjectileCreator

2014-01-18T18:54:05Z

Prime:

{{IT/MainP}}
__NOTOC__
{{IT/Funzioni client}}
Questa funzione restituisce il creatore di uno specifico proiettile.

==Sintassi==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Argomenti richiesti==
*'''theProjectile:''' L'elemento [[IT/Elemento/Proiettile| proiettile]] del creatore che si vuole recuperare.

==Valori restituiti==
Restituisce l'elemento che ha creato il proiettile in caso di successo, altrimenti restituisce ''false'' .

==Esempio==
<section name="Client" class="client" show="true">
This example will output a message in the chatbox saying who created
the projectile.
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>
</section>

==Vedere anche==
{{IT/Client projectile functions}}

IsElementDoubleSided

2014-01-18T18:52:02Z

Prime:

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

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

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

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

==Example==
This example checks if the object created is breakable and if it is then breaks it.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("createObj",
function(plr, command, id)
local x, y, z = getElementPosition(plr)
local object = createObject (id, x, y, z)
if (isElementDoubleSided(object)) then -- checks if it is double sided or not
outputChatBox("The object is double sided", plr)
else
outputChatBox("The object is not double sided", plr)
end
end
)
</syntaxhighlight>
</section>

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

RU/getBanUsername

2014-01-18T18:45:31Z

Prime:

{{Translate}}
{{Server function}}
This function will return the username of the specified [[ban]] pointer.

==Syntax==
<syntaxhighlight lang="lua">
string getBanUsername ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] in which you wish to retrieve the username of.

===Returns===
Returns a ''string'' of the username if everything was successful, ''false'' if invalid arguments are specified if there was no username specified for the [[ban]].

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
local username = getBanUsername(v) -- gets the username
outputChatBox("Ban #".. i ..": "..nick.." . Username: "..username , source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanUsername]]

RU/getBanSerial

2014-01-18T18:44:25Z

Prime:

{{Translate}}
{{Server function}}
This function will return the [[serial]] of the specified [[ban]] pointer.

==Syntax==
<syntaxhighlight lang="lua">
string getBanSerial ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] you want to retrieve the serial of.

===Returns===
Returns a ''string'' of the serial if everything was successful, ''false'' if invalid arguments are specified or if there was no serial specified for the [[ban]].

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
local serial= getBanSerial(v) -- gets the serial
outputChatBox("Ban #".. i ..": "..nick.." . Serial "..serial, source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanSerial]]

RU/getBanSerial

2014-01-18T18:44:13Z

Prime:

{{Translate}}
{{Server function}}
This function will return the [[serial]] of the specified [[ban]] pointer.

==Syntax==
<syntaxhighlight lang="lua">
string getBanSerial ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] you want to retrieve the serial of.

===Returns===
Returns a ''string'' of the serial if everything was successful, ''false'' if invalid arguments are specified or if there was no serial specified for the [[ban]].

==Example==
'''Example 1:''' This example lists all the ban when someone types /listban.
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
local serial= getBanSerial(v) -- gets the serial
outputChatBox("Ban #".. i ..": "..nick.." . Serial "..serial, source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanSerial]]

RU/getBanIP

2014-01-18T18:43:01Z

Prime:

{{Translate}}
{{Server function}}
This function will return the IP of the specified [[ban]] pointer.

==Syntax==
<syntaxhighlight lang="lua">
строка getBanIP ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] который вы хотите проверить на IP

===Returns===
Возвращаем ''string'' IP если все было успешно, ''false'' если не правильный аргумент или IP [[ban]].

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
local IP= getBanIP(v) -- gets the IP
outputChatBox("Ban #".. i ..": "..nick.." . IP: "..IP, source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanIP]]

RU/getUnbanTime

2014-01-18T18:40:14Z

Prime:

{{Translate}}
{{Server function}}
This function will return the unbanning time of the specified [[ban]] pointer in '''seconds'''.

==Syntax==
<syntaxhighlight lang="lua">
int getUnbanTime ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] in which you wish to retrieve the unban time of.

===Returns===
* Returns an integer of the unbanning time in the format of seconds from the year 1970. Use in conjunction with [[getRealTime]] in order to retrieve detailed information.
* Returns '''false''' if invalid arguments are specified or if there was no unbanning time specified for the [[ban]].

==Example==
'''Example 1:''' This example lists all the ban when someone types /listban.
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
local unbanTime= getUnbanTime(v) -- time to get unban
outputChatBox("Ban #".. i ..": "..nick.." . Time to get unban "..unbanTime, source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getUnbanTime]]

RU/addBan

2014-01-18T18:32:33Z

Prime:

{{Server function}}
Эта функция добавляет в бан лист определенный IP/username/serial.

==Синтаксис==
<syntaxhighlight lang="lua">
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>
'''Note:''' Одно из трех: IP, Username или Serial должно быть указано.

===Необходимые аргументы===
*'''IP:''' IP-адрес который необходимо забанить. Если вы не хотите банить по IP, поставьте ''nil''.
'''или'''
*'''Username:''' Имя пользователя которое необходимо забанить. Если вы не хотите банить по имени пользователя, поставьте ''nil''.
'''или'''
*'''Serial:''' Серийный номер который необходимо забанить. Если вы не хотите банить по серийному номеру, поставьте ''nil''.
''' или любая их комбинация.'''

===Необязательные аргументы===
{{RU/OptionalArg}}
*'''responsibleElement:''' Элемент который отвечает за бан игрока. Это может быть игрок или корневой элемент ([[getRootElement]]()).
*'''reason:''' Причина по которой IP/username/serial будут забанены.
*'''seconds:''' Время в течение которого игрок будет забанен. Если 0 то бан будет бессрочным(вечным).

===Возвращает===
Возвращает ''true'' если IP/username/serial были успешно забанены, ''false'' если введены неверные аргументы.

==Пример==
<syntaxhighlight lang="lua">
----Если человек умерает,баним его по IP:
function AddBanFunction ()
addBan (getPlayerIP ( source ))
end
addEventHandler ("onPlayerWasted",getRootElement(),AddBanFunction )
</syntaxhighlight>
<syntaxhighlight lang="lua">
----Если человек умерает,баним его по Serial:
function AddBanFunction ()
addBan (getPlayerSerial ( source ))
end
addEventHandler ("onPlayerWasted",getRootElement(),AddBanFunction )
</syntaxhighlight>

==См. также==
{{RU/Admin functions}}
[[en:addBan]]

RU/getBanAdmin

2014-01-18T18:31:59Z

Prime:

{{Translate}}
{{Server function}}
This function will return the responsible admin (nickname of the admin) of the specified [[ban]] pointer.

==Syntax==
<syntaxhighlight lang="lua">
строка getBanAdmin ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' [[ban]] который вы хотите проверить на то,админ ли забанил человека или нет.

===Returns===
Возвращает ''string'' админа,если все было успешно, ''false'' если не правильный аргумент или параметр [[ban]].

==Пример==
'''Example 1:''' This example outputs the name of the player, the admin who banned the player and the reason.
<syntaxhighlight lang="lua">
function outputBan(ban)
local plr = getBanNick(ban) -- the player who got banned
local admin = getBanAdmin(ban) -- admin who banned the player
local reason = getBanReason(ban) -- reason for banning
if (plr and admin and reason) then
outputChatBox(plr.." has been banned by "..admin.." for "..reason, getRootElement(), 255, 0, 0) -- Outputs name of the player, admin and the reason for banning
end
end
addEventHandler("onBan", getRootElement(), outputBan) -- When a player is banned trigger the outputBan function
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanAdmin]]

RU/getBanNick

2014-01-18T18:31:13Z

Prime:

{{Translate}}
__NOTOC__
{{Server function}}
This function will return the nickname (nickname that the player had when he was banned) of the specified [[ban]] element.

==Syntax==
<syntaxhighlight lang="lua">
string getBanNick ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] element which nickname you want to return.

===Returns===
Returns a ''string'' of the nickname if everything was successfull, ''false'' if invalid arguments are specified if there was no nickname specified for the [[ban]] element.

==Пример==
'''Example 1:''' This example outputs the name of the player, the admin who banned the player and the reason.
<syntaxhighlight lang="lua">
function outputBan(ban)
local plr = getBanNick(ban) -- the player who got banned
local admin = getBanAdmin(ban) -- admin who banned the player
local reason = getBanReason(ban) -- reason for banning
if (plr and admin and reason) then
outputChatBox(plr.." has been banned by "..admin.." for "..reason, getRootElement(), 255, 0, 0) -- Outputs name of the player, admin and the reason for banning
end
end
addEventHandler("onBan", getRootElement(), outputBan) -- When a player is banned trigger the outputBan function
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBanNick]]

RU/GetBanNick

2014-01-18T18:30:38Z

Prime:

RU/getBanReason

2014-01-18T18:28:07Z

Prime:

{{Server function}}
Эта функция возвращает причину, по которй был забанен игрок.

==Синтакс==
<syntaxhighlight lang="lua">
string getBanReason ( ban theBan )
</syntaxhighlight>

===Обязазтельные Аргументы===
*'''theBan:''' [[Ban]], у которого вы хотите узнать причину.

===Возвращения===
Возвращает строку с причиной если всё успешно, ''false'' если даны неправильные аргументы или при бане не была указана причина.

==Пример==
'''Example 1:''' This example outputs the name of the player, the admin who banned the player and the reason.
<syntaxhighlight lang="lua">
function outputBan(ban)
local plr = getBanNick(ban) -- the player who got banned
local admin = getBanAdmin(ban) -- admin who banned the player
local reason = getBanReason(ban) -- reason for banning
if (plr and admin and reason) then
outputChatBox(plr.." has been banned by "..admin.." for "..reason, getRootElement(), 255, 0, 0) -- Outputs name of the player, admin and the reason for banning
end
end
addEventHandler("onBan", getRootElement(), outputBan) -- When a player is banned trigger the outputBan function
</syntaxhighlight>

==Смотрите также==
{{RU/Admin functions}}
[[en:getBanReason]]

RU/getBans

2014-01-18T18:22:21Z

Prime:

{{Translate}}
{{Server function}}
This function will return a table over all the [[ban]] values in the server.

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

===Returns===
Returns a [[table]] over all the [[ban]] pointers.

==Example==
'''Example 1:''' This example lists all the ban when someone types /listban.
<syntaxhighlight lang="lua">
addCommandHandler("listban",
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
outputChatBox("Ban #".. i ..": "..nick, source, 255, 0, 0) -- lists all the ban
end
end
)
</syntaxhighlight>

==See Also==
{{RU/Admin functions}}
[[en:getBans]]

RU/removeBan

2014-01-18T18:18:19Z

Prime:

{{Server function}}
Эта функция удаляет [[ban]].

==Синтакс==
<syntaxhighlight lang="lua">
bool removeBan ( ban theBan, [ player responsibleElement ] )
</syntaxhighlight>

===Обязательные Аргументы===
*'''theBan:''' [[Ban]], который нужно удалить.

===Необязательные Аргументы===
{{RU/OptionalArg}}
*'''responsibleElement:''' Элемент отвечающий за разбанивание игрока. Это может быть игрок или корневой элемент ([[getRootElement]]()).

===Возвращения===
Возвращает ''true'' если [[ban]] удалён, ''false'' если указаны неверные аргументы.

==Пример==
'''Example 1:''' This example removes all the ban when the resource starts
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart",resourceRoot,
function()
local allBans = getBans() --get all the bans
for i,v in ipairs(bans)do
local nick = getBanNick(v)
removeBan(v) -- removes the ban
end
end
)
</syntaxhighlight>

==Смотрите также==
{{RU/Admin functions}}
[[en:removeBan]]

SetVehicleComponentVisible

2014-01-18T18:12:15Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function sets component visibility for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''visible:''' a ''bool'' which determines if the component should be visible

===Returns===
Returns a ''bool'' indicating the visible state of the component.

==Example==
'''Example 1:''' This example gets all the component and then hides them when you get into a vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
setVehicleComponentVisible(theVeh, k, false) -- hides the component
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentRotation

2014-01-18T18:07:36Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function set component rotation for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentRotation ( vehicle theVehicle, string theComponent, float rotX, float rotY, float rotZ )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component rotation.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''rotX:''' The component's rotation around the x axis in degrees.
*'''rotY:''' The component's rotation around the y axis in degrees.
*'''rotZ:''' The component's rotation around the z axis in degrees.

===Returns===
Return ''true'' if component rotation was set successfully, ''false'' otherwise.

==Example==
'''Example 1:''' This example would change the roatation of the component when the player enters a vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local rx, ry, rz = getVehicleComponentRotation(theVeh, k) --get the rotation of the component
setVehicleComponentRotation(theVeh, k, rx+10, ry+10, rz+10) -- increases by 10 unit
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

ResetVehicleComponentRotation

2014-01-18T18:04:29Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function reset to default component rotation for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetVehicleComponentRotation ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to reset component rotation.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns ''true'' if the rotation of the component was reset, ''false'' otherwise.
==Example==
'''Example 1:''' This example would change the roatation of the component when the player enters a vehicle and resets it when you type /reset.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local rx, ry, rz = getVehicleComponentRotation(theVeh, k) --get the rotation of the component
setVehicleComponentRotation(theVeh, k, rx+10, ry+10, rz+10) -- increases by 10 unit
end
end
end
)

addCommandHandler("reset",
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
resetVehicleComponentRotation(theVeh, k) -- resets the rotation of the component
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

ResetVehicleComponentPosition

2014-01-18T18:01:46Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function reset to default component position for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetVehicleComponentPosition ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to reset component position.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns ''true'' if the position of the component was reset, ''false'' otherwise.

==Example==
'''Example 1:''' This example would change the position of the component when the player enters a vehicle and resets it when you type /reset.
<syntaxhighlight lang="lua">

addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentPosition(theVeh, k) --get the position of the component
setVehicleComponentPosition(theVeh, k, x+1, y+1, z+1) -- increases by 1 unit
end
end
end
)

addCommandHandler("reset",
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
resetVehicleComponentPosition(theVeh, k) -- resets the position of the component
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentPosition

2014-01-18T17:40:57Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function set component position for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentPosition ( vehicle theVehicle, string theComponent, float posX, float posY, float posZ )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component position.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''posX:''' The x position of this component from the center of the vehicle.
*'''posY:''' The y position of this component from the center of the vehicle.
*'''posZ:''' The z position of this component from the center of the vehicle.

===Returns===
Return ''true'' if component position was set successfully, ''false'' otherwise.

==Example==
'''Example 1:''' This example would set the position of the component.
<syntaxhighlight lang="lua">
addCommandHandler("scp", -- short for 'set component position'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentPosition(theVeh, k) --get the position of the component
setVehicleComponentPosition(theVeh, k, x+1, y+1, z+1) -- increases by 1 unit
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

RU/setWeaponAmmo

2014-01-18T17:28:53Z

Prime:

{{Server function}}
Устанавливает количество патронов в оружии.

==Синтакс==
<syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = 0] )</syntaxhighlight>

===Обязательные аргументы===
*'''thePlayer:''' [[Player]], у которого вы хотите изменить количество патронов в оружии.
*'''weapon:''' ID оружия, в котором вы хотите изменить количество патронов. Смотрите [[weapon]] ID.
*'''totalAmmo:''' Общее количество патронов.

===Необязательные аргументы===
{{RU/OptionalArg}}
{{New feature|10|1.0|
*'''ammoInClip:''' Количество патронов в обойме. Они могут быть взяты из главных патронов. Если не задано или задано 0, то количество патронов в обойме остаётся прежним.
}}

==Возвращения==
Возвращает логическое значение ''true'' или ''false'', которые говорят успешно проведена операция или нет.

==Пример==
Этот пример даёт узи и 5000 патронов при подлючении игрока.
<syntaxhighlight lang="lua">
function setWeaponAndAmmo(player)
giveWeapon(player, 28)
setWeaponAmmo(player, 28, 5000)
end

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

==Смотрите также==
{{RU/Weapon functions}}

GetVehicleComponentVisible

2014-01-18T17:26:51Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component visibility for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleComponentVisible ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns a ''bool'' indicating the visible state of the component.

==Example==
'''Example 1:''' This example would get the name and tells if the component is visible or not.
<syntaxhighlight lang="lua">
addCommandHandler("icv", -- short for 'is component visible'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local isVisible = getVehicleComponentVisible(theVeh, k) -- gets if it is visible or not
if (isVisible == true) then
outputChatBox(k.." is visible")
else
outputChatBox(k.." is not visible")
end
end
end
end
)

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentRotation

2014-01-18T17:17:58Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component rotation for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentRotation ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component rotation.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns three ''floats'' indicating the rotation of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
==Example==
'''Example 1:''' This example would get the name and the position of the components and output it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("vcr", -- short for 'vehicle component rotation'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local rx, ry, rz = getVehicleComponentRotation(theVeh, k)
outputChatBox("Rotation of "..k.." is "..rx.." "..ry.." "..rz)
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentRotation

2014-01-18T17:17:40Z

Prime:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component rotation for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentRotation ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component rotation.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns three ''floats'' indicating the rotation of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
==Example==
'''Example 1:''' This example would get the name and the position of the components and output it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("vcr", -- short for 'vehicle component rotation'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local rx, ry, rz = getVehicleComponentRotation(theVeh, k)
outputChatBox("Rotation of "..k.." is "..rx.." "..ry.." "..rz)
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentPosition

2014-01-18T17:12:28Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component position for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component position.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns three ''floats'' indicating the position of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
This example gets the name and the position of the components and outputs it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("vcp", -- short for 'vehicle component position'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentPosition(theVeh, k)
outputChatBox("Position of "..k.." is"..x.." "..y.." "..z)
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentPosition

2014-01-18T17:10:13Z

Prime: /* Example */

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component position for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component position.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns three ''floats'' indicating the position of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
'''Example 1:''' This example gets the name and the position of the components and outputs it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("vcp", -- short for 'vehicle component position'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentPosition(theVeh, k)
outputChatBox("Position of "..k.." is"..x.." "..y.." "..z)
end
end
end
)
<syntaxhighlight lang="lua">
==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentPosition

2014-01-18T17:09:23Z

Prime:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.3.1|4715|
This function get component position for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentPosition ( vehicle theVehicle, string theComponent )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component position.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns three ''floats'' indicating the position of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
'''Example 1:''' This example gets the name and the position of the components and outputs it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("vcp", -- short for 'vehicle component position'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentPosition(theVeh, k)
outputChatBox("Position of "..k.." is"..x.." "..y.." "..z)
end
end
end
)

==See Also==
{{Client_vehicle_functions}}

BreakObject

2014-01-18T16:50:07Z

Prime:

__NOTOC__
{{client function}}
This function breaks a specific object.
Note: Only breakable objects can be broken.

{{Note|This function does not support any kind of glass objects}}

==Syntax==
<syntaxhighlight lang="lua">bool breakObject ( object theObject )</syntaxhighlight>

===Required Arguments===
*'''theObject:''' An [[object]] element

===Returns===
Returns ''true'' if the object was successfully broken. ''false'' if the object is not breakable, or a wrong object was given.

==Example==
This example checks if the object created is breakable and if it is then breaks it.
<syntaxhighlight lang="lua">
addCommandHandler("createObj",
function(command, id)
local x, y, z = getElementPosition(localPlayer)
local object = createObject (id, x, y, z)
if (id) then
if isObjectBreakable(object) then
breakObject(object)
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_object_functions}}

AR/getSoundFFTData

2014-01-18T16:37:51Z

Prime:

__NOTOC__
{{Client function}}
{{New feature/item|3.0130|1.3.0|4125|
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame.
This allows things like visualisations.

a fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order
}}

Should you have any problems there is an example resource located on the resource svn here:
[https://code.google.com/p/mtasa-resources/source/browse/#svn%2Ftrunk%2F%5Bgameplay%5D%2FVisualiser Visualiser]

just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8192 and 16384

===Optional Arguments===
*'''iBands:''' Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua

===Returns===
Returns a table of floats representing the current audio frame.
Returns false if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("playsound",
function ()
local sound = playSound("wasted.mp3")
local data = getSoundWaveData(sound, 512) -- returns table
for i, v in pairs(data) do
outputChatBox(v) -- outputs the float representing the current audio frame
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

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

AR/getSoundFFTData

2014-01-18T16:37:25Z

Prime: /* Example */

__NOTOC__
{{Client function}}
{{Needs Example}}
{{New feature/item|3.0130|1.3.0|4125|
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame.
This allows things like visualisations.

a fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order
}}

Should you have any problems there is an example resource located on the resource svn here:
[https://code.google.com/p/mtasa-resources/source/browse/#svn%2Ftrunk%2F%5Bgameplay%5D%2FVisualiser Visualiser]

just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8192 and 16384

===Optional Arguments===
*'''iBands:''' Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua

===Returns===
Returns a table of floats representing the current audio frame.
Returns false if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("playsound",
function ()
local sound = playSound("wasted.mp3")
local data = getSoundWaveData(sound, 512) -- returns table
for i, v in pairs(data) do
outputChatBox(v) -- outputs the float representing the current audio frame
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

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

AR/getSoundWaveData

2014-01-18T10:51:44Z

Prime:

__NOTOC__
{{Client function}}
{{New feature/item|3.0130|1.3.0|4125|
This function gets the wave form data for an audio stream which is a table of floats representing the current audio frame as a wave.
This allows things like visualisations.
}}
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">table getSoundWaveData ( element sound, int iSamples )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8192 and 16384 and determine how many samples to return from the currently playing audio

===Returns===
Returns a table of floats representing the current audio frame waveform.
Returns false if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("playsound",
function ()
local sound = playSound("wasted.mp3")
local data = getSoundWaveData(sound, 512) -- returns table
for i, v in pairs(data) do
outputChatBox(v) -- outputs the float representing the current audio frame waveform
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

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

GetProjectileForce

2014-01-18T10:37:53Z

Prime: /* Example */

__NOTOC__
{{Client function}}
This function returns the force of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
float getProjectileForce ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which force you want to retrieve.

==Returns==
Returns a [[float]] if successful, ''false'' otherwise.

==Example==
'''Example 1:''' This example would outputs the force of the projectile on 1-100 scale. This function just works with projectiles which you throw so just grenades, satchel charge etc
<syntaxhighlight lang="lua">

addEventHandler("onClientProjectileCreation", getRootElement(),
--The source of this event is the projectile that was created.
function ()
local getForce = getProjectileForce(source)
outputChatBox(getForce*100) -- outputs the force of the projectile on 1-100 scale
end
)

</syntaxhighlight>

==See also==
{{Client projectile functions}}
[[it:getProjectileForce]]

GetProjectileForce

2014-01-18T10:36:55Z

Prime:

__NOTOC__
{{Client function}}
This function returns the force of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
float getProjectileForce ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which force you want to retrieve.

==Returns==
Returns a [[float]] if successful, ''false'' otherwise.

==Example==
<section class="client" name="Client script" show="true">
'''Example 1:''' This example would outputs the force of the projectile on 1-100 scale. This function just works with projectiles which you throw so just grenades, satchel charge etc
<syntaxhighlight lang="lua">

addEventHandler("onClientProjectileCreation", getRootElement(),
--The source of this event is the projectile that was created.
function ()
local getForce = getProjectileForce(source)
outputChatBox(getForce*100) -- outputs the force of the projectile on 1-100 scale
end
)

</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}
[[it:getProjectileForce]]

GetSoundProperties

2014-01-18T10:36:23Z

Prime: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0130|1.3.0|4097|
This function gets the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">float, float, float, bool getSoundProperties( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

===Returns===
This function returns 3 floats and a boolean value:

The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not.

==Example==
'''Example 1:''' This example would return three float values representing the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not, every 5 seconds.
<syntaxhighlight lang="lua">
local sound
local timer

addCommandHandler("playsound",
function ()
sound = playSound("wasted.mp3")
timer = setTimer(function() soundProperties(sound) end, 5000, 0)
end
)

function soundProperties(sound)
local sampleRate, tempo, pitch, isReversed = getSoundProperties(sound) --gets the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not.
outputChatBox(sampleRate.." "..tempo.." "..pitch.." "..tostring(isReversed))
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:getSoundProperties]]

GetSoundProperties

2014-01-18T10:36:09Z

Prime:

__NOTOC__
{{Client function}}
{{New feature/item|3.0130|1.3.0|4097|
This function gets the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">float, float, float, bool getSoundProperties( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

===Returns===
This function returns 3 floats and a boolean value:

The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not.

==Example==
<section class="client" name="Client script" show="true">
'''Example 1:''' This example would return three float values representing the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not, every 5 seconds.
<syntaxhighlight lang="lua">
local sound
local timer

addCommandHandler("playsound",
function ()
sound = playSound("wasted.mp3")
timer = setTimer(function() soundProperties(sound) end, 5000, 0)
end
)

function soundProperties(sound)
local sampleRate, tempo, pitch, isReversed = getSoundProperties(sound) --gets the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not.
outputChatBox(sampleRate.." "..tempo.." "..pitch.." "..tostring(isReversed))
end
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:getSoundProperties]]

SetDevelopmentMode

2014-01-18T10:34:53Z

Prime: /* Example */

__NOTOC__
{{Client function}}
This function is used to set the development mode of the client. Setting development mode allows access to special commands which can assist with script debugging.

Development mode commands:
* '''[[Client_Commands#showcol|showcol]]''': Enables colshapes to be viewed as a wireframe object.
* '''[[Client_Commands#showsound|showsound]]''': Enables world sound ids to be printed in the debug output window.

==Syntax==
<syntaxhighlight lang="lua">
bool setDevelopmentMode ( bool enable )
</syntaxhighlight>

===Required Arguments===
*'''enable ''': A boolean to indicate whether development mode is on (true) or off (false)

===Returns===
Returns ''true'' if the mode was set correctly, ''false'' otherwise.

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

==Example==
'''Example 1:''' This example would set the development mode of the client. Use /showcol [<0-1>] and /showsound [<0-1>] later to enable/disable respective funtions.
<syntaxhighlight lang="lua">
addCommandHandler( "devmode",
function ()
setDevelopmentMode ( true )
end
)
</syntaxhighlight>

==See Also==
{{Client_utility_functions}}

SetDevelopmentMode

2014-01-18T10:34:42Z

Prime: /* Example */

GetSoundProperties

2014-01-18T10:33:31Z

Prime: /* Example */

__NOTOC__
{{Client function}}
{{Needs_Example}}
{{New feature/item|3.0130|1.3.0|4097|
This function gets the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">float, float, float, bool getSoundProperties( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

===Returns===
This function returns 3 floats and a boolean value:

The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not.

==Example==
<section class="client" name="Client script" show="true">
'''Example 1:''' This example would return three float values representing the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not, every 5 seconds.
<syntaxhighlight lang="lua">
local sound
local timer

addCommandHandler("playsound",
function ()
sound = playSound("wasted.mp3")
timer = setTimer(function() soundProperties(sound) end, 5000, 0)
end
)

function soundProperties(sound)
local sampleRate, tempo, pitch, isReversed = getSoundProperties(sound) --gets the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not.
outputChatBox(sampleRate.." "..tempo.." "..pitch.." "..tostring(isReversed))
end
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:getSoundProperties]]

GetSoundProperties

2014-01-18T10:18:07Z

Prime: /* Example */

GetProjectileForce

2014-01-18T09:51:19Z

Prime: /* Example */

__NOTOC__
{{Client function}}
{{Needs_Example}}
This function returns the force of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
float getProjectileForce ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which force you want to retrieve.

==Returns==
Returns a [[float]] if successful, ''false'' otherwise.

==Example==
<section class="client" name="Client script" show="true">
'''Example 1:''' This example would outputs the force of the projectile on 1-100 scale. This function just works with projectiles which you throw so just grenades, satchel charge etc
<syntaxhighlight lang="lua">

addEventHandler("onClientProjectileCreation", getRootElement(),
--The source of this event is the projectile that was created.
function ()
local getForce = getProjectileForce(source)
outputChatBox(getForce*100) -- outputs the force of the projectile on 1-100 scale
end
)

</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}
[[it:getProjectileForce]]

SetDevelopmentMode

2014-01-18T08:42:46Z

Prime:

__NOTOC__
{{Client function}}
This function is used to set the development mode of the client. Setting development mode allows access to special commands which can assist with script debugging.

Development mode commands:
* '''[[Client_Commands#showcol|showcol]]''': Enables colshapes to be viewed as a wireframe object.
* '''[[Client_Commands#showsound|showsound]]''': Enables world sound ids to be printed in the debug output window.

==Syntax==
<syntaxhighlight lang="lua">
bool setDevelopmentMode ( bool enable )
</syntaxhighlight>

===Required Arguments===
*'''enable ''': A boolean to indicate whether development mode is on (true) or off (false)

===Returns===
Returns ''true'' if the mode was set correctly, ''false'' otherwise.

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

==Example==
<section class="client" name="Client script" show="true">
'''Example 1:''' This example would set the development mode of the client. Use /showcol [<0-1>] and /showsound [<0-1>] later to enable/disable respective funtions.
<syntaxhighlight lang="lua">
addCommandHandler( "devmode",
function ()
setDevelopmentMode ( true )
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_utility_functions}}

RemovePedClothes

2013-05-05T19:53:59Z

Prime: /* Example */

__NOTOC__
{{Server client function}}
This function is used to remove the current clothes of a certain type on a [[ped]]. It will remove them if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.

==Syntax==
<syntaxhighlight lang="lua">
bool removePedClothes ( ped thePed, int clothesType, [ string clothesTexture, string clothesModel ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed''': The [[ped]] you want to remove clothes from.
*'''clothesType''': the clothes slot/type to remove. See the [[CJ Clothes|clothes catalog]].

===Optional Arguments===
*'''clothesTexture''': (Server only) A string determining the clothes texture that will be removed. See the [[CJ Clothes|clothes catalog]].
*'''clothesModel''': (Server only) A string determining the clothes model that will be removed. See the [[CJ Clothes|clothes catalog]].

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

==Example==
<section name="Server" class="server" show="true">
This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
<syntaxhighlight lang="lua">
function addHelmetOnEnter ( vehicleEntered, seat, jacked )
if getElementModel ( vehicleEntered ) == 522 then -- if it's a nrg
addPedClothes ( source, "moto", "moto", 16 ) -- add the helmet
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), addHelmetOnEnter )

function removeHelmetOnExit ( vehicleExited, seat, jacked )
if getElementModel ( vehicleExited ) == 522 then -- if it's a nrg
removePedClothes ( source, 16, "moto", "moto" ) -- remove that helmet
end
end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), removeHelmetOnExit )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}