Multi Theft Auto: Wiki - User contributions [en]

https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=StiviK Multi Theft Auto: Wiki - User contributions [en] 2026-04-30T07:09:38Z User contributions MediaWiki 1.39.3 https://wiki.multitheftauto.com/index.php?title=SetVehicleColor&diff=42964 SetVehicleColor 2014-11-22T19:41:55Z

<p>StiviK: </p> <hr /> <div>__NOTOC__<br /> {{Server client function}}<br /> {{Warning|Informations below apply to MTA:SA v1.1 and newer! Scroll down to view old version of this function.|true}}<br /> This function will set the color of a vehicle. Colors are in RGB format, vehicles can have up to 4 colors. Most vehicles have 2 colors only.<br /> <br /> {{New feature|3.0110|1.1|<br /> ==Syntax== <br /> <syntaxhighlight lang="lua"><br /> bool setVehicleColor ( vehicle theVehicle, int r1, int g1, int b1, [int r2, int g2, int b2, int r3, int g3, int b3, int r4, int g4, int b4] ) <br /> </syntaxhighlight> <br /> <br /> ===Required Arguments=== <br /> *'''theVehicle:''' The [[vehicle]] that you wish to set the color of.<br /> *'''r1, g1, b1:''' Three integers indicating the red, green and blue components of the first (main) color for the vehicle<br /> ===Optional Arguments===<br /> *'''r2, g2, b2:''' Three integers indicating the red, green and blue components of the second color for the vehicle<br /> *'''r3, g3, b3:''' Three integers indicating the red, green and blue components of the third color for the vehicle<br /> *'''r4, g4, b4:''' Three integers indicating the red, green and blue components of the fourth color for the vehicle<br /> }}<br /> ===Returns===<br /> Returns ''true'' if vehicle's color was set, ''false'' if an invalid vehicle or invalid colors were specified.<br /> <br /> ==Example== <br /> <section name="Example 1" class="server" show="true"><br /> This example implements a serverside ''random_color'' console command.<br /> <syntaxhighlight lang="lua"><br /> addCommandHandler( 'random_color',<br /> function( uPlayer )<br /> if isPedInVehicle( uPlayer ) then<br /> local uVehicle = getPedOccupiedVehicle( uPlayer )<br /> if uVehicle then<br /> local r, g, b = math.random( 255 ), math.random( 255 ), math.random( 255 )<br /> setVehicleColor( uVehicle, r, g, b )<br /> end<br /> end<br /> end<br /> )<br /> </syntaxhighlight> <br /> </section><br /> <br /> <br /> <br /> {{Warning|Informations below apply to MTA:SA v1.0.5 and older!|true}}<br /> <br /> This function will set the color of a vehicle. Each vehicle can have up to 4 colors, for different aspects of the vehicle. Most vehicles only use two of the colors.<br /> ==Syntax== <br /> <syntaxhighlight lang="lua"><br /> bool setVehicleColor ( vehicle theVehicle, int color1, int color2, int color3, int color4 ) <br /> </syntaxhighlight> <br /> <br /> ===Required Arguments=== <br /> *'''theVehicle:''' The [[vehicle]] that you wish to set the color of.<br /> *'''color1:''' An integer indicating the first (main) color for the vehicle<br /> *'''color2:''' An integer indicating the second color for the vehicle<br /> *'''color3:''' An integer indicating the third color for the vehicle<br /> *'''color4:''' An integer indicating the fourth color for the vehicle<br /> <br /> The table below shows valid color ids:<br /> {{Vehicle_colors}}<br /> <br><br /> <section name="Example 1" class="server" show="false"><br /> This example implements a serverside ''set_vehicle_color'' console command.<br /> <syntaxhighlight lang="lua"><br /> -- Define our function that will handle the command<br /> function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )<br /> -- If a player triggered this in-game<br /> if ( playerSource ) then<br /> -- Get the player's vehicle<br /> playerVehicle = getPlayerOccupiedVehicle ( playerSource )<br /> -- If the player is in a vehicle and we've got at least 1 parameter<br /> if ( playerVehicle and col1 ) then<br /> -- Get the vehicle's existing color and use it if fewer than 4 arguments were passed<br /> exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )<br /> <br /> if not col2 then col2 = exCol2 end<br /> if not col3 then col3 = exCol3 end<br /> if not col4 then col4 = exCol4 end<br /> <br /> -- Set the vehicle's color<br /> setVehicleColor ( playerVehicle, col1, col2, col3, col4 )<br /> else<br /> -- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text<br /> outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )<br /> outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )<br /> outputConsole ( "You must be in a vehicle to use this function.", playerSource )<br /> end<br /> end<br /> end<br /> <br /> -- Register the command handler and attach it to the consoleSetVehicleColor function<br /> addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )<br /> </syntaxhighlight><br /> </section><br /> <br /> <section name="Example 2" class="server" show="false"><br /> This example changes all vehicles color to random every 0.5 sec.<br /> <syntaxhighlight lang="lua"><br /> function randomVehColors()<br /> for i, car in ipairs( getElementsByType( "vehicle" ) ) do<br /> local color = {}<br /> color[1] = math.random(0,126) -- random from 0 to 126, because colors is from 0 to 126<br /> color[2] = math.random(0,126)<br /> color[3] = math.random(0,126)<br /> color[4] = math.random(0,126) -- we take 4 random numbers because setVehicleColor have parameters with 4 colors<br /> setVehicleColor ( car, color[1], color[2], color[3], color[4] ) -- setting color to vehicle<br /> end<br /> end<br /> <br /> setTimer( randomVehColors, 500, 0 ) -- timer changes all vehicles colors to random every 0.5 sec.<br /> </syntaxhighlight><br /> </section><br /> <br /> <br /> ==See Also==<br /> {{Vehicle_functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=42552 Template:Useful Functions 2014-10-07T20:18:02Z

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

StiviK https://wiki.multitheftauto.com/index.php?title=GetCurrentFPS&diff=42551 GetCurrentFPS 2014-10-07T20:17:07Z

<p>StiviK: Fixed the Code</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function counts the FPS and getFPS() returns the FPS Count.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">int getFPS( )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * none<br /> <br /> ==Code==<br /> <section name="Client" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> fps = {fps = 0, realFPS = 0, lastTick = getTickCount()}<br /> addEventHandler("onClientRender", root, function ()<br /> if (getTickCount() - fps.lastTick) >= 1000 then<br /> fps.lastTick = getTickCount()<br /> fps.realFPS = fps.fps<br /> fps.fps = 0<br /> end<br /> <br /> fps.fps = fps.fps + 1<br /> end)<br /> <br /> function getFPS ()<br /> return fps.realFPS;<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Client" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> addCommandHandler("outputFPS", function ()<br /> outputChatBox("Your FPS are: "..getFPS())<br /> end)<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=42550 Template:Useful Functions 2014-10-07T20:16:19Z

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

StiviK https://wiki.multitheftauto.com/index.php?title=GetCurrentFPS&diff=42549 GetCurrentFPS 2014-10-07T20:16:10Z

<p>StiviK: Created page with "{{Useful_Function}} <lowercasetitle/> __NOTOC__ This function counts the FPS and getFPS() returns the FPS Count. ==Syntax== <syntaxhighlight lang="lua">int getFPS( )</syntaxhighlight> ===Required Arg..."</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function counts the FPS and getFPS() returns the FPS Count.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">int getFPS( )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * none<br /> <br /> ==Code==<br /> <section name="Client" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> fps = {fps = 0, realFPS = 0, lastTick = getTickCount()}<br /> addEventHandler("onClientRender", root, function ()<br /> if (getTickCount() - fps.lastTick) >= 1000 then<br /> fps.lastTick = getTickCount()<br /> fps.realFPS = localPlayer.fps.FPS<br /> fps.fps = 0<br /> end<br /> <br /> fps.fps = fps.fps + 1<br /> end)<br /> <br /> function getFPS ()<br /> return fps.realFPS;<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Client" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> addCommandHandler("outputFPS", function ()<br /> outputChatBox("Your FPS are: "..getFPS())<br /> end)<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Hash&diff=41506 Hash 2014-08-20T04:26:45Z

<p>StiviK: </p> <hr /> <div>__NOTOC__<br /> {{Server client function}}<br /> {{New feature/item|3.0141|1.4.1|6791|<br /> This function returns a hash of the specified string in the specified algorithm.<br /> }}<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua"><br /> string hash ( string algorithm, string dataToHash )<br /> </syntaxhighlight><br /> <br /> ===Required Arguments===<br /> *'''algorithm''': A string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512"<br /> *'''dataToHash''': A string of the data to hash.<br /> <br /> ===Returns===<br /> Returns the hash of the data, false if an invalid argument was used.<br /> ==Example==<br /> <syntaxhighlight lang="lua"><br /> local myString = "myDatatoHash"<br /> print(hash("md5", myString)) -- This will hash myString with the md5 Algorithm (it's equal to md5()) --> output: 0EF1E2203BD78182911B77EB6B9CC3DE<br /> <br /> -- A another Example<br /> local myNewString = "myNewDatatoHash"<br /> print(hash("sha512", myNewString)) -- This will hash myNewString with the sha512 Algorithm --> output: 64A5678DC83EDCD8991E8CF0D69764663C0F933870BB89465F77B6C23D2A2B2400305A36D77404EE647D0D7B9D56CF7937B235BBD3885D08DCC62C81FB6D8429<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> {{Utility functions}}<br /> [[ru:hash]]</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Hash&diff=41504 Hash 2014-08-19T14:26:58Z

<p>StiviK: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server client function}}<br /> {{New feature/item|3.0141|1.4.1|6791|<br /> This function returns a hash of the specified string in the specified algorithm.<br /> }}<br /> {{Needs_Example}}<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua"><br /> string hash ( string algorithm, string dataToHash )<br /> </syntaxhighlight><br /> <br /> ===Required Arguments===<br /> *'''algorithm''': A string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512"<br /> *'''dataToHash''': A string of the data to hash.<br /> <br /> ===Returns===<br /> Returns the hash of the data, false if an invalid argument was used.<br /> ==Example==<br /> <syntaxhighlight lang="lua"><br /> local myString = "myDatatoHash"<br /> print(hash("md5", myString)) -- This will hash myString with the md5 Algorithm (it's equal to md5()) --> output: 0EF1E2203BD78182911B77EB6B9CC3DE<br /> <br /> -- A another Example<br /> local myNewString = "myNewDatatoHash"<br /> print(hash("sha512", myNewString)) -- This will hash myNewString with the sha512 Algorithm --> output: 64A5678DC83EDCD8991E8CF0D69764663C0F933870BB89465F77B6C23D2A2B2400305A36D77404EE647D0D7B9D56CF7937B235BBD3885D08DCC62C81FB6D8429<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> {{Utility functions}}<br /> [[ru:hash]]</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Hash&diff=41503 Hash 2014-08-19T14:26:39Z

<p>StiviK: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server client function}}<br /> {{New feature/item|3.0141|1.4.1|6791|<br /> This function returns a hash of the specified string in the specified algorithm.<br /> }}<br /> {{Needs_Example}}<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua"><br /> string hash ( string algorithm, string dataToHash )<br /> </syntaxhighlight><br /> <br /> ===Required Arguments===<br /> *'''algorithm''': A string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512"<br /> *'''dataToHash''': A string of the data to hash.<br /> <br /> ===Returns===<br /> Returns the hash of the data, false if an invalid argument was used.<br /> ==Example==<br /> --Explain what the code does<br /> <syntaxhighlight lang="lua"><br /> local myString = "myDatatoHash"<br /> print(hash("md5", myString)) -- This will hash myString with the md5 Algorithm (it's equal to md5()) --> output: 0EF1E2203BD78182911B77EB6B9CC3DE<br /> <br /> -- A another Example<br /> local myNewString = "myNewDatatoHash"<br /> print(hash("sha512", myNewString)) -- This will hash myNewString with the sha512 Algorithm --> output: 64A5678DC83EDCD8991E8CF0D69764663C0F933870BB89465F77B6C23D2A2B2400305A36D77404EE647D0D7B9D56CF7937B235BBD3885D08DCC62C81FB6D8429<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> {{Utility functions}}<br /> [[ru:hash]]</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41017 GetBanFromName 2014-07-24T09:22:48Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example gets the IP of the ban which has been returned from getBanFromName().<br /> <syntaxhighlight lang="lua"><br /> addEventHandler("onPlayerBan", root, function(_, banner)<br /> outputChatBox(("%s has banned %s"):format(getPlayerName(banner), getPlayerName(source)), root, 255, 0, 0)<br /> local ban = getBanFromName(source:getName())<br /> local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName() -- Here you have the ip :)<br /> end)<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41016 GetBanFromName 2014-07-24T09:22:24Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example gets the IP of the ban which has been returned from getBanFromName().<br /> <syntaxhighlight lang="lua"><br /> addEventHandler("onPlayerBan", root, function(_, banner)<br /> outputChatBox(("%s has banned %s"):format(getPlayerName(banner), getPlayerName(source)), root, 255, 0, 0)<br /> local ban = getBanFromName(source:getName())<br /> local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName()<br /> end)<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=41012 Template:Useful Functions 2014-07-23T17:17:00Z

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

StiviK https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=41011 Template:Useful Functions 2014-07-23T17:16:41Z

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

StiviK https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=41010 Template:Useful Functions 2014-07-23T17:15:04Z

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

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41009 GetBanFromName 2014-07-23T17:08:03Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'. Important: Because of 'setBanAdmin' it only works with MTA 1.4.0+!<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName("SomeGuy") -- get the ban from 'SomeGuy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41008 GetBanFromName 2014-07-23T17:04:32Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName("SomeGuy") -- get the ban from 'SomeGuy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41007 GetBanFromName 2014-07-23T17:04:03Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName("SomeGuy") -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41006 GetBanFromName 2014-07-23T17:03:31Z

<p>StiviK: /* Example */</p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName(someguy) -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41005 GetBanFromName 2014-07-23T17:03:00Z

<p>StiviK: </p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName() -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41004 GetBanFromName 2014-07-23T17:01:54Z

<p>StiviK: </p> <hr /> <div>{{Useful_Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName() -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin to from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41003 GetBanFromName 2014-07-23T17:01:38Z

<p>StiviK: </p> <hr /> <div>{{Useful_Functions}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName() -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin to from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41002 GetBanFromName 2014-07-23T17:00:27Z

<p>StiviK: </p> <hr /> <div>{{Useful Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName() -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin to from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK https://wiki.multitheftauto.com/index.php?title=GetBanFromName&diff=41001 GetBanFromName 2014-07-23T16:59:53Z

<p>StiviK: Created page with "{{Useful Function}} <lowercasetitle/> __NOTOC__ This function returns the ban of the given playername (if the player got banned) otherwise false. <br/><br/>'''Important Note:..."</p> <hr /> <div>{{Useful Function}}<br /> <lowercasetitle/><br /> __NOTOC__<br /> This function returns the ban of the given playername (if the player got banned) otherwise false. <br /> <br/><br/>'''Important Note:''' Case sensitivity of the playername is important!<br /> <br/>If 'SomeGuy' got banned, and you will try 'someguy' you will get false.<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''playername''': The name of the player which got banned.<br /> <br /> ==Code==<br /> <section name="Server" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getBanFromName (name)<br /> for key, ban in ipairs(getBans()) do -- for every ban do following<br /> if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then<br /> return ban -- return the ban<br /> end<br /> end<br /> return false -- else return false<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Server" class="server" show="true"><br /> This example changes the Ban Admin from the player called 'someguy'<br /> <syntaxhighlight lang="lua"><br /> local someguy = getPlayerFromName("SomeGuy") -- get the Player called 'SomeGuy'<br /> banPlayer(someguy, true, false, true, getPlayerFromName("SomeAdmin")) -- Ban the player called 'someguy'<br /> <br /> local ban = getBanFromName() -- get the ban from 'someguy'<br /> setBanAdmin(ban, getPlayerFromName("SomeAdmin2")) -- Change the Ban Admin to from 'SomeAdmin' to 'SomeAdmin2'<br /> </syntaxhighlight><br /> </section><br /> <br /> Author: StiviK<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

StiviK