Multi Theft Auto: Wiki - User contributions [en]

Template:Client player functions

2016-02-25T21:03:52Z

TAPL-93:

* [[forcePlayerMap]]
* [[getLocalPlayer]]
* [[givePlayerMoney]]
* [[takePlayerMoney]]
* [[showPlayerHudComponent]]
* [[setPlayerBlurLevel]]
* [[setPlayerMoney]]
* [[setPlayerNametagColor]]
* [[setPlayerNametagShowing]]
* [[setPlayerNametagText]]
* [[getPlayerBlurLevel]]
* [[getPlayerFromName]]
* [[getPlayerMapBoundingBox]]
* [[getPlayerMoney]]
* [[getPlayerName]]
* [[getPlayerNametagColor]]
* [[getPlayerNametagText]]
* [[getPlayerPing]]
* [[getPlayerSerial]]
* [[getPlayerTeam]]
* [[getPlayerWantedLevel]]
* [[isPlayerMapForced]]
* [[isPlayerMapVisible]]
* [[isPlayerNametagShowing]]
* [[isVoiceEnabled]]
* [[isPlayerHudComponentVisible]]
<noinclude>[[Category:Functions templates]]</noinclude>

Cерийный код

2016-02-24T07:02:48Z

TAPL-93:

Серийные коды используются МТА и администраторами серверов, чтобы надежно идентифицировать компьютеры игроков.Они связывают программную и аппаратную конфигурацию.Серийные коды, имеют длинну 32 знака, и содержат буквы(латиница) и цифры.

Серийные коды наиболее часто применяются для бана игроков, поскольку компьютер с [https://ru.wikipedia.org/wiki/IP-%D0%B0%D0%B4%D1%80%D0%B5%D1%81#.D0.A1.D1.82.D0.B0.D1.82.D0.B8.D1.87.D0.B5.D1.81.D0.BA.D0.B8.D0.B5_.28.D1.81.D1.82.D0.B0.D1.82.D0.B8.D1.87.D0.BD.D1.8B.D0.B5.29_.D0.B8_.D0.B4.D0.B8.D0.BD.D0.B0.D0.BC.D0.B8.D1.87.D0.B5.D1.81.D0.BA.D0.B8.D0.B5_IP-.D0.B0.D0.B4.D1.80.D0.B5.D1.81.D0.B0 динамическим IP], может изменять IP намеренно, сделав или пересоединившись через некоторое время, но ресурсы могут дать этим кодам новое применение.

==Примечания==
Серийные коды это наиболее точная форма определения игроков в МТА. Тем не менее, вам не следует доверять им целиком: серийные коды могут быть подделаны, хотя сделать это довольно трудно, и в таком случае весьма вероятны ошибки клиента, и к глобальному бану, если для исправления этого обратятся за помощью.
Теоретически серийный код двух игроков может совпасть, но это крайне маловероятно. При этом, любой игрок может просто воспользоваться другим компьютером.

==Связанные функции==
{{RU/Serial functions}}

[[en:Serial]]
[[ru:Category:Scripting_Concepts]]

Cерийный код

2016-02-24T07:02:33Z

TAPL-93:

Cерийный код

2016-02-24T07:02:05Z

TAPL-93:

SetMarkerSize

2016-02-10T03:08:43Z

TAPL-93: Undo revision 46582 by Jaber (talk)

__NOTOC__
{{Server client function}}
This function sets the size of the specified marker.

Setting negative value will "flip" the marker, do nothing or make it invisible:
* '''cylinder''' or '''arrow''': upside down
* '''ring''': inside out
* '''checkpoint''': disappear
* '''corona''': bigger

==Syntax==
<syntaxhighlight lang="lua">
bool setMarkerSize ( marker theMarker, float size )
</syntaxhighlight>
{{OOP||[[Marker]]:setSize|size|getMarkerSize}}
===Required Arguments===
*'''theMarker:''' The [[marker]] that you wish to set the size of.
*'''size:''' A float representing new size of the marker.

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

==Example==
This example creates a cylinder marker at the position 1000, 1000, 1000 and sets its size to ''2.5''.
<syntaxhighlight lang="lua">
newmarker = createMarker ( 1000, 1000, 1000, "cylinder" )
setMarkerSize ( newmarker, 2.5 )
</syntaxhighlight>

==See Also==
===Client===
{{Client marker functions}}
===Server===
{{Marker functions}}

SetBlipColor

2016-02-10T03:07:39Z

TAPL-93: Undo revision 46557 by Strong100 (talk)

__NOTOC__
{{Server client function}}
This function will let you change the color of a blip. This color is only applicable to the default blip icon ([[Image:Blipid0s.png|12px]], [[Image:Blipid0u.png|12px]] or [[Image:Blipid0d.png|12px]]). All other icons will ignore this.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )</syntaxhighlight>
{{OOP||[[blip]]:setColor||getBlipColor|}}
===Required Arguments===
*'''theBlip:''' The blip who's color you wish to set.
*'''red:''' The amount of red in the blip's color (0 - 255).
*'''green:''' The amount of green in the blip's color (0 - 255).
*'''blue:''' The amount of blue in the blip's color (0 - 255).
*'''alpha:''' The amount of alpha in the blip's color (0 - 255). Alpha decides transparancy where 255 is opaque and 0 is transparent.

===Returns===
Returns ''true'' if the blip's color was set successfully. Returns ''false'' if the blip passed to the function is invalid, or any of the colors are out of the valid range.

==Example==
This example will find all the blips that exist and set them all to white if they aren't white already.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
local blips = getElementsByType ( "blip" )
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in ipairs ( blips ) do
-- Retrieve the blip's colors into the variables red, green, blue and alpha
local red, green, blue, alpha = getBlipColor ( blipValue )
-- If the blip's icon isn't white already
if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
-- Set the blip's color to white
setBlipColor ( blipValue, 255, 255, 255, 255 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

SetBlipColor

2016-02-10T03:06:23Z

TAPL-93: Undo revision 46558 by Strong100 (talk)

__NOTOC__
{{Server client function}}
This function will let you change the color of a blip. This color is only applicable to the default blip icon ([[Image:Blipid0s.png|12px]], [[Image:Blipid0u.png|12px]] or [[Image:Blipid0d.png|12px]]). All other icons will ignore this.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )</syntaxhighlight>
{{OOP||[[blip]]:setColor||getBlipColor|}}
===Required Arguments===
*'''theBlip:''' The blip who's color you wish to set.
*'''red:''' The amount of red in the blip's color (0 - 255).
*'''green:''' The amount of green in the blip's color (0 - 255).
*'''blue:''' The amount of blue in the blip's color (0 - 255).
*'''alpha:''' The amount of alpha in the blip's color (0 - 255). Alpha decides transparancy where 255 is opaque and 0 is transparent.

===Returns===
Returns ''true'' if the blip's color was set successfully. Returns ''false'' if the blip passed to the function is invalid, or any of the colors are out of the valid range.

==مثال==
هذا المثال سوف يجد كل العلامات وتلوينهم باللون الأبيض , اذا لم تكن بيضاء بالفعل .
<syntaxhighlight lang="lua">
local blips = getElementsByType ( "blip" )
for blipKey, blipValue in ipairs ( blips ) do
local red, green, blue, alpha = getBlipColor ( blipValue )
if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
setBlipColor ( blipValue, 255, 255, 255, 255 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

SetBlipColor

2016-02-10T03:06:04Z

TAPL-93: Undo revision 46556 by Strong100 (talk)

__NOTOC__
{{Server client function}}
This function will let you change the color of a blip. This color is only applicable to the default blip icon ([[Image:Blipid0s.png|12px]], [[Image:Blipid0u.png|12px]] or [[Image:Blipid0d.png|12px]]). All other icons will ignore this.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )</syntaxhighlight>
{{OOP||[[blip]]:setColor||getBlipColor|}}
===Required Arguments===
*'''theBlip:''' The blip who's color you wish to set.
*'''red:''' The amount of red in the blip's color (0 - 255).
*'''green:''' The amount of green in the blip's color (0 - 255).
*'''blue:''' The amount of blue in the blip's color (0 - 255).
*'''alpha:''' The amount of alpha in the blip's color (0 - 255). Alpha decides transparancy where 255 is opaque and 0 is transparent.

===Returns===
Returns ''true'' if the blip's color was set successfully. Returns ''false'' if the blip passed to the function is invalid, or any of the colors are out of the valid range.

==مثال==
هذا المثال يجلب جميع العلامات الموجودة , ويقوم بتلوينها الى اللون الإبيض اذا لم تكن بيضاء بالفعل .
<syntaxhighlight lang="lua">
local blips = getElementsByType ( "blip" )
for blipKey, blipValue in ipairs ( blips ) do
local red, green, blue, alpha = getBlipColor ( blipValue )
if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
setBlipColor ( blipValue, 255, 255, 255, 255 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

SetBlipColor

2016-02-10T03:01:04Z

TAPL-93: Undo revision 46555 by Strong100 (talk)

__NOTOC__
{{Server client function}}
This function will let you change the color of a blip. This color is only applicable to the default blip icon ([[Image:Blipid0s.png|12px]], [[Image:Blipid0u.png|12px]] or [[Image:Blipid0d.png|12px]]). All other icons will ignore this.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )</syntaxhighlight>
{{OOP||[[blip]]:setColor||getBlipColor|}}
===Required Arguments===
*'''theBlip:''' The blip who's color you wish to set.
*'''red:''' The amount of red in the blip's color (0 - 255).
*'''green:''' The amount of green in the blip's color (0 - 255).
*'''blue:''' The amount of blue in the blip's color (0 - 255).
*'''alpha:''' The amount of alpha in the blip's color (0 - 255). Alpha decides transparancy where 255 is opaque and 0 is transparent.

===Returns===
Returns : "true" اذا تم بنجاح "false" اذا لم يتم بنجاح

==مثال==
هذا المثال يجلب جميع العلامات الموجودة , ويقوم بتلوينها الى اللون الإبيض اذا لم تكن بيضاء بالفعل .
<syntaxhighlight lang="lua">
local blips = getElementsByType ( "blip" )
for blipKey, blipValue in ipairs ( blips ) do
local red, green, blue, alpha = getBlipColor ( blipValue )
if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
setBlipColor ( blipValue, 255, 255, 255, 255 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

Template:Elements

2015-09-01T05:59:12Z

TAPL-93: Undo revision 45699 by VenadHD (talk)

* [[Element/Player|Player]]
* [[Element/Ped|Ped]]
* [[Element/Vehicle|Vehicle]]
* [[Element/Object|Object]]
* [[Element/Pickup|Pickup]]
* [[Element/Marker|Marker]]
* [[Element/Collision shape|Collision shape]]
* [[Element/Blip|Blip]]
* [[Element/Radar area|Radar area]]
* [[Element/Projectile|Projectile]]
* [[Element/Team|Team]]
* [[Element/Console|Server console]]
* [[GUI widgets]]:
<ul>{{GUI_widgets}}</ul>
* [[Element/TXD|TXD]]
* [[Element/DFF|DFF]]
* [[Element/COL|COL]]

* [[Element/Sound|Sound]]
{{New items|3.0110|1.1|
* [[Element/Material|Material]]
** [[Element/Texture|Texture]]
** [[Element/Shader|Shader]]
* [[Element/DX font|DX font]]
* [[Element/GUI font|GUI font]]
* [[Element/Weapon|Weapon]]
{{New items|3.0135|1.3.5|
* [[Element/Camera|Camera]]
}}
{{New items|3.0140|1.4|
* [[Element/Effect|Effect]]
}}
}}
{{New items|3.0141|1.4.1|
* [[Element/Browser|Browser]]
}}
<noinclude>
[[ru:Template:Elements]]
[[es:Template:Elements]]
</noinclude>

GetPlayerFromSerial

2015-08-21T07:48:20Z

TAPL-93:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their [[serial]].
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified [[serial]] is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial ( serial )
assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M" ) ) )
</syntaxhighlight>

Author: Tete

Hint: This function can be useful for building up a serial-based system.

==See Also==
{{Useful_Functions}}

Changes in 1.5

2015-07-15T10:52:09Z

TAPL-93: Duplicate

{{Changelogs}}

== Main Additions / Changes ==
* Added a built-in web browser into MTA (''CEF'') which can be controlled by scripts using a new [[Element/Browser|browser]] element.
* Added light functions

== Scripting ==

=== Scripting: New functions ===

====Client====
*[[createBrowser]]
*[[executeBrowserJavascript]]
*[[focusBrowser]]
*[[isBrowserFocused]]
*[[getBrowserProperty]]
*[[getBrowserTitle]]
*[[getBrowserURL]]
*[[injectBrowserMouseDown]]
*[[injectBrowserMouseMove]]
*[[injectBrowserMouseUp]]
*[[injectBrowserMouseWheel]]
*[[isBrowserLoading]]
*[[isBrowserDomainBlocked]]
*[[loadBrowserURL]]
*[[requestBrowserDomains]]
*[[setBrowserProperty]]
*[[setBrowserRenderingPaused]]
*[[setBrowserVolume]]
*[[createLight]]
*[[getLightType]]
*[[getLightRadius]]
*[[getLightColor]]
*[[getLightDirection]]
*[[setLightRadius]]
*[[setLightColor]]
*[[setLightDirection]]
*[[getCameraFieldOfView]]
*[[setCameraFieldOfView]]
*[[getPedOccupiedVehicleSeat]]
*[[getCameraShakeLevel]]
*[[setCameraShakeLevel]]

==== Server ====
* None yet

==== Shared (''Client & Server side'') ====
* None yet

=== Scripting: New Events ===

==== Client ====
*[[onClientBrowserCreated]]
*[[onClientBrowserDocumentReady]]
*[[onClientBrowserLoadingStart]]
*[[onClientBrowserLoadingFailed]]
*[[onClientBrowserNavigate]]
*[[onClientBrowserPopup]]
*[[onClientBrowserCursorChange]]
*[[onClientBrowserTooltip]]
*[[onClientBrowserInputFocusChanged]]
*[[onClientBrowserWhistelistChange]]
*[[onClientPlayerNetworkStatus]]
*[[onClientBrowserResourceBlocked]]

==== Server ====
*[[onPlayerNetworkStatus]]

=== Scripting: Changes, Bugfixes and Additions ===
* Added ''throttled'' parameter to [[playSound]] and [[playSound3D]]
* Added resource meta option <download_priority_group> to allow certain client resources to download and start earlier or later than other resources when a player first connects to a server.
* Added number of simultaneous render targets capability to [[dxGetStatus]].
* Added an option to [[addAccount]] to check for case insensitive name clashes.

== Client ==

=== Client: Additions ===
* Enabled low fragmentation heap for XP to reduce memory allocation problems.
* Added automatic TXD resizing for 32 bit OS users to help fix low memory crashes.
* Added quality argument to dxCreateFont.
* Added FOV setting in the Video tab.
* Added support for multiple render targets in shaders.
* Adds the ability to complete nicknames in the chatbox when the tab key is pressed.
* Synced server side peds weapons with clients.
* Added fix for bullet sync not applying damage to the local player during network interruptions by applying remote calculated damage.

=== Client: Bugfixes & Changes ===
* Moved client log and config files to MTA\log and MTA\config
* Removed BASS error messages for players
* Tweaked streaming memory size calculation

== Server ==

=== Server: Additions ===
* Added server shutdown disconnect message

=== Server: Bugfixes & Changes ===
* Set 64 bit modules directory to "x64/modules"
* Fixed server ignoring module initialization failure
* Fixed [[getAccountData]] leaking memory
* Fixed [[removeBan]] crashing the server under certain circumstances
* Fixed HTTP stats being wrong sometimes
* Fixed sync issues when destroying a vehicle while exitting
* Added reload to the default start-up list.

== Resources ==
* None yet

== Editor ==
* None yet

== Extra information ==
''More detailed information available on [https://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[Category:Changelog]]
[[Category:Incomplete]]

Template:Useful Functions

2015-07-10T15:46:28Z

TAPL-93:

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

GetGridListRowIndexFromText

2015-07-02T08:39:18Z

TAPL-93:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function returns the GridList row index from the specified text.
==Syntax==
<syntaxhighlight lang="lua">int getGridListRowIndexFromText (element gridList, string text, int columnIndex)</syntaxhighlight>

===Required arguments===
* '''gridList''': The grid list element.
* '''text''': The text that you want to retrieve his index.
* '''columnIndex''': The ID of the column.

===Return===
Returns the row index (0 for the first element, 1 for the second, etc...), or false if the text doesn't exist.

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

==Example==
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
local fruits = {"Apple","Banana","Orange","Melon","Pear"}

addEventHandler("onClientResourceStart", resourceRoot,
function ()
fruitsList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true)
local column = guiGridListAddColumn(fruitsList, "Fruits", 0.85)
if (column) then
for i, v in ipairs(fruits) do
local row = guiGridListAddRow(fruitsList)
guiGridListSetItemText(fruitsList, row, column, tostring(v), false, false)
end
end
end)

function getIndex()
local index = getGridListRowIndexFromText(fruitsList,"Orange",1)
if index then
outputChatBox("Row index: "..index,255,0,0)
end
end
addCommandHandler("find",getIndex)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}

StopSound

2015-06-23T02:59:13Z

TAPL-93:

__NOTOC__
{{Client function}}
Stops the sound playback for specified [[sound]] [[element]]. The sound element is also destroyed.

==Syntax==
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight>
{{OOP||[[sound]]:stop}}
===Required Arguments===
*'''theSound:''' the [[sound]] [[element]] you want to stop playing.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function startMySound()
sound = playSound( "sound.mp3", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement(), startMySound )

function stopMySound()
stopSound( sound )
end
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound
</syntaxhighlight>

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

Template:Client utility functions

2015-03-19T21:56:09Z

TAPL-93:

* [[base64Encode]]
* [[base64Decode]]
{{Bit_functions}}
{{New items|3.0140|1.4|
* [[downloadFile]]
}}
* [[fromJSON]]
* [[getDistanceBetweenPoints2D]]
* [[getDistanceBetweenPoints3D]]
* [[getEasingValue]]
* [[getColorFromString]]
* [[getDevelopmentMode]]
* [[getFPSLimit]]
{{New items|3.0140|1.4|
* [[getLocalization]]
}}
* [[getNetworkStats]]
* [[getNetworkUsageData]]
* [[getPerformanceStats]]
* [[getRealTime]]
* [[getTickCount]]
* [[getTimers]]
* [[getTimerDetails]]
* [[gettok]]
* [[getVersion]]
{{New feature/item|3.0141|1.4.1|6791|
* [[hash]]
}}
* [[interpolateBetween]]
* [[isTimer]]
* [[killTimer]]
* [[md5]]
{{New feature/item|3.0135|1.3.5|6056|
* [[pregFind]]
* [[pregReplace]]
* [[pregMatch]]
}}
* [[resetTimer]]
* [[setClipboard]]
* [[setDevelopmentMode]]
* [[setFPSLimit]]
* [[setTimer]]
* [[sha256]]
* [[split]]
* [[teaEncode]]
* [[teaDecode]]
* [[tocolor]]
* [[toJSON]]
* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
* [[addDebugHook]]
* [[removeDebugHook]]
<noinclude>[[Category:Functions templates]]</noinclude>

GetElementDistanceFromCentreOfMassToBaseOfModel

2015-02-20T17:06:45Z

TAPL-93: /* Example */

__NOTOC__
{{Client function}}
This function is used to retrieve the distance between a [[element]]'s centre of mass to the base of the model. This can be used to calculate the position the [[element]] has to be set to, to have it on ground level.
==Syntax==
<syntaxhighlight lang="lua">
float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getDistanceFromCentreOfMassToBaseOfModel|distanceFromCentreOfMassToBaseOfModel}}

===Required Parameters===
'''theElement:''' The element you want to retrieve the value of.

===Returns===
Returns a ''float'' with the distance, or ''false'' if the element is invalid.

==Example==
This example outputs the value for the local player.
<syntaxhighlight lang="lua">
local distance = getElementDistanceFromCentreOfMassToBaseOfModel(localPlayer)
outputChatBox(tostring(distance))
</syntaxhighlight>

==See Also==
{{Client element functions}}

SetAccountPassword

2015-02-20T16:49:50Z

TAPL-93: /* Example */

__NOTOC__
{{Server function}}
This function sets the password of the specified [[account]].

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountPassword ( account theAccount, string password )
</syntaxhighlight>
{{OOP||[[account]]:setPassword|password|}}
===Required Arguments===
*'''theAccount:''' the account whos password you want to set
*'''password:''' the password

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

===Limits===
* Minimal account password length is 1 character.
* Maximum account password length is 30 characters.
* Account password can not be equal to "*****"

==Example==

This example allows a user to change their password with a command.

<syntaxhighlight lang="lua">
function ChangePlayerPassword(player, command, oldpass, newpass)
-- get the account the player is currently logged into
local account = getPlayerAccount(player)
if (account) then
-- if its only a guest account, do not allow the password to be changed
if (isGuestAccount(account)) then
outputChatBox("You must be logged into an account to change your password.", player)
-- end the function
return
end

-- check that the old password is correct
local password_check = getAccount(getAccountName(account), oldpass)
if (password_check) then
-- check the length of the new password
if (string.len(newpass)>=5) then
setAccountPassword(account,newpass)
else
outputChatBox("Your new password must be at least 5 characters long.", player)
end
else
outputChatBox("Old password invalid.", player)
end
end
end
addCommandHandler("changepass", ChangePlayerPassword)
</syntaxhighlight>

==See Also==
{{Account functions}}

[[ar:setAccountPassword]]
[[es:setAccountPassword]]

FormatNumber

2015-02-17T18:09:10Z

TAPL-93: /* Example */

{{Useful Function}}
__NOTOC__
This function converts large numbers and adds commas to it. (Example: 100000 -> 100.000) 

==Syntax==
<syntaxhighlight lang="lua">string convertNumber( int/string number )</syntaxhighlight>

===Required Arguments===
* '''number''': The number to be converted.

===Returns===
Returns a string containing the converted number.

==Code==
<syntaxhighlight lang="lua">
function convertNumber ( number )
local formatted = number
while true do
formatted, k = string.gsub(formatted, "^(-?%d+)(%d%d%d)", '%1,%2')
if ( k==0 ) then
break
end
end
return formatted
end
</syntaxhighlight>

==Example==
<section name="Client" class="client" show="true">
This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:
<syntaxhighlight lang="lua">
function convertPlayerMoney()
local pMoney = getPlayerMoney()
local convertedMoney = convertNumber(pMoney)
outputChatBox(convertedMoney)
end
addCommandHandler("money", convertPlayerMoney)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetElementSpeed

2015-02-08T17:51:17Z

TAPL-93:

__NOTOC__
{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed)
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
if diff ~= diff then return end -- if the number is a 'NaN' return end.
local x,y,z = getElementVelocity(element)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
end

return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
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.
<syntaxhighlight lang="lua">
addCommandHandler("setmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}

SetElementSpeed

2015-02-08T17:49:35Z

TAPL-93: Blanked the page

GetKeyFromValueInTable

2015-02-01T08:35:29Z

TAPL-93:

{{Useful Function}}
__NOTOC__
This function can be used to find the key of a specified value in a specified table.

==Syntax==
<syntaxhighlight lang="lua">element/int/float/string getKeyFromValueInTable(table theTable, mixed searchFor )</syntaxhighlight>

===Required Arguments===
* '''theTable''': The table where to look for the specified value.
* '''searchFor''': The string/number/element to find the key of.

===Returns===
Returns the key of the searched value, or ''false'' if not found.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getKeyFromValueInTable(a, b)
for k,v in pairs(a) do
if v == b then
return k
end
end
return false
end
</syntaxhighlight>
</section>
Author: MrTasty

==Example==
This example output the cost of the item specified by the player who entered the command.

'''NOTE:''' This is not the most efficient way, as it won't allow you to have more than 1 item of the same cost.
<syntaxhighlight lang="lua">
shopItems = {
--[PRICE] = "ITEM NAME",
[10] = "Sprunk Soda",
[12] = "eCola",
[17] = "Pisswasser",
}

addCommandHandler("getcostof", function(player, command, item)
if item then
local cost = getKeyFromValueInTable(shopItems, item) --Find the key (the price in this case) of entered item name
if cost then
outputChatBox(item.." costs $"..cost, player, 255, 0, 0) --If the cost was found, output it to the command executor
else
outputChatBox(item.." is not available in our shop.", player, 255, 0, 0) --If it wasn't, tell the command executor that the item does not have a cost (ie: not in the shop)
end
else
outputChatBox("Syntax error. Valid syntax is: /"..command.." <item name>", player, 255, 0, 0) --Output valid syntax in case the executor did not specify the item name to search for
end
end)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}