https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=J.ChaikosMulti Theft Auto: Wiki - User contributions [en]2026-05-11T06:54:08ZUser contributionsMediaWiki 1.39.3https://wiki.multitheftauto.com/index.php?title=OnClientTrailerDetach&diff=82154OnClientTrailerDetach2025-06-11T19:41:40Z<p>J.Chaikos: No player attribute clienside</p>
<hr />
<div>{{Client event}}<br />
__NOTOC__<br />
This event is triggered when a trailer gets detached from its towing vehicle.<br />
<br />
==Parameters==<br />
<syntaxhighlight lang="lua"><br />
vehicle towedBy<br />
</syntaxhighlight><br />
*'''towedBy:''' the vehicle that was towing the trailer.<br />
<br />
==Source==<br />
The source of this event is the trailer that is now detached.<br />
<br />
==Example== <br />
This example outputs to the player that's towing the trailer that "The vehicle is now detached". (TESTED!)<br />
<syntaxhighlight lang="lua">addEventHandler("onClientTrailerDetach",root,function(towedBy)<br />
player = getVehicleOccupant(towedBy,0)<br />
outputChatBox("The vehicle is now detached.")<br />
end)</syntaxhighlight><br />
<br />
==See Also==<br />
===Client vehicle events===<br />
{{Client_vehicle_events}}<br />
===Client event functions===<br />
{{Client_event_functions}}<br />
[[es:onClientTrailerDetach]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=EngineStreamingGetMemorySize&diff=81604EngineStreamingGetMemorySize2025-01-01T10:28:14Z<p>J.Chaikos: incorrect function name</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New feature/item|3.0160|1.6.0|21874|Gets the maximum amount of RAM [in bytes] that can be used for streaming}}<br />
{{Tip|The `showmemstat` command can be used to see this value in real-time [You might have to scroll down using PgDown on your keyboard]}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
int engineStreamingGetMemorySize()<br />
</syntaxhighlight><br />
{{OOP||[[EngineStreaming]]:getMemorySize|memorySize|engineStreamingSetMemorySize}}<br />
<br />
===Returns===<br />
The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number.<br />
<br />
==Example==<br />
This example adds a command that can be used to change the streaming memory size, and display the previous value.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("ssms", function(_, sizeMB)<br />
if tonumber(sizeMB) then<br />
outputChatBox("The maximum streaming memory available has been changed from " .. math.floor(engineStreamingGetMemorySize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB") <br />
engineStreamingSetMemorySize(tonumber(sizeMB) * 1024 * 1024) -- Convert MB to Bytes<br />
else<br />
outputChatBox("Please enter a numeric value!")<br />
end<br />
end, false, false)<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Engine functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=EngineStreamingGetMemorySize&diff=81603EngineStreamingGetMemorySize2025-01-01T10:26:55Z<p>J.Chaikos: the compiler gives a nil value error for the outputChatbox function</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New feature/item|3.0160|1.6.0|21874|Gets the maximum amount of RAM [in bytes] that can be used for streaming}}<br />
{{Tip|The `showmemstat` command can be used to see this value in real-time [You might have to scroll down using PgDown on your keyboard]}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
int engineStreamingGetMemorySize()<br />
</syntaxhighlight><br />
{{OOP||[[EngineStreaming]]:getMemorySize|memorySize|engineStreamingSetMemorySize}}<br />
<br />
===Returns===<br />
The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number.<br />
<br />
==Example==<br />
This example adds a command that can be used to change the streaming memory size, and display the previous value.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("ssms", function(_, sizeMB)<br />
if tonumber(sizeMB) then<br />
outputChatBox("The maximum streaming memory available has been changed from " .. math.floor(engineGetStreamingMemorySize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB") <br />
engineStreamingSetMemorySize(tonumber(sizeMB) * 1024 * 1024) -- Convert MB to Bytes<br />
else<br />
outputChatBox("Please enter a numeric value!")<br />
end<br />
end, false, false)<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Engine functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=SetElementSpeed&diff=63478SetElementSpeed2019-07-27T05:25:52Z<p>J.Chaikos: When I'm use 'kph', I have only errors</p>
<hr />
<div>__NOTOC__<br />
{{Useful Function}}<br />
This function allows you to set '''moving''' element speed in kph or mph units.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theElement''': Element you want to set speed of<br />
<br />
===Optional Arguments===<br />
{{OptionalArg}}<br />
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.<br />
* '''speed''': Speed in selected unit<br />
<br />
==Code==<br />
{{RequiredFunctions|getElementSpeed}}<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function setElementSpeed(element, unit, speed)<br />
local unit = unit or 0<br />
local speed = tonumber(speed) or 0<br />
local acSpeed = getElementSpeed(element, unit)<br />
if (acSpeed) then -- if true - element is valid, no need to check again<br />
local diff = speed/acSpeed<br />
if diff ~= diff then return false end -- if the number is a 'NaN' return false.<br />
local x, y, z = getElementVelocity(element)<br />
return setElementVelocity(element, x*diff, y*diff, z*diff)<br />
end<br />
<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Server-side example" class="server" show="true"><br />
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("setmyspeed",<br />
function (player, cmd, arg1)<br />
local veh = getPedOccupiedVehicle(player)<br />
if (veh) then<br />
setElementSpeed(veh, "km/h", tonumber(arg1))<br />
else<br />
outputChatBox("You have to sit in vehicle", player)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
By '''varez'''.<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=60259GetCursorMovedOn2018-11-04T10:13:53Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
author '''nL~J.Chaikos'''<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = "nil",<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMoved)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example rotate camera around vehicle by mouse.<br />
<syntaxhighlight lang="lua"><br />
local isSpectating = false<br />
local facing = 0<br />
local vehicle = createVehicle(400, 0, 0, 6)<br />
<br />
function resetViewMode ()<br />
isSpectating = not isSpectating<br />
if isSpectating == false then<br />
setCameraTarget(localPlayer)<br />
end<br />
end <br />
addCommandHandler( "resetViewMode", resetViewMode )<br />
<br />
function spectateVehicle ()<br />
if isSpectating == false then return end<br />
<br />
local x, y, z = getElementPosition(vehicle)<br />
local camX = x + math.cos( facing / math.pi * 180 ) * 5<br />
local camY = y + math.sin( facing / math.pi * 180 ) * 5<br />
setCameraMatrix( camX, camY, z+1, x, y, z )<br />
local turn = getCursorMoveOn()<br />
<br />
if turn == "right" then<br />
facing = facing + 0.00025<br />
elseif turn == "left" then<br />
facing = facing - 0.00025<br />
end<br />
end<br />
addEventHandler("onClientRender", getRootElement(), spectateVehicle)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=54116GetCursorMovedOn2018-03-16T15:11:13Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
author '''nL~J.Chaikos'''<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = "nil",<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMoved)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example rotate camera around vehicle by mouse.<br />
<syntaxhighlight lang="lua"><br />
local isSpectating = false<br />
local facing = 0<br />
local vehicle = createVehicle(400, 0, 0, 6)<br />
<br />
function resetViewMode ()<br />
isSpectating = not isSpectating<br />
if isSpectating == false then<br />
setCameraTarget(localPlayer)<br />
end<br />
end <br />
<br />
function spectateVehicle ()<br />
if isSpectating == false then return end<br />
<br />
local x, y, z = getElementPosition(vehicle)<br />
local camX = x + math.cos( facing / math.pi * 180 ) * 5<br />
local camY = y + math.sin( facing / math.pi * 180 ) * 5<br />
setCameraMatrix( camX, camY, z+1, x, y, z )<br />
local turn = getCursorMoveOn()<br />
<br />
if turn == "right" then<br />
facing = facing + 0.00025<br />
elseif turn == "left" then<br />
facing = facing - 0.00025<br />
end<br />
end<br />
addEventHandler("onClientRender", getRootElement(), spectateVehicle)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=RU/getAccounts&diff=53199RU/getAccounts2017-12-22T17:27:04Z<p>J.Chaikos: /* Пример использования */</p>
<hr />
<div>__NOTOC__<br />
{{RU/Server function}}<br />
Эта функция получает таблицу cо всеми [[RU/Account|аккаунтами]], находящимися в ''internal.db'' (''accounts.xml'' не используется после версии 1.0.4)<br />
==Синтаксис==<br />
<syntaxhighlight lang="lua"><br />
table getAccounts()<br />
</syntaxhighlight><br />
{{RU/OOP|Эта функция является статической функцией класса account.|[[RU/Account|Account]].getAll||}}<br />
===Возвращаемые значения===<br />
[[RU/Table|Таблицу]] со всеми аккаунтами, находящимися в ''internal.db''. Эта таблица может быть пустой.<br />
<br />
==Пример использования==<br />
<section name="Сервер" class="server" show="true"> <br />
<syntaxhighlight lang="lua"><br />
function printAmountOfAccounts(thePlayer)<br />
local accountTable = getAccounts() --возвращает таблицу со всеми аккаунтами сервера<br />
if(#accountTable) == 0 then --если массив пуст<br />
outputChatBox("В базе данных нет аккаунтов", thePlayer)<br />
else --если массив не пуст<br />
outputChatBox("Всего " .. #accountTable .. " аккаунтов зарегистрировано в базе данных", thePlayer)<br />
end<br />
end<br />
addCommandHandler("accountcount", printAmountOfAccounts)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Смотрите также==<br />
{{RU/Account functions}}<br />
<br />
[[en:getAccounts]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=RU/getAccounts&diff=53198RU/getAccounts2017-12-22T17:25:40Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
{{RU/Server function}}<br />
Эта функция получает таблицу cо всеми [[RU/Account|аккаунтами]], находящимися в ''internal.db'' (''accounts.xml'' не используется после версии 1.0.4)<br />
==Синтаксис==<br />
<syntaxhighlight lang="lua"><br />
table getAccounts()<br />
</syntaxhighlight><br />
{{RU/OOP|Эта функция является статической функцией класса account.|[[RU/Account|Account]].getAll||}}<br />
===Возвращаемые значения===<br />
[[RU/Table|Таблицу]] со всеми аккаунтами, находящимися в ''internal.db''. Эта таблица может быть пустой.<br />
<br />
==Пример использования==<br />
<section name="Сервер" class="server" show="false"> <br />
<syntaxhighlight lang="lua"><br />
function printAmountOfAccounts(thePlayer)<br />
local accountTable = getAccounts() --возвращает таблицу со всеми аккаунтами сервера<br />
if(#accountTable) == 0 then --если массив пуст<br />
outputChatBox("В базе данных нет аккаунтов", thePlayer)<br />
else --если массив не пуст<br />
outputChatBox("Всего " .. #accountTable .. " аккаунтов зарегистрировано в базе данных", thePlayer)<br />
end<br />
end<br />
addCommandHandler("accountcount", printAmountOfAccounts)<br />
</syntaxhighlight><br />
</section> <br />
<br />
==Смотрите также==<br />
{{RU/Account functions}}<br />
<br />
[[en:getAccounts]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=OnClientPlayerHitByWaterCannon&diff=52917OnClientPlayerHitByWaterCannon2017-11-25T17:37:16Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
{{Client event}}<br />
This event is fired when a player is hit by a water cannon.<br />
{{Note|This event is only triggered for players that are streamed in}}<br />
==Parameters==<br />
<syntaxhighlight lang="lua"><br />
player playerHit<br />
</syntaxhighlight><br />
*'''playerHit:''' the player which got shot by the water cannon<br />
<br />
==Source==<br />
The source of this event is the vehicle who shot the water cannon.<br />
<br />
==Type==<br />
This event is a pre reaction event meaning it occurs before any game level reaction to the collision which include:<br />
* Players flying off<br />
* Players being knocked down<br />
<br />
==Cancel effect==<br />
If this event is [[Event system#Canceling|canceled]], the Player will not be knocked down<br />
<br />
==Example==<br />
<section class="client" name="Client" show="true"><br />
This example outputs a message when you are hit by a water cannon<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPlayerHitByWaterCannon",getRootElement(),<br />
function(player)<br />
local driver = getVehicleOccupant(source)<br />
if isElement(driver) then<br />
outputChatBox(getPlayerName(player).." is hit by the cannon of "..getPlayerName(driver).."'s vehicle.")<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==See Also==<br />
===Client player events===<br />
{{Client_player_events}}<br />
===Client event functions===<br />
{{Client_event_functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52916GetCursorMovedOn2017-11-24T09:37:27Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
author '''nL~J.Chaikos'''<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = "nil",<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example rotate camera around vehicle by mouse.<br />
<syntaxhighlight lang="lua"><br />
local isSpectating = false<br />
local facing = 0<br />
local vehicle = createVehicle(400, 0, 0, 6)<br />
<br />
function resetViewMode ()<br />
isSpectating = not isSpectating<br />
if isSpectating == false then<br />
setCameraTarget(localPlayer)<br />
end<br />
end <br />
<br />
function spectateVehicle ()<br />
if isSpectating == false then return end<br />
<br />
local x, y, z = getElementPosition(vehicle)<br />
local camX = x + math.cos( facing / math.pi * 180 ) * 5<br />
local camY = y + math.sin( facing / math.pi * 180 ) * 5<br />
setCameraMatrix( camX, camY, z+1, x, y, z )<br />
local turn = getCursorMoveOn()<br />
<br />
if turn == "right" then<br />
facing = facing + 0.00025<br />
elseif turn == "left" then<br />
facing = facing - 0.00025<br />
end<br />
end<br />
addEventHandler("onClientRender", getRootElement(), spectateVehicle)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52915GetCursorMovedOn2017-11-24T09:36:48Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
author '''nL~J.Chaikos'''<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = "nil",<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example checks in which way cursor is currently moving.<br />
<syntaxhighlight lang="lua"><br />
local isSpectating = false<br />
local facing = 0<br />
local vehicle = createVehicle(400, 0, 0, 6)<br />
<br />
function resetViewMode ()<br />
isSpectating = not isSpectating<br />
if isSpectating == false then<br />
setCameraTarget(localPlayer)<br />
end<br />
end <br />
<br />
function spectateVehicle ()<br />
if isSpectating == false then return end<br />
<br />
local x, y, z = getElementPosition(vehicle)<br />
local camX = x + math.cos( facing / math.pi * 180 ) * 5<br />
local camY = y + math.sin( facing / math.pi * 180 ) * 5<br />
setCameraMatrix( camX, camY, z+1, x, y, z )<br />
local turn = getCursorMoveOn()<br />
<br />
if turn == "right" then<br />
facing = facing + 0.00025<br />
elseif turn == "left" then<br />
facing = facing - 0.00025<br />
end<br />
end<br />
addEventHandler("onClientRender", getRootElement(), spectateVehicle)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52914GetCursorMovedOn2017-11-24T09:30:17Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = "nil",<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example checks in which way cursor is currently moving.<br />
<syntaxhighlight lang="lua"><br />
bindKey ("m", "down",<br />
function()<br />
showCursor( not isCursorShowing() )<br />
end<br />
)<br />
<br />
addEventHandler("onClientCursorMove",root,<br />
function()<br />
if ( isCursorShowing() ) then<br />
moveOn = getCursorMovedOn()<br />
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
<br />
By '''nL~J.Chaikos'''.<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=52913Template:Useful Functions2017-11-24T09:27:57Z<p>J.Chaikos: /* Cursor functions */</p>
<hr />
<div>=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[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><br />
*[[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><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[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><br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from account .</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[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><br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[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><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle .</span><br />
*[[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><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Events ===<br />
*[[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><br />
<br />
=== Input functions ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Data functions === <br />
*[[Byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[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><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== GUI functions === <br />
*[[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><br />
=====Comboboxes=====<br />
*[[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><br />
=====Gridlists=====<br />
*[[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><br />
*[[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><br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[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><br />
<br />
=== Math functions ===<br />
*[[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><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[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><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
<br />
=== Ped functions ===<br />
*[[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><br />
*[[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><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[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><br />
*[[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><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getDimensionEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns id Dimension Empty .</span><br />
*[[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><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[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<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Table functions ===<br />
*[[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><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[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><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[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><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[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><br />
<br />
=== Vehicle funcions === <br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[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><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[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><br />
<br />
=== Weapon functions === <br />
*[[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><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[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><br />
*[[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><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
<br />
[[Category:Useful Functions]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52911GetCursorMovedOn2017-11-20T17:11:36Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = nil,<br />
timer = false,<br />
}<br />
<br />
function getCursorMovedOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example checks in which way cursor is currently moving.<br />
<syntaxhighlight lang="lua"><br />
bindKey ("m", "down",<br />
function()<br />
showCursor( not isCursorShowing() )<br />
end<br />
)<br />
<br />
addEventHandler("onClientCursorMove",root,<br />
function()<br />
if ( isCursorShowing() ) then<br />
moveOn = getCursorMovedOn()<br />
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
<br />
By '''nL~J.Chaikos'''.<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52910GetCursorMovedOn2017-11-20T17:10:51Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMovedOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = nil,<br />
timer = false,<br />
}<br />
<br />
function getCursorMoveOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Client-side example" class="client" show="true"><br />
This clientside example checks in which way cursor is currently moving.<br />
<syntaxhighlight lang="lua"><br />
bindKey ("m", "down",<br />
function()<br />
showCursor( not isCursorShowing() )<br />
end<br />
)<br />
<br />
addEventHandler("onClientCursorMove",root,<br />
function()<br />
if ( isCursorShowing() ) then<br />
moveOn = getCursorMovedOn()<br />
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
<br />
By '''nL~J.Chaikos'''.<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52909GetCursorMovedOn2017-11-20T17:09:52Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving, it's updated version of https://wiki.multitheftauto.com/wiki/GetCursorMoveOn.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = nil,<br />
timer = false,<br />
}<br />
<br />
function getCursorMoveOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMoved(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section></div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52908GetCursorMovedOn2017-11-20T17:08:48Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = nil,<br />
timer = false,<br />
}<br />
<br />
function getCursorMoveOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMove(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section></div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetCursorMovedOn&diff=52907GetCursorMovedOn2017-11-20T17:08:00Z<p>J.Chaikos: Created page with "{{Useful Function}} __NOTOC__ This function checks in which way the cursor is currently moving. ==Syntax== <syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlig..."</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function checks in which way the cursor is currently moving.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight><br />
<br />
===Returns===<br />
Returns "left", "right", "up" or "down", "nil" if cursor didn't move.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
local cP = {<br />
x = 0,<br />
y = 0,<br />
move = nil,<br />
timer = false,<br />
}<br />
<br />
function getCursorMoveOn()<br />
return cP.move<br />
end<br />
<br />
function onClientCursorMove(cursorX, cursorY)<br />
if not isCursorShowing() then return end<br />
<br />
if cursorX > cP.x then<br />
cP.move = "right"<br />
elseif cursorX < cP.x then<br />
cP.move = "left"<br />
elseif cursorY > cP.y then<br />
cP.move = "up"<br />
elseif cursorY < cP.y then<br />
cP.move = "down"<br />
end<br />
<br />
cP.x = cursorX<br />
cP.y = cursorY<br />
<br />
<br />
if isTimer(cP.timer) then<br />
killTimer(cP.timer)<br />
end<br />
<br />
cP.timer = setTimer(<br />
function ()<br />
cP.move = "nil"<br />
end, 50, 1<br />
)<br />
end<br />
addEventHandler("onClientCursorMove",root,onClientCursorMove)<br />
</syntaxhighlight><br />
</section></div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=OnDgsComboBoxSelect&diff=52809OnDgsComboBoxSelect2017-11-11T10:13:06Z<p>J.Chaikos: </p>
<hr />
<div>{{Client event}}<br />
__NOTOC__ <br />
This event is fired when the item of a DGS combo box is selected.<br />
<br />
==Parameters== <br />
<syntaxhighlight lang="lua"><br />
integer previous, integer current<br />
</syntaxhighlight><br />
* '''previous''': The item id that last selected.<br />
* '''current''': The item id that got selected.<br />
<br />
==Source==<br />
The [[event system#Event source|source]] of this event is the combo box element that got its item selected.<br />
<br />
==Example== <br />
This example outputs a message with the selected item when an item is selected.<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs<br />
<br />
comboBox = DGS:dgsDxCreateComboBox(500,400,200,30,false)<br />
for i=1,20 do<br />
DGS:dgsDxComboBoxAddItem(comboBox ,i)<br />
end<br />
<br />
function onSelected(previous,current)<br />
outputChatBox("Last Selection:"..(previous or "None")..";Current Selection:"..(current or "None"))<br />
end<br />
addEventHandler("onClientDgsDxComboBoxSelect",getRootElement(),onSelected)<br />
</syntaxhighlight><br />
<br />
<br />
==See Also==<br />
===DGS events===<br />
{{DGSEVENTS}}<br />
===Client event functions===<br />
{{Client_event_functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=Category:%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82&diff=50894Category:Объект2017-05-08T11:13:24Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
Класс "объект" является статической 3D моделью в мире GTA. Ими являются только созданные на сервере модели. Модели, входящие в GTA по умолчанию, объектами не являются. <br />
Примеры объектов включают создание моделей, дорог и местностей.<br />
<br />
Тип элемента этого класса '''"object"'''.<br />
<br />
==XML-синтаксис==<br />
<syntaxhighlight lang="xml"><br />
<object model="" posX="" posY="" posZ="" rotX="" rotY="" rotZ=""/><br />
</syntaxhighlight><br />
<br />
===Обязательные аргументы===<br />
* '''model''': ID обьекта - используется для упрощения поиска объектов используя getElementByID() функцию или object browser в редакторе карт.<br />
* '''posX''': Переменная типа float координата X обьекта.<br />
* '''posY''': Переменная типа float координата Y обьекта.<br />
* '''posZ''': Переменная типа float координата Z обьекта.<br />
<br />
===Дополнительные аргументы===<br />
* '''rotX''': Переменная типа float угол поворота X в градусах.<br />
* '''rotY''': Переменная типа float угол поворота Y в градусах.<br />
* '''rotZ''': Переменная типа float угол поворота Z в градусах.<br />
<br />
==Связанные функции==<br />
{{Object functions}}<br />
[[Category:Element Types]]<br />
[[Category:Incomplete]]<br />
[[en:Element/Object]]<br />
[[it:Elemento/Oggetto]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetPedTarget&diff=50893GetPedTarget2017-05-08T07:08:41Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function is used to get the element a [[ped]] is currently targeting.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
element getPedTarget ( ped thePed )<br />
</syntaxhighlight><br />
<br />
{{OOP||[[ped]]:getTarget}}<br />
===Required Arguments===<br />
*'''thePed:''' The [[ped]] whose target you want to retrieve.<br />
<br />
===Returns===<br />
Returns the [[element]] that's being targeted, or ''false'' if there isn't one.<br />
<br />
This is only effective on physical GTA elements, namely:<br />
* Players<br />
* Peds<br />
* Vehicles<br />
* Objects<br />
<br />
==Example==<br />
<section name="Server" class="server" show="true"><br />
This example blows up any vehicle a player targets (aims at).<br />
<syntaxhighlight lang="lua"><br />
function playerTargetCheck ( )<br />
local target<br />
for i, thePlayer in ipairs ( getElementsByType("player") ) do -- iterate over all players<br />
target = getPedTarget ( thePlayer ) -- get the target of the current player<br />
if ( target ) then -- if there was a target<br />
if ( getElementType ( target ) == "vehicle" ) then -- and the target is a vehicle<br />
blowVehicle ( target ) -- blow it up<br />
end<br />
end<br />
end<br />
end<br />
setTimer ( playerTargetCheck, 1000, 0 ) -- call the check function every second<br />
</syntaxhighlight><br />
''Note: A more efficient way to do this would be to use the [[onPlayerTarget]] event.''<br />
</section><br />
<br />
==See Also==<br />
{{Ped_functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=SetRadarAreaColor&diff=49899SetRadarAreaColor2016-12-04T16:11:10Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
Sets the color of an existing radar area.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setRadarAreaColor ( areaName area, int r, int g, int b, int a ) <br />
</syntaxhighlight> <br />
{{OOP||[[radararea]]:setColor}}<br />
<br />
===Required Arguments=== <br />
*'''area''' name of area, that you want to change color<br />
*'''r:''' an integer representing the amount of red in the color (0 for no red, 255 for solid red)<br />
*'''g:''' an integer representing the amount of green in the color (0 for no green, 255 for solid green)<br />
*'''b:''' an integer representing the amount of blue in the color (0 for no blue, 255 for solid blue)<br />
*'''a:''' an integer representing the color's alpha (0 for transparent, 255 for opaque)<br />
<br />
===Returns===<br />
Returns ''true'' if the color was set successfully, ''false'' if the radar area doesn't exist or the color arguments are improper.<br />
<br />
==Example== <br />
This example creates a radar area and changes its color right away:<br />
<syntaxhighlight lang="lua"><br />
someArea = createRadarArea ( 1024, 1024, 75, 100, 0, 0, 0, 255 ) -- create a black radar area<br />
local flag = setRadarAreaColor ( someArea, 255, 85, 85, 170 ) -- change its color<br />
if ( flag ) then -- if the function returned true...<br />
outputChatBox ( "Color set successfully!" )<br />
else -- if the function returned false...<br />
outputChatBox ( "Failed to set color." )<br />
end<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Radar area_functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=SetRadarAreaColor&diff=49898SetRadarAreaColor2016-12-04T16:05:45Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
Sets the color of an existing radar area.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setRadarAreaColor ( float x, float y, float x size, float y size, int r, int g, int b, int a ) <br />
</syntaxhighlight> <br />
{{OOP||[[radararea]]:setColor}}<br />
<br />
===Required Arguments=== <br />
*'''x:''' x position of your area<br />
*'''y:''' y position of your area<br />
*'''x size:''' width of your area<br />
*'''y size:''' height of your area<br />
*'''r:''' an integer representing the amount of red in the color (0 for no red, 255 for solid red)<br />
*'''g:''' an integer representing the amount of green in the color (0 for no green, 255 for solid green)<br />
*'''b:''' an integer representing the amount of blue in the color (0 for no blue, 255 for solid blue)<br />
*'''a:''' an integer representing the color's alpha (0 for transparent, 255 for opaque)<br />
<br />
===Returns===<br />
Returns ''true'' if the color was set successfully, ''false'' if the radar area doesn't exist or the color arguments are improper.<br />
<br />
==Example== <br />
This example creates a radar area and changes its color right away:<br />
<syntaxhighlight lang="lua"><br />
someArea = createRadarArea ( 1024, 1024, 75, 100, 0, 0, 0, 255 ) -- create a black radar area<br />
local flag = setRadarAreaColor ( someArea, 255, 85, 85, 170 ) -- change its color<br />
if ( flag ) then -- if the function returned true...<br />
outputChatBox ( "Color set successfully!" )<br />
else -- if the function returned false...<br />
outputChatBox ( "Failed to set color." )<br />
end<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Radar area_functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49891StopSoundSlowly2016-12-01T18:37:00Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
This function stops the [[sound]] [[element]] slowly.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': The sound element that needs to be stopped.<br />
<br />
===Returns===<br />
Returns ''true'' if the sound was successfully stopped, ''false'' if the sound is not found.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
if not isElement(sElement) then return false end<br />
local sound_timer_quant = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
local soundVolume = getSoundVolume(sElement)<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then <br />
stopSound(sElement) end<br />
end,400,sound_timer_quant*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49890StopSoundSlowly2016-12-01T18:35:26Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
This function stops the [[sound]] [[element]] slowly.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': The sound element that needs to be stopped.<br />
<br />
===Returns===<br />
Returns ''true'' if the sound was successfully stopped, ''false'' if the sound is not found.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
if not isElement(sElement) then return false end<br />
local slowlyStop = setTimer(<br />
function ()<br />
local soundVolume = getSoundVolume(sElement)<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then <br />
stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49889StopSoundSlowly2016-12-01T18:33:48Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
This function stops the [[sound]] [[element]] slowly.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': The sound element that needs to be stopped.<br />
<br />
===Returns===<br />
Returns ''true'' if the sound was successfully stopped, ''false'' if the sound is not found.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
if not isElement(sElement) then return false end<br />
local slowlyStop = setTimer(<br />
function ()<br />
local soundVolume = getSoundVolume(sElement)<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=PlaySoundFrontEnd&diff=49867PlaySoundFrontEnd2016-11-21T17:16:30Z<p>J.Chaikos: </p>
<hr />
<div>{{Server client function}}<br />
__NOTOC__<br />
This function plays a frontend sound for the specified player.<br />
{{Note|These sounds can be disabled with [[setWorldSoundEnabled]] so if these sounds stop working you should check if you're disabling the sounds.}}<br />
<br />
==Syntax== <br />
<section name="Server" class="server" show="true"><br />
<syntaxhighlight lang="lua"><br />
bool playSoundFrontEnd ( player thePlayer, int sound ) <br />
</syntaxhighlight><br />
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[player]]:playSoundFrontEnd}}}}<br />
<br />
===Required Arguments=== <br />
*'''thePlayer:''' the [[player]] you want the sound to play for.<br />
*'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are:<br />
{{Sounds}}<br />
</section><br />
<section name="Client" class="client" show="false"><br />
<syntaxhighlight lang="lua"><br />
bool playSoundFrontEnd ( int sound ) <br />
</syntaxhighlight><br />
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[Sound]].playFrontEnd}}}}<br />
<br />
===Required Arguments=== <br />
*'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are:<br />
{{Sounds}}<br />
</section><br />
<br />
===Returns===<br />
Returns ''true'' if the sound was successfully played, ''false'' otherwise.<br />
<br />
==Example==<br />
<section name="server" class="server" show="true"><br />
This example plays a sound when a player spawns.<br />
<syntaxhighlight lang="lua"><br />
function onPlayerSpawn ( theSpawnpoint, theTeam )<br />
playSoundFrontEnd ( source, 16 )<br />
end<br />
addEventHandler ( "onPlayerSpawn", root, onPlayerSpawn )<br />
</syntaxhighlight><br />
</section><br />
<section name="client" class="client" show="true"><br />
This example plays a sound when the player types the command '/sound'.<br />
<syntaxhighlight lang="lua"><br />
function onSoundEvent ( )<br />
playSoundFrontEnd ( 16 )<br />
end<br />
addCommandHandler("sound", onSoundEvent)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[de:playSoundFrontEnd]]<br />
[[ar:playSoundFrontEnd]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=PlaySoundFrontEnd&diff=49866PlaySoundFrontEnd2016-11-21T17:16:19Z<p>J.Chaikos: </p>
<hr />
<div>{{Server client function}}<br />
__NOTOC__<br />
This function plays a frontend sound for the specified player.<br />
{{Note|These sounds can be disabled with [[setWorldSoundEnabled]] so if these sounds stop working you should check if you're disabling the sounds.}}<br />
<br />
==Syntax== <br />
<section name="Server" class="server" show="true"><br />
<syntaxhighlight lang="lua"><br />
bool playSoundFrontEnd ( player thePlayer, int sound ) <br />
</syntaxhighlight><br />
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[player]]:playSoundFrontEnd}}}}<br />
<br />
===Required Arguments=== <br />
*'''thePlayer:''' the [[player]] you want the sound to play for.<br />
*'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are:<br />
{{Sounds}}<br />
</section><br />
<section name="Client" class="client" show="false"><br />
<syntaxhighlight lang="lua"><br />
bool playSoundFrontEnd ( int sound ) <br />
</syntaxhighlight><br />
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[Sound]].playFrontEnd}}}}<br />
<br />
===Required Arguments=== <br />
*'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are:<br />
{{Sounds}}<br />
</section><br />
<br />
===Returns===<br />
Returns ''true'' if the sound was successfully played, ''false'' otherwise.<br />
<br />
==Example==<br />
<section name="server" class="server" show="true"><br />
This example plays a sound when a player spawns.<br />
<syntaxhighlight lang="lua"><br />
function onPlayerSpawn ( theSpawnpoint, theTeam )<br />
playSoundFrontEnd ( source, 16 )<br />
end<br />
addEventHandler ( "onPlayerSpawn", root, onPlayerSpawn )<br />
</syntaxhighlight><br />
</section><br />
<section name="client" class="client" show="true"><br />
This example plays a sound when the player types the command '/sound'.<br />
<syntaxhighlight lang="lua"><br />
function onSoundEvent ( )<br />
playSoundFrontEnd ( 16 )<br />
end<br />
addCommandHandler("sound", привет)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[de:playSoundFrontEnd]]<br />
[[ar:playSoundFrontEnd]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetSoundSpeed&diff=49840GetSoundSpeed2016-11-11T16:22:39Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the playback speed of the specified [[sound]] [[element]].<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua">float getSoundSpeed ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:getSpeed|speed|setSoundSpeed}}<br />
===Required Arguments=== <br />
*'''theSound:''' the [[sound]] [[element]] which playback speed you want to return.<br />
<br />
===Returns===<br />
Returns an [[float]] value indicating the playback speed of the [[sound]] [[element]]. Default sound playback speed is '''1.0'''.<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function outputSpeed(soundname) <br />
local sound = playSound("sounds/"..tostring(soundname)..".mp3") --Play the sound from the sounds folder<br />
setSoundVolume(sound, 0.5) -- set the sound volume to 50%<br />
outputChatBox("The sound speed : "..getSoundSpeed(sound)) -- output the sound speed<br />
end<br />
addCommandHandler("soundspeed",outputSpeed)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:getSoundSpeed]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=GetSoundSpeed&diff=49839GetSoundSpeed2016-11-11T16:22:29Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This хуй is used to return the playback speed of the specified [[sound]] [[element]].<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua">float getSoundSpeed ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:getSpeed|speed|setSoundSpeed}}<br />
===Required Arguments=== <br />
*'''theSound:''' the [[sound]] [[element]] which playback speed you want to return.<br />
<br />
===Returns===<br />
Returns an [[float]] value indicating the playback speed of the [[sound]] [[element]]. Default sound playback speed is '''1.0'''.<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function outputSpeed(soundname) <br />
local sound = playSound("sounds/"..tostring(soundname)..".mp3") --Play the sound from the sounds folder<br />
setSoundVolume(sound, 0.5) -- set the sound volume to 50%<br />
outputChatBox("The sound speed : "..getSoundSpeed(sound)) -- output the sound speed<br />
end<br />
addCommandHandler("soundspeed",outputSpeed)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:getSoundSpeed]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=RU/getRealTime&diff=49734RU/getRealTime2016-11-01T11:21:24Z<p>J.Chaikos: </p>
<hr />
<div>{{Translate}}<br />
__NOTOC__<br />
{{RU/Server client function}}<br />
This function gets the server or client (if used client sided it returns time as set on client's computer) real time and returns it in a table. If you want to get the in-game time (shown on GTA's clock) use [[getTime]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">table getRealTime( [int seconds = current] )</syntaxhighlight><br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
{{New feature/item|3|1.0||<br />
*'''seconds:''' A count in seconds from the year 1970. Useful for storing points in time, or for retrieving time information for [[getBanTime]]. The valid range of this argument is 0 to 32,000,000,000<br />
}}<br />
<br />
===Returns===<br />
Returns a ''table'' of substrings with different time format or ''false'' if the '''seconds''' argument is out of range.<br />
<br />
{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"<br />
|'''Member'''<br />
|'''Meaning'''<br />
|'''Range'''<br />
|-<br />
|Секунды<br />
|seconds after the minute<br />
|0-61*<br />
|-<br />
|Минуты<br />
|minutes after the hour<br />
|0-59<br />
|-<br />
|Часы<br />
|hours since midnight<br />
|0-23<br />
|-<br />
|Месяца<br />
|День месяца<br />
|1-31<br />
|-<br />
|month<br />
|months since January<br />
|0-11<br />
|-<br />
|Год<br />
|years since 1900<br />
|-<br />
|День Недели<br />
|days since Sunday<br />
|0-6<br />
|-<br />
|yearday<br />
|days since January 1<br />
|0-365<br />
|-<br />
|isdst<br />
|Daylight Saving Time flag<br />
|-<br />
|timestamp<br />
|seconds since 1970 (MTA 1.1 +)<br />
|<br />
|}<br />
* tm_sec is generally 0-59. Extra range to accommodate for leap seconds in certain systems.<br />
<br />
==Example==<br />
This example outputs local time (server or client, where ever it was triggered) as hours and minutes<br />
<syntaxhighlight lang="lua"><br />
function showtime ()<br />
local time = getRealTime()<br />
local hours = time.hour<br />
local minutes = time.minute<br />
outputChatBox ( "Время сервера: "..hours..":"..minutes )<br />
end<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Utility functions}}<br />
[[en:GetRealTime]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=RU/getRealTime&diff=49733RU/getRealTime2016-11-01T11:20:50Z<p>J.Chaikos: </p>
<hr />
<div>{{Translate}}<br />
__NOTOC__<br />
{{RU/Server client function}}<br />
This function gets the server or client (if used client sided it returns time as set on client's computer) real time and returns it in a table. If you want to get the in-game time (shown on GTA's clock) use [[getTime]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">table getRealTime( [int seconds = current] )</syntaxhighlight><br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
{{New feature/item|3|1.0||<br />
*'''seconds:''' A count in seconds from the year 1970. Useful for storing points in time, or for retrieving time information for [[getBanTime]]. The valid range of this argument is 0 to 32,000,000,000<br />
}}<br />
<br />
===Returns===<br />
Returns a ''table'' of substrings with different time format or ''false'' if the '''seconds''' argument is out of range.<br />
<br />
{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"<br />
|'''Member'''<br />
|'''Meaning'''<br />
|'''Range'''<br />
|-<br />
|Секунды<br />
|seconds after the minute<br />
|0-61*<br />
|-<br />
|Минуты<br />
|minutes after the hour<br />
|0-59<br />
|-<br />
|Часы<br />
|hours since midnight<br />
|0-23<br />
|-<br />
|Месяца<br />
|day of the month<br />
|1-31<br />
|-<br />
|month<br />
|months since January<br />
|0-11<br />
|-<br />
|Год<br />
|years since 1900<br />
|-<br />
|День Недели<br />
|days since Sunday<br />
|0-6<br />
|-<br />
|yearday<br />
|days since January 1<br />
|0-365<br />
|-<br />
|isdst<br />
|Daylight Saving Time flag<br />
|-<br />
|timestamp<br />
|seconds since 1970 (MTA 1.1 +)<br />
|<br />
|}<br />
* tm_sec is generally 0-59. Extra range to accommodate for leap seconds in certain systems.<br />
<br />
==Example==<br />
This example outputs local time (server or client, where ever it was triggered) as hours and minutes<br />
<syntaxhighlight lang="lua"><br />
function showtime ()<br />
local time = getRealTime()<br />
local hours = time.hour<br />
local minutes = time.minute<br />
outputChatBox ( "Время сервера: "..hours..":"..minutes )<br />
end<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Utility functions}}<br />
[[en:GetRealTime]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49721StopSoundSlowly2016-10-29T15:22:46Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': звуковой элемент, который нужно остановить.<br />
<br />
===Returns===<br />
Вернет ''false'' в том случаи,если звуковой элемент не найден.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
if not isElement(sElement) then return false end<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=49720Template:Useful Functions2016-10-29T15:22:19Z<p>J.Chaikos: /* Sound functions */</p>
<hr />
<div>=== ACL functions ===<br />
*[[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><br />
*[[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><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[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><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[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><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[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><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle .</span><br />
*[[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><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Events ===<br />
*[[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><br />
<br />
=== Input functions ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Data functions === <br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[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><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hex color codes from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== GUI functions === <br />
*[[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><br />
=====Comboboxes=====<br />
*[[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><br />
=====Gridlists=====<br />
*[[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><br />
*[[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><br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[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><br />
<br />
=== Math functions ===<br />
*[[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><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[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><br />
<br />
=== Ped functions ===<br />
*[[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><br />
*[[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><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[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><br />
*[[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><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[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><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[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<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[SlowlyMusicStop]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Table functions ===<br />
*[[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><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[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><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[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><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[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><br />
<br />
=== Vehicle funcions === <br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[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><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[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><br />
<br />
=== Weapon functions === <br />
*[[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><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[createAnimation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[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><br />
*[[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><br />
[[Category:Useful Functions]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=49719Template:Useful Functions2016-10-29T15:21:19Z<p>J.Chaikos: /* Sound functions */</p>
<hr />
<div>=== ACL functions ===<br />
*[[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><br />
*[[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><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[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><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[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><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[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><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle .</span><br />
*[[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><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Events ===<br />
*[[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><br />
<br />
=== Input functions ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== Data functions === <br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[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><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hex color codes from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
<br />
=== GUI functions === <br />
*[[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><br />
=====Comboboxes=====<br />
*[[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><br />
=====Gridlists=====<br />
*[[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><br />
*[[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><br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[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><br />
<br />
=== Math functions ===<br />
*[[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><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[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><br />
<br />
=== Ped functions ===<br />
*[[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><br />
*[[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><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[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><br />
*[[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><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[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><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[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<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Table functions ===<br />
*[[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><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[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><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[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><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[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><br />
<br />
=== Vehicle funcions === <br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[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><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[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><br />
<br />
=== Weapon functions === <br />
*[[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><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[createAnimation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[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><br />
*[[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><br />
*[[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><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[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><br />
*[[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><br />
[[Category:Useful Functions]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49718StopSoundSlowly2016-10-29T15:19:57Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': звуковой элемент, который нужно остановить.<br />
<br />
===Returns===<br />
Вернет ''false'' в том случаи,если звуковой элемент не найден.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
if not isElement(sElement) then return false end<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49717StopSoundSlowly2016-10-29T15:16:15Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''sound''': звуковой элемент, который нужно остановить.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49716StopSoundSlowly2016-10-29T15:15:44Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''element''': звуковой элемент, который нужно остановить.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49715StopSoundSlowly2016-10-29T15:15:11Z<p>J.Chaikos: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''element''': звуковой элемент, который нужно остановить.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=StopSoundSlowly&diff=49714StopSoundSlowly2016-10-29T15:14:29Z<p>J.Chaikos: Music Stop Slowly</p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle></lowercasetitle><br />
__NOTOC__<br />
Эта функция останавливает звуковой элемент постепенно. Создается эффект затухания звукового элемента.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''element''': звуковой элемент, который нужно остановить.<br />
<br />
==Code==<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
function stopSoundSlowly (sElement)<br />
local soundVolume = getSoundVolume(sElement)<br />
local slowlyStop = setTimer(<br />
function ()<br />
setSoundVolume(sElement,soundVolume - 0.5)<br />
if soundVolume >= 0 then stopSound(sElement) end<br />
end,400,soundVolume*2<br />
)<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Server- and/or clientside Script" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
addCommandHandler("stopS",<br />
function (command,sound)<br />
stopSoundSlowly (sound)<br />
end<br />
)<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: J.Chaikos<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49713IsSoundPaused2016-10-29T14:48:14Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
Это функция используется для отображения статуса выбранного [[звукового элемента]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
Если элемент это [[игрок]], функция использует звук с микрофона игрока.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( звуковой элемент )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' Звуковой элемент, статус которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
Этот пример проверит стоит ли звуковой элемент на паузе или нет, и отобразит ответ игроку.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("Звуковой элемент на паузе!")<br />
else<br />
outputChatBox("Звуковой элемент не на паузе!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Добавлено использование звука с микрофона игрока}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49712IsSoundPaused2016-10-29T14:47:36Z<p>J.Chaikos: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
Это функция используется для отображения статуса выбранного [[звукового]] [[элемента]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
Если элемент это [[игрок]], функция использует звук с микрофона игрока.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( звуковой элемент )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' Звуковой элемент, статус которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
Этот пример проверит стоит ли звуковой элемент на паузе или нет, и отобразит ответ игроку.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("Звуковой элемент на паузе!")<br />
else<br />
outputChatBox("Звуковой элемент не на паузе!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Добавлено использование звука с микрофона игрока}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49711IsSoundPaused2016-10-29T14:44:45Z<p>J.Chaikos: /* Required Arguments */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the current pause state of the specified [[sound]] [[element]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
If the element is a [[player]], this function will use the players voice.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' Звуковой элемент, статус которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
Этот пример проверит стоит ли звуковой элемент на паузе или нет, и отобразит ответ игроку.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("Звуковой элемент на паузе!")<br />
else<br />
outputChatBox("Звуковой элемент не на паузе!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Added player element to use a players voice}}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49710IsSoundPaused2016-10-29T14:44:20Z<p>J.Chaikos: /* Syntax */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the current pause state of the specified [[sound]] [[element]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
If the element is a [[player]], this function will use the players voice.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' '''Звуковой элемент''',статус которого вы хотите вернуть. <br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
Этот пример проверит стоит ли звуковой элемент на паузе или нет, и отобразит ответ игроку.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("Звуковой элемент на паузе!")<br />
else<br />
outputChatBox("Звуковой элемент не на паузе!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Added player element to use a players voice}}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49709IsSoundPaused2016-10-29T14:42:53Z<p>J.Chaikos: /* Example */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the current pause state of the specified [[sound]] [[element]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
If the element is a [[player]], this function will use the players voice.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' the [[sound]] [[element]] которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
Этот пример проверит стоит ли звуковой элемент на паузе или нет, и отобразит ответ игроку.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("Звуковой элемент на паузе!")<br />
else<br />
outputChatBox("Звуковой элемент не на паузе!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Added player element to use a players voice}}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49708IsSoundPaused2016-10-29T14:39:23Z<p>J.Chaikos: /* Returns */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the current pause state of the specified [[sound]] [[element]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
If the element is a [[player]], this function will use the players voice.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' the [[sound]] [[element]] которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Ответ будет ''true'' если указанный звуковой элемент на паузе, ''false'' если звуковой элемент снят с паузы,или не найден.<br />
<br />
==Example== <br />
This example will check and see if the sound is paused or not, and tell the player.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("The sound is paused!")<br />
else<br />
outputChatBox("The sound is not paused!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Added player element to use a players voice}}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikoshttps://wiki.multitheftauto.com/index.php?title=IsSoundPaused&diff=49707IsSoundPaused2016-10-29T14:38:02Z<p>J.Chaikos: /* Required Arguments */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function is used to return the current pause state of the specified [[sound]] [[element]].<br />
<br />
{{New feature/item|3.0132|1.3.2||<br />
If the element is a [[player]], this function will use the players voice.<br />
}}<br />
==Syntax== <br />
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> <br />
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}<br />
===Required Arguments=== <br />
*'''theSound:''' the [[sound]] [[element]] которого вы хотите вернуть.<br />
<br />
===Returns===<br />
Returns ''true'' if the [[sound]] [[element]] is paused, ''false'' if unpaused or invalid arguments were passed.<br />
<br />
==Example== <br />
This example will check and see if the sound is paused or not, and tell the player.<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
theSound = playSound("music/song.mp3")<br />
function checkSongPause()<br />
local pause = isSoundPaused(theSound)<br />
if(pause == true) then<br />
outputChatBox("The sound is paused!")<br />
else<br />
outputChatBox("The sound is not paused!")<br />
end<br />
end<br />
addCommandHandler("checkpause", checkSongPause)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.2|Added player element to use a players voice}}<br />
<br />
==See Also==<br />
{{Client_audio_functions}}<br />
<br />
[[ar:isSoundPaused]]</div>J.Chaikos