Multi Theft Auto: Wiki - User contributions [en]

RGBToHSV

2022-01-02T23:54:04Z

Olez14: remove debug line

{{Useful Function}}
__NOTOC__
This function convert RGB to HSV color space

==Syntax==
<syntaxhighlight lang="lua">
string RGBToHSV ( int red, int green, int blue )
</syntaxhighlight>

===Required Arguments===
* '''red:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space red] in the color (0-255).
* '''green:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space green] in the color (0-255).
* '''blue:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space blue] in the color (0-255).

===Returns===
Returns a hue, saturation and value of HSV color space

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function RGBToHSV(r, g, b)
local h, s, v
local r = r / 255
local g = g / 255
local b = b / 255

local maxColor = math.max(r, g, b)
local minColor = math.min(r, g, b)

local difference = maxColor - minColor

if r == maxColor then
h = (60 * ((g - b)/difference) + 360) % 360;
elseif g == maxColor then
h = (60 * ((b - r)/difference) + 120) % 360;
elseif b == maxColor then
h = (60 * ((r - g)/difference) + 240) % 360;
else
h = 0
end

if maxColor == 0 then
s = 0
else
s = (difference/maxColor) * 100;
end

v = maxColor * 100;

return math.ceil(h), math.floor(s), v
end
</syntaxhighlight>
</section>

Author: Olez14

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2022-01-02T23:49:55Z

Olez14: /* Data functions */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[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.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[table.toString]] » This function converts table to a string.
*[[table.toStringArray]] » This function converts '''array''' to a string.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getAccountsRanks]] » This function is used to detect the account name groups and put them in the chat.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[getPlayerFromAccountName]] » This function is used to obtain a player by the name of his account.

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[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.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.

=== Element functions ===
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[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.
*[[isElementInAir]]» This function checks if an element is in air or not.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.

=== Events ===
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[getClipboard]] » This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[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.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[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.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistance]] » Returns the distance between two elements.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.
*[[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.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getFreeDimension]] » This function get free dimension.
*[[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.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRealMonth]] » This function returns the current month name
*[[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.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[gradientString]] » This function transforms a string in a new coloured gradient string.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[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.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[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.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[guiSetStaticImageMovable]] » This function allows you to move a static image like a gui window.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
*[[isMouseOnGuiElement]] » This function allows you to check whether or not your mouse is over a specific gui element, this is especially useful if the gui element has a parent. 
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.

=====Gridlists=====
*[[convertGridListToText]] » This function converts grid list contents to text.
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[guiGridListGetColumnIDFromTitle]] » This function gets a gridlist's column ID from the column title.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListSetColumnNonSortable]] » This function makes a gridlist column become non-sortable.
*[[guiGridListSetColumnsFixedWidth]] » This function makes a gridlist have all its columns fixed width.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=====Labels=====
*[[guiLabelAddEffect]] » This function add an effects to the gui-label like (shadow, outline).

=== Marker functions ===
*[[createMarkerAttachedTo]] » This function creates a marker that is attached to an element.

=== Math functions ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.
*[[math.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

=== Ped functions ===
*[[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.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[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.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[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.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]]» This function make a table of players within certain range.
*[[isPlayerHitByVehicle]]» This function cancels event when a element is hit by a vehicle.
*[[warpToPlayer]]» This function make player warp to another player.

=== Resource functions ===
*[[getFilesInResourceFolder]] » This function gets a list of files that are inside a folder of a resource.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceSize]] » This function returns the size of a specified resource in kB(kilobyte)
*[[refreshResource]] » This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] » This function set resource download priority group.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isSoundPlaying]] » This function checks if a sound element is playing or not.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== Browser functions ===
*[[playVideo]] » This function plays a video on the screen.

=== Team functions ===
*[[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.

=== Vehicle functions ===
*[[findEmptyCarSeat]] » This function finds you the first empty seat in a vehicle.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[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.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[isVehicleUpgraded]] » This function checks is vehicle upgraded by upgrade ID.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[setVehicleTurnVelocityCenterOfMass]]» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== XML functions ===
*[[getXMLNodes]] » This function returns all children of a XML node.

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[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.
*[[check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[checkPassiveTimer]] » This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.

<noinclude>[[Category:Useful Functions]]</noinclude>

RGBToHSV

2022-01-02T23:46:24Z

Olez14: Created page with "{{Useful Function}} __NOTOC__ This function convert RGB to HSV color space ==Syntax== <syntaxhighlight lang="lua"> string RGBToHSV ( int red, int green, int blue ) </syntaxhighlight> ===Required Arguments=== * '''red:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space red] in the color (0-255). * '''green:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space green] in the color (0-255). * '''blue:''' The amount of [http://en.wikipedia.org/wiki/..."

{{Useful Function}}
__NOTOC__
This function convert RGB to HSV color space

==Syntax==
<syntaxhighlight lang="lua">
string RGBToHSV ( int red, int green, int blue )
</syntaxhighlight>

===Required Arguments===
* '''red:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space red] in the color (0-255).
* '''green:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space green] in the color (0-255).
* '''blue:''' The amount of [http://en.wikipedia.org/wiki/RGBA_color_space blue] in the color (0-255).

===Returns===
Returns a hue, saturation and value of HSV color space

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function RGBToHSV(r, g, b)
local h, s, v
local r = r / 255
local g = g / 255
local b = b / 255

local maxColor = math.max(r, g, b)
local minColor = math.min(r, g, b)

local difference = maxColor - minColor

if r == maxColor then
h = (60 * ((g - b)/difference) + 360) % 360;
elseif g == maxColor then
h = (60 * ((b - r)/difference) + 120) % 360;
elseif b == maxColor then
h = (60 * ((r - g)/difference) + 240) % 360;
else
h = 0
end
print(h)

if maxColor == 0 then
s = 0
else
s = (difference/maxColor) * 100;
end

v = maxColor * 100;

return math.ceil(h), math.floor(s), v
end
</syntaxhighlight>
</section>

Author: Olez14

==See Also==
{{Useful_Functions}}

GuiGridListGetItemText

2021-10-28T18:47:09Z

Olez14:

{{Client function}}
__NOTOC__
This function retrieves the text from a specific grid list item.

==Syntax==
<syntaxhighlight lang="lua">
string guiGridListGetItemText ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getItemText}}

===Required Arguments===
*'''gridList:''' the gridlist containing the item you're interested in
*'''rowIndex:''' row id of the item (first is 0)
*'''columnIndex:''' column id of the item (first is 0)

===Returns===
Returns the text of the item if the arguments are right, ''false'' otherwise.

==Example==
'''Example 1''': This example creates a gridlist with entries "Hello" and "World!" and chooses randomly which of these two grid list items it will retrieve.
<syntaxhighlight lang="lua">function clientsideResourceStart ()
--Create a gridlist
local myGridList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
--Create columnA on the gridlist
local columnA = guiGridListAddColumn ( myGridList, "columnA Title", 0.85 )
--Add 2 rows to the grid list
rowA = guiGridListAddRow ( myGridList )
rowB = guiGridListAddRow ( myGridList )
--Create the text "Hello" for rowA, columnA
guiGridListSetItemText ( myGridList, rowA, columnA, "Hello", false, false )
--Create the text "World!" for rowB, columnA
guiGridListSetItemText ( myGridList, rowB, columnA, "World!", false, false )
--Choose randomly which grid list item text to retrieve
getRandomItem = math.random ( 1, 2 )
if getRandomItem == 1 then
randomItemData = guiGridListGetItemText ( myGridList, rowA, columnA )
elseif getRandomItem == 2 then
randomItemData = guiGridListGetItemText ( myGridList, rowB, columnA )
end
--Output the randomly retrieved item text
outputChatBox ( "My gridlist item text: "..randomItemData )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )</syntaxhighlight>

'''Example 2''': This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.
<syntaxhighlight lang="lua">
function createPlayerList ()
-- Create the grid list
playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
-- Create a players column in the list
local column = guiGridListAddColumn( playerList, "Player", 0.85 )
if ( column ) then -- If the column has been created, fill it with players
for id, playeritem in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
addEventHandler ( "onClientGUIClick", playerList, click )
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )

function click ()
local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
outputChatBox(playerName)
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

Math.clamp

2021-09-22T15:34:29Z

Olez14: Edit comments of example

{{Useful_Function}}
This function returns the number between range of numbers or it's minimum or maximum.

==Syntax==
<syntaxhighlight lang="lua">float math.clamp( float number, float min, float max )</syntaxhighlight>

===Required arguments===
* '''number''': Number that will be compared with range.
* '''min''': Minimum of range.
* '''max''': Maximum of range.

==Code==
<syntaxhighlight lang="lua">
function math.clamp(number, min, max)
if number < min then
return min
elseif number > max then
return max
end
return number
end
</syntaxhighlight>
'''Author''': Olez14

==Example==
<syntaxhighlight lang="lua">
local num = math.clamp(50, 1, 100)
print(num)
-- This prints 50.0

local num = math.clamp(-10, 1, 100)
print(num)
-- This prints 1.0

local num = math.clamp(225, 1, 100)
print(num)
-- This prints 100.0
</syntaxhighlight>

==See also==
{{Useful_Functions}}

Template:Useful Functions

2021-09-22T15:32:19Z

Olez14: /* Math functions */

__NOTOC__
=== Table functions ===
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[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.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.fromString]] » This function converts string to a table.
*[[table.toString]] » This function converts table to a string.
*[[table.toStringArray]] » This function converts '''array''' to a string.
*[[pairsByKeys]] » This function sort pairs table.
*[[addTableChangeHandler]] » This function monitors the changes of a table.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.
*[[getAccountsRanks]] » This function is used to detect the account name groups and put them in the chat.

=== Account functions ===
*[[getPlayerFromAccountName]] » This function is used to obtain a player by the name of his account.

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[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.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.

=== Element functions ===
*[[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.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[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.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.

=== Events ===
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[getClipboard]] » This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.

=== Data functions ===
*[[convertDate]] » This function converts date to another look.
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[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.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[formatDate]] » This function formats a date on the basis of a format string and returns it.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getDistance]] » Returns the distance between two elements.
*[[getAge]] » This function calculates the age of a given birthday.
*[[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.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[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.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRealMonth]] » This function returns the current month name
*[[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.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[gradientString]] » This function transforms a string in a new coloured gradient string.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[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.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[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.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[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.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.
*[[getFreeDimension]] » This function get free dimension.
*[[hex2rgb]] » This function convert hex to rgb.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
*[[isMouseOnGuiElement]] » This function allows you to check whether or not your mouse is over a specific gui element, this is especially useful if the gui element has a parent. 
*[[guiSetStaticImageMovable]] » This function allows you to move a static image like a gui window.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.

=====Gridlists=====
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[guiGridListGetColumnIDFromTitle]] » This function gets a gridlist's column ID from the column title.
*[[guiGridListSetColumnNonSortable]] » This function makes a gridlist column become non-sortable.
*[[guiGridListSetColumnsFixedWidth]] » This function makes a gridlist have all its columns fixed width.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.
*[[convertGridListToText]] » This function converts grid list contents to text.

=====Labels=====
*[[guiLabelAddEffect]] » This function add an effects to the gui-label like (shadow, outline).

=== Marker functions ===
*[[createMarkerAttachedTo]] » This function creates a marker that is attached to an element.

=== Math functions ===
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[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.
*[[reMap]] » Re-maps a number from one range to another.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.
*[[math.lerp]] » Get val between two integer.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

=== Ped functions ===
*[[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.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[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.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[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.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[isPlayerHitByVehicle]]» This function cancels event when a element is hit by a vehicle.
*[[warpToPlayer]]» This function make player warp to another player.
*[[getPlayersInRange]]» This function make a table of players within certain range.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.

=== Resource functions ===
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSize]] » This function returns the size of a specified resource in kB(kilobyte)
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[refreshResource]] » This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] » This function set resource download priority group.
*[[getFilesInResourceFolder]] » This function gets a list of files that are inside a folder of a resource.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isSoundPlaying]] » This function checks if a sound element is playing or not.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== Browser functions ===
*[[playVideo]] » This function plays a video on the screen.

=== Team functions ===
*[[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.

=== Vehicle functions ===
*[[findEmptyCarSeat]] » This function finds you the first empty seat in a vehicle.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[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.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[isVehicleUpgraded]] » This function checks is vehicle upgraded by upgrade ID.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleTurnVelocityCenterOfMass]]» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.

=== XML functions ===
*[[getXMLNodes]] » This function returns all children of a XML node.

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[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.
*[[check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[checkPassiveTimer]] » This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.

<noinclude>[[Category:Useful Functions]]</noinclude>

Math.clamp

2021-09-22T15:30:19Z

Olez14:

{{Useful_Function}}
This function returns the number between range of numbers or it's minimum or maximum.

==Syntax==
<syntaxhighlight lang="lua">float math.clamp( float number, float min, float max )</syntaxhighlight>

===Required arguments===
* '''number''': Number that will be compared with range.
* '''min''': Minimum of range.
* '''max''': Maximum of range.

==Code==
<syntaxhighlight lang="lua">
function math.clamp(number, min, max)
if number < min then
return min
elseif number > max then
return max
end
return number
end
</syntaxhighlight>
'''Author''': Olez14

==Example==
<syntaxhighlight lang="lua">
local num = math.clamp(50, 1, 100)
print(num)
-- This prints 50.0

local num = math.clamp(-10, 1, 100)
print(num)
-- This prints -10.0

local num = math.clamp(225, 1, 100)
print(num)
-- This prints 225.0
</syntaxhighlight>

==See also==
{{Useful_Functions}}

Math.clamp

2021-09-22T15:25:50Z

Olez14: Created page with "__NOTOC__ {{Useful Function}} This function returns the number between range of numbers or it's minimum or maximum. ==Syntax== <syntaxhighlight lang="lua">float math.clamp( f..."

__NOTOC__
{{Useful Function}}
This function returns the number between range of numbers or it's minimum or maximum.

==Syntax==
<syntaxhighlight lang="lua">float math.clamp( float number, float min, float max )</syntaxhighlight>

===Required arguments===
* '''number''': Number that will be compared with range.
* '''min''': Minimum of range.
* '''max''': Maximum of range.

==Code==
<syntaxhighlight lang="lua">
function math.clamp(number, min, max)
if number < min then
return min
elseif number > max then
return max
end
return number
end
</syntaxhighlight>
'''Author''': Olez14

==Example==
<syntaxhighlight lang="lua">
local num = math.clamp(50, 1, 100)
print(num)
-- This prints 50.0

local num = math.clamp(-10, 1, 100)
print(num)
-- This prints -10.0

local num = math.clamp(225, 1, 100)
print(num)
-- This prints 225.0
</syntaxhighlight>

==See also==
{{Useful_Functions}}

GuiGridListGetSelectedItem

2020-06-11T16:50:04Z

Olez14:

{{Client function}}
__NOTOC__
This function returns the row and column indexes of the selected item in a grid list. First selected row and column is (0, 0).

==Syntax==
<syntaxhighlight lang="lua">
int, int guiGridListGetSelectedItem ( element gridList )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getSelectedItem}}

===Required Arguments===
*'''gridList:''' the grid list you want to know the selected row index of

===Returns===
Returns the row and column indexes of the selected item if the specified grid list is valid and has a selected item, (-1, -1) if no item is selected, ''false'' otherwise.

==Example==
This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.
<syntaxhighlight lang="lua">
function createPlayerList ()
-- Create the grid list
playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
-- Create a players column in the list
local column = guiGridListAddColumn( playerList, "Player", 0.85 )
if ( column ) then -- If the column has been created, fill it with players
for id, playeritem in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
addEventHandler ( "onClientGUIClick", playerList, click )
end
end
addEventHandler ( "onClientResourceStart", resourceRoot, createPlayerList )

function click ( button, state, sx, sy, x, y, z, elem, gui )
-- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
-- get the player name from the selected row, first column
local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
outputChatBox ( playerName ) -- output it to chat box
end
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiGridListGetSelectedItem

2020-06-11T16:49:12Z

Olez14: Helpful note

{{Client function}}
__NOTOC__
This function returns the row and column indexes of the selected item in a grid list. First row and column is (0, 0).

==Syntax==
<syntaxhighlight lang="lua">
int, int guiGridListGetSelectedItem ( element gridList )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getSelectedItem}}

===Required Arguments===
*'''gridList:''' the grid list you want to know the selected row index of

===Returns===
Returns the row and column indexes of the selected item if the specified grid list is valid and has a selected item, (-1, -1) if no item is selected, ''false'' otherwise.

==Example==
This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.
<syntaxhighlight lang="lua">
function createPlayerList ()
-- Create the grid list
playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
-- Create a players column in the list
local column = guiGridListAddColumn( playerList, "Player", 0.85 )
if ( column ) then -- If the column has been created, fill it with players
for id, playeritem in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
addEventHandler ( "onClientGUIClick", playerList, click )
end
end
addEventHandler ( "onClientResourceStart", resourceRoot, createPlayerList )

function click ( button, state, sx, sy, x, y, z, elem, gui )
-- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
-- get the player name from the selected row, first column
local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
outputChatBox ( playerName ) -- output it to chat box
end
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GetSoundWaveData

2020-04-12T01:44:08Z

Olez14: There was a problem where waveData could be false and "if (waveData[i] == waveData[i]) then" giving error, because script can't index a boolean value

__NOTOC__
{{Client function}}
This function gets the wave form data for an audio stream which is a table of floats representing the current audio frame as a wave.
This allows things like visualisations.

{{New feature/item|3.0132|1.3.2||
If the element is a player, this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">table getSoundWaveData ( element sound, int iSamples )</syntaxhighlight>
{{OOP||[[sound]]:getWaveData}}
===Required Arguments===
*'''sound:''' a [[sound]] [[element]] that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

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

==Example==
This example creates a sound visualizer on the top left corner of the screen.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ( "sound.wav" )

function onSoundPlayRender ( )
if ( soundHandler ) then
local waveData = getSoundWaveData ( soundHandler, 256 )
if ( waveData ) then
for i=0,255 do
dxDrawRectangle ( i, 128, 1, waveData[i] * 128)
end
end
end
end
addEventHandler ( "onClientRender", getRootElement(), onSoundPlayRender )
</syntaxhighlight>
</section>
This example creates a sound viewer, but only with bars down.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
for i=0, samples-1 do
if (waveData) then -- Avoid NaN values.
dxDrawRectangle (i, 128, 1, math.abs (waveData[i]) * 128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>
This example creates a sound viewer, but only with bars up.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
for i=0, samples-1 do
if (waveData) then -- Avoid NaN values.
dxDrawRectangle (i, 128, 1, math.abs (waveData[i]) * -128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>
This example creates a sound viewer on the bottom right corner of the screen.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local x, y = guiGetScreenSize ()
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
for i=0, samples-1 do
if (waveData) then -- Avoid NaN values.
dxDrawRectangle ((x-samples)+i, y-128, 1, waveData[i] * 128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>

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

==See Also==
{{Client_audio_functions}}

[[hu:getSoundWaveData]]
[[ar:getSoundWaveData]]

Table.removeValue

2020-03-28T20:06:46Z

Olez14: table in first argument of that function replace all functions of 'table', so table.remove didn't work.

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function removes a specified value from a table.
==Syntax==
<syntaxhighlight lang="lua">bool table.removeValue( table theTable, string value )</syntaxhighlight>

===Required Arguments===
* '''theTable''': The table you want to remove the specified value from.
* '''value''': The specified value you wish to remove.

===Returns===
Returns the modified index the operation was successful, false if the specified value does not exist.

<section name="Code" class="both" show="true">
<syntaxhighlight lang="lua">
function table.removeValue(tab, val)
for index, value in ipairs(tab) do
if value == val then
table.remove(tab, index)
return index
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Client Side" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart",resourceRoot,
function()
triggerServerEvent( "clientReady", resourceRoot )
end
)
</syntaxhighlight>
</section>

<section name="Server Side" class="server" show="true">
<syntaxhighlight lang="lua">
local readyPlayerList = {} -- Table

-- Add client to readyPlayerList table.
addEvent("clientReady", true )
addEventHandler("clientReady",resourceRoot,
function()
table.insert( readyPlayerList, client )
end
)

-- Remove the quitting client's from the table.
function removePlayerFromTable ()
table.removeValue( readyPlayerList, source )
end
addEventHandler("onPlayerQuit",root, removePlayerFromTable)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}