Multi Theft Auto: Wiki - User contributions [en]

User:CiBeR

2024-04-03T20:54:15Z

CiBeR:

Welcome to my profile page stalker.
[[File:0xCiBeR.png|thumb]]

User:CiBeR

2024-04-03T20:34:16Z

CiBeR:

Welcome to my profile page stalker.
[[File:TuServer.png|thumb]]

File:TuServer.png

2024-04-03T20:33:01Z

CiBeR:

test

User:XNawaf

2022-04-25T13:03:01Z

CiBeR: CiBeR moved page User:XNawaf to User:XLive: Automatically moved page while renaming the user "XNawaf" to "XLive"

#REDIRECT [[User:XLive]]

User:XLive

2022-04-25T13:03:01Z

CiBeR: CiBeR moved page User:XNawaf to User:XLive: Automatically moved page while renaming the user "XNawaf" to "XLive"

*[https://github.com/xLive GitHub]
*[https://forum.mtasa.com/profile/52180-xlive/ Forum Profile]
*[https://community.multitheftauto.com/index.php?p=profile&id=416702 Community Profile]


[[Special:Contributions/XNawaf|My contributions in the wiki]]


[https://cdn.discordapp.com/emojis/755816981541683262.png?v=1 don't click!]

User:Majqq

2022-04-25T13:02:13Z

CiBeR: CiBeR moved page User:Majqq to User:Srslyyyy: Automatically moved page while renaming the user "Majqq" to "Srslyyyy"

#REDIRECT [[User:Srslyyyy]]

User:Srslyyyy

2022-04-25T13:02:13Z

CiBeR: CiBeR moved page User:Majqq to User:Srslyyyy: Automatically moved page while renaming the user "Majqq" to "Srslyyyy"

[https://forum.mtasa.com/profile/67316-srslyyyy/ My forum profile.]

CSharp SDK

2022-02-27T23:34:50Z

CiBeR: Update link to reflect CDN usage

__TOC__
Many languages can make HTTP POST requests with JSON, C# can do too. This is C# SDK for MTA. It allows you to call any HTTP exported functions from resources. The SDK itself is very basic and easy to use. It was mainly created to extend [[MTASE|MTA:Script Editor]] functionality. Feel free to modify it however you like but don't remove original author. If you want your changes to be published, please speak to [[User:50p|50p]] on MTA forums [https://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 HERE]

==How to==
First of all, you have to include your files in your project. Once you've done this, you are ready to use SDK.

1. Add MTA_SDK.cs and MTA_LuaArgs.cs to your project file and import the SDK namespace in your file:

<syntaxhighlight lang="lua">using MTA_SDK;</syntaxhighlight>

2. Create instance of MTA class:

<syntaxhighlight lang="lua">MTA server = new MTA(); //-- default params (for IP and port, respectively) are: "localhost" and 22005</syntaxhighlight>

'''OR'''
<syntaxhighlight lang="lua">//-- if you don't want to make a call to your local server then you can connect to remote server with the following parameters:
MTA server = new MTA( "IP", port );</syntaxhighlight>

'''OR'''

<syntaxhighlight lang="lua">//-- if you get errors about authorization then you should use the account you created on your server
//-- (the account that is allowed to visit HTTP sites of your server, preferably admin):
MTA server = new MTA( "IP", port, "username", "password" );</syntaxhighlight>

3. Create instance of MTA_LuaArgs class to create list of arguments that is passed to the function call:

<syntaxhighlight lang="lua">MTA_LuaArgs luaArgs = new MTA_LuaArgs( );
luaArgs.AddValue( "hello" );
luaArgs.AddValue( "world" );</syntaxhighlight>

'''OR'''

<syntaxhighlight lang="lua">MTA_LuaArgs luaArgs = new MTA_LuaArgs( "hello", "world" );</syntaxhighlight>

4. Call function exported from resource (in meta.xml: <export function="functionName" http="true" />, REMEMBER! http attribute has to be true!):

<syntaxhighlight lang="lua">string returned = server.CallFunction( "sampleResource", "functionName", luaArgs );</syntaxhighlight>

And here is the sample Lua function (functionName) that we're trying to call:

<syntaxhighlight lang="lua">
function functionName( param1, param2 )
outputChatBox( "Function called from SDK with args: " .. param1 .. ", " .. param2 );
return true;
end
</syntaxhighlight>

==Download==
You can download C# MTA SDK here:
*[https://mirror.mtasa.ar/files/mta_csharp_sdk.zip C# MTA SDK 1.0]

==Contact==
If you have any questions/suggestions you can contact author on MTA forum or IRC '''#mta''' and '''#mtatools''' channels hosted on GTANet.com server.
*[https://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p]

RU/getRealTime

2021-04-18T04:44:22Z

CiBeR: Revert changes made by RIGZI

__NOTOC__
{{RU/Server client function}}
Эта функция получает реальное время клиента либо сервера (Если используется на клиентской стороне, то он возвращает время, установленное на компьютере клиента) и возвращает его в таблицу. Если вы хотите получить внутриигровое время (Показанное на часах в GTA) используйте [[getTime]].

==Синтаксис==
<syntaxhighlight lang="lua">table getRealTime( [int seconds = current] )</syntaxhighlight>

===Необязательные аргументы===
{{OptionalArg}}
{{New feature/item|3|1.0||
*'''seconds:''' Количество секунд от 1 января 1970 года (начала Unix эпохи). Полезен для использования в [[getBanTime]]. Правильные значения: от 0 до 32,000,000,000
}}

===Возвращаемые значения===
Возвращает ''таблицу'' подстрок в различных форматах, либо булев ''false'' если параметр '''seconds''' имеет неправильное значение.

{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"
|'''Member'''
|'''Meaning'''
|'''Range'''
|-
|second
|секунда внутри минуты
|0-61*
|-
|minute
|минута внутри часа
|0-59
|-
|hour
|час с полуночи
|0-23
|-
|monthday
|день в месяце
|1-31
|-
|month
|месяцы, начиная с Января (который 0)
|0-11
|-
|year
|годы начиная с 1900
|-
|weekday
|дни, начиная с Воскресенья
|0-6
|-
|yearday
|дни, начиная с 1 января (которое 0)
|0-365
|-
|isdst
|Daylight Saving Time flag
|-
|timestamp
|секунды с 1 января 1970 (MTA 1.1 +)
|
|}
* tm_sec is generally 0-59. Extra range to accommodate for leap seconds in certain systems.

==Example==
Этот пример выведет локальное время (сервера или клиента в зависимости, откуда будет вызвано) в часах и минутах.
<syntaxhighlight lang="lua">
function showtime ()
local time = getRealTime() -- в таблице time записываем реальное время
local hours = time.hour -- в переменную hours записываем количество часов
local minutes = time.minute -- а в minutes минут
outputChatBox ( "Local Time: "..hours..":"..minutes ) -- и выводим игроку
end
</syntaxhighlight>

==See Also==
{{Utility functions}}
[[ru:GetRealTime]]

User:CiBeR

2021-04-18T04:25:13Z

CiBeR:

Welcome to my profile page stalker.

GetRealTime

2021-04-18T04:19:49Z

CiBeR: Revert

__NOTOC__
{{Server client function}}
This function gets the server or client (if used client sided it returns time as set on client's computer) real time and returns it in a table. If you want to get the in-game time (shown on GTA's clock) use [[getTime]].

==Syntax==
<syntaxhighlight lang="lua">table getRealTime( [ int seconds = current, bool localTime = true ] )</syntaxhighlight>

===Optional Arguments===
*'''seconds:''' A count in seconds from the year 1970. Useful for storing points in time, or for retrieving time information for [[getBanTime]]. The valid range of this argument is 0 to 32,000,000,000
{{New feature/item|3.0141|1.4.1|6976|
*'''localTime:''' Set to ''true'' to adjust for the locally set timezone.
}}

===Returns===
Returns a ''table'' of substrings with different time format or ''false'' if the '''seconds''' argument is out of range.

{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"
|'''Member'''
|'''Meaning'''
|'''Range'''
|-
|second
|seconds after the minute
|0-61*
|-
|minute
|minutes after the hour
|0-59
|-
|hour
|hours since midnight
|0-23
|-
|monthday
|day of the month
|1-31
|-
|month
|months since January
|0-11
|-
|year
|years since 1900
|-
|weekday
|days since Sunday
|0-6
|-
|yearday
|days since January 1
|0-365
|-
|isdst
|Daylight Saving Time flag
|-
|timestamp
|seconds since 1970 (Ignoring set timezone)
|
|}
''* second'' is generally 0-59. Extra range to accommodate for leap seconds in certain systems.

==Example==
This example adds 'showtime' like the default MTA 'time' command:
<syntaxhighlight lang="lua">
function showtime ()
local time = getRealTime()
local hours = time.hour
local minutes = time.minute
local seconds = time.second
-- Make sure to add a 0 to the front of single digits.
if (hours < 10) then
hours = "0"..hours
end
if (minutes < 10) then
minutes = "0"..minutes
end
if (seconds < 10) then
seconds = "0"..seconds
end
outputChatBox ( "Local Time: "..hours..":"..minutes..":"..seconds )
end
addCommandHandler("showtime", showtime)
</syntaxhighlight>

Example with year, month, monthday using string.format:
<syntaxhighlight lang="lua">
function showtime ()
local time = getRealTime()
local hours = time.hour
local minutes = time.minute
local seconds = time.second

local monthday = time.monthday
local month = time.month
local year = time.year

local formattedTime = string.format("%04d-%02d-%02d %02d:%02d:%02d", year + 1900, month + 1, monthday, hours, minutes, seconds)
outputChatBox ( "Local Time: ".. formattedTime )
end
addCommandHandler("showtime", showtime)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.06976|Added localTime argument}}

==See Also==
{{Utility functions}}
[[ru:getRealTime]]

CreateTrayNotification

2016-10-20T18:04:31Z

CiBeR:

__NOTOC__
{{Client function}}
{{Needs Checking|Check function arguments and make example}}
This functions creates a notification ballon on the desktop.
==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string eType, bool useSound ] )</syntaxhighlight>
===Required Arguments===
*'''notificationText:''' The text to send in the notification.
===Optional Arguments===
*'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"'''
*'''userSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.
==Returns==
Returns ''true'' if the notification is correctly created, ''false'' otherwise.
==See Also==
{{Client_utility_functions}}

CreateTrayNotification

2016-10-20T17:56:11Z

CiBeR:

__NOTOC__
{{Client function}}
This functions creates a notification ballon on the desktop.

==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string eType, bool useSound ] )</syntaxhighlight>
===Required Arguments===
*'''notificationText:''' The text to send in the notification.
===Optional Arguments===
*'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"'''
*'''userSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.
==Returns==
Returns ''true'' if the notification is correctly created, ''false'' otherwise.

Template:Client utility functions

2016-10-20T17:46:42Z

CiBeR:

* [[base64Encode]]
* [[base64Decode]]
* [[createTrayNotification]]
{{Bit_functions}}

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

CreateTrayNotification

2016-10-20T17:42:58Z

CiBeR: Created page with "__NOTOC__ {{Client function}} This functions creates a notification ballon on the desktop. ==Syntax== <syntaxhighlight lang="lua">bool createTrayNotification ( string notifi..."

__NOTOC__
{{Client function}}
This functions creates a notification ballon on the desktop.

==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, string eType, bool useSound )</syntaxhighlight>
===Required Arguments===
*'''notificationText:''' The text to send in the notification.
*'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"'''
*'''userSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.
==Returns==
Returns ''true'' if the notification is correctly created, ''false'' otherwise.

Template:Useful Functions

2016-10-20T06:17:36Z

CiBeR: Added Orphan Pages

=== ACL functions ===
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[setAccountName]] » This function is used to change an existing account's name.

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.

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

=== Elements functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.

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

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].

=== Data functions ===
*[[capitalize]] » This function capitalizes a given string.
*[[convertNumber]] » This function converts and formats large numbers.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hex color codes from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
=====Gridlists=====
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=== Math functions ===
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.

=== Ped functions ===
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersInGroup]] » This function returns all Players In Group .
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.

=== Resource functions ===
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[refreshResource]] » This function refreshes your resource if you changed any of the files

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.

=== Table functions ===
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[table.removeValue]] » This function removes a specified value from a table.

=== Team functions ===
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.

=== Vehicle funcions ===
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

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

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

=== Utility ===
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[createAnimation]] » This function allows you to use interpolateBetween without render event and easily used.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCursorOnElement]] » This function checks whether the cursor is in a particular area.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
[[Category:Useful Functions]]

Template:Useful Functions

2016-10-20T06:13:18Z

CiBeR: /* Drawing functions */

=== ACL functions ===
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[setAccountName]] » This function is used to change an existing account's name.

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.

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

=== Elements functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.

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

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].

=== Data functions ===
*[[capitalize]] » This function capitalizes a given string.
*[[convertNumber]] » This function converts and formats large numbers.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hex color codes from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
=====Gridlists=====
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=== Math functions ===
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.

=== Ped functions ===
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersInGroup]] » This function returns all Players In Group .
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.

=== Resource functions ===
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[refreshResource]] » This function refreshes your resource if you changed any of the files

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.

=== Table functions ===
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[table.removeValue]] » This function removes a specified value from a table.

=== Team functions ===
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.

=== Vehicle funcions ===
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

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

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

=== Utility ===
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[createAnimation]] » This function allows you to use interpolateBetween without render event and easily used.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCursorOnElement]] » This function checks whether the cursor is in a particular area.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
[[Category:Useful Functions]]

Building MTASA Server on GNU Linux

2016-10-20T05:22:53Z

CiBeR: Update to full command

{{Needs Checking|Confirm steps work.}}

== Installing and Running MTASA server on Linux ==
{{Note|This article is only for developers who changed the server code, if you are looking for the precompiled server (for normal server owners). Go to: [http://linux.mtasa.com/ linux.mtasa.com] and see [[Installing and Running MTASA Server on GNU_Linux]]}}


== Preparing your system ==

In order to build the Multi Theft Auto dedicated server, you will have to set up your system with the correct libraries and tools. How these are installed depends on your distribution.

Our network module (net.dll or net.so) is distributed as a precompiled binary library. The file for GNU/Linux can be found inside the lastest Linux nightly from [http://nightly.mtasa.com/ here]. Use the net.so from {{Current Version|master}} if you are compiling from the trunk, or the net.so from {{Current Version|full}} if you are compiling the {{Current Version|full}} branch. Be sure the read the top of ''Server/version.h'' as it contains directions on how to compile the different build types.

=== Debian Linux ===

Includes derivative distributions such as Ubuntu.

You will need the necessary build tools, headers and libraries, which are distributed through the following Debian packages (e.g. Debian Lenny):

* '''build-essential:''' contains the necessary tools, headers and libraries to build applications
* '''automake:''' contains the automake tools
* '''libtool:''' contains the libtool software required to build libraries

* '''libreadline5-dev:''' contains the readline library (version 5)
* '''libncurses5-dev:''' contains software for controlling writing to the console screen
* '''libncursesw5-dev:''' contains support for wide characters

* '''libmysqlclient-dev:''' contains the MySQL library
* '''git:''' contains the git client used to check out our code repository
To install these packages through apt, use the apt-get install <package list> command as in the following example (execute as root):

apt-get install build-essential automake libtool
apt-get install libreadline5-dev libncurses5-dev libncursesw5-dev
apt-get install libmysqlclient-dev git

Note: On Debian 8 systems please use this: '''apt-get install build-essential automake libtool libreadline-gplv2-dev libncurses5-dev libncursesw5-dev libmysqlclient-dev git'''
=== Gentoo Linux ===
You will need the necessary build tools, headers and libraries. Because Gentoo’s portage system is designed to compile any packages on your own system, the necessary build tools will have already been installed. This only leaves you to install the necessary libraries:


* '''git:''' contains the git client used to check out our code repository
To compile and install these packages through emerge, use the emerge -v <package list> command. The -v option shows additional * * information and can be omitted. (If you want to use any USE flags, prepend emerge with USE="use flags here". You can also use the -pv option to verify that you’re using the correct flags.) Refer to the [http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=1 Gentoo Handbook] or manual for more information on emerge.

Example:

emerge -v git sqlite
USE=“net-misc/curl ssl” emerge -v curl

=== Fedora ===

You will need these packages to be able to successfully compile a MTA server on Fedora:
* '''glibc-devel:'''

* '''readline-devel:''' contains the readline library

* '''git:''' contains the git client to check out the source code
To install these packages through yum, use the yum install <package list> command as in the following example (execute as root):

yum install glibc-devel readline-devel git

== General instructions for {{Current Version|master}} ==

'''Downloading the source.'''

First you need to download the source. Either clone as show below or [https://github.com/multitheftauto/mtasa-blue/archive/master.zip download a zip snapshot]

git clone <nowiki>https</nowiki>://github.com/multitheftauto/mtasa-blue.git mtasa-blue
cd mtasa-blue

Then compile it thus:

./mta-build.sh

Then copy the configuration files, network module and resources into '''Bin/server''' by running this command:

./mta-install.sh

And the server should be ready in '''Bin/server'''

=== '''Troubleshooting''' ===

If you’re getting any unexpected errors while compiling, please check our [http://bugs.mtasa.com/ Bug tracker] or our [irc://irc.multitheftauto.com/ IRC channel]

[[ru:Building MTASA Server on GNU Linux]]
[[Category: Development]]

Building MTASA Server on GNU Linux

2016-10-20T05:21:03Z

CiBeR: Changed packages for Debian 8

{{Needs Checking|Confirm steps work.}}

== Installing and Running MTASA server on Linux ==
{{Note|This article is only for developers who changed the server code, if you are looking for the precompiled server (for normal server owners). Go to: [http://linux.mtasa.com/ linux.mtasa.com] and see [[Installing and Running MTASA Server on GNU_Linux]]}}


== Preparing your system ==

In order to build the Multi Theft Auto dedicated server, you will have to set up your system with the correct libraries and tools. How these are installed depends on your distribution.

Our network module (net.dll or net.so) is distributed as a precompiled binary library. The file for GNU/Linux can be found inside the lastest Linux nightly from [http://nightly.mtasa.com/ here]. Use the net.so from {{Current Version|master}} if you are compiling from the trunk, or the net.so from {{Current Version|full}} if you are compiling the {{Current Version|full}} branch. Be sure the read the top of ''Server/version.h'' as it contains directions on how to compile the different build types.

=== Debian Linux ===

Includes derivative distributions such as Ubuntu.

You will need the necessary build tools, headers and libraries, which are distributed through the following Debian packages (e.g. Debian Lenny):

* '''build-essential:''' contains the necessary tools, headers and libraries to build applications
* '''automake:''' contains the automake tools
* '''libtool:''' contains the libtool software required to build libraries

* '''libreadline5-dev:''' contains the readline library (version 5)
* '''libncurses5-dev:''' contains software for controlling writing to the console screen
* '''libncursesw5-dev:''' contains support for wide characters

* '''libmysqlclient-dev:''' contains the MySQL library
* '''git:''' contains the git client used to check out our code repository
To install these packages through apt, use the apt-get install <package list> command as in the following example (execute as root):

apt-get install build-essential automake libtool
apt-get install libreadline5-dev libncurses5-dev libncursesw5-dev
apt-get install libmysqlclient-dev git

Note: On Debian 8 systems please use this: '''apt-get install libreadline-gplv2-dev libncurses5-dev libncursesw5-dev'''
=== Gentoo Linux ===
You will need the necessary build tools, headers and libraries. Because Gentoo’s portage system is designed to compile any packages on your own system, the necessary build tools will have already been installed. This only leaves you to install the necessary libraries:


* '''git:''' contains the git client used to check out our code repository
To compile and install these packages through emerge, use the emerge -v <package list> command. The -v option shows additional * * information and can be omitted. (If you want to use any USE flags, prepend emerge with USE="use flags here". You can also use the -pv option to verify that you’re using the correct flags.) Refer to the [http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=1 Gentoo Handbook] or manual for more information on emerge.

Example:

emerge -v git sqlite
USE=“net-misc/curl ssl” emerge -v curl

=== Fedora ===

You will need these packages to be able to successfully compile a MTA server on Fedora:
* '''glibc-devel:'''

* '''readline-devel:''' contains the readline library

* '''git:''' contains the git client to check out the source code
To install these packages through yum, use the yum install <package list> command as in the following example (execute as root):

yum install glibc-devel readline-devel git

== General instructions for {{Current Version|master}} ==

'''Downloading the source.'''

First you need to download the source. Either clone as show below or [https://github.com/multitheftauto/mtasa-blue/archive/master.zip download a zip snapshot]

git clone <nowiki>https</nowiki>://github.com/multitheftauto/mtasa-blue.git mtasa-blue
cd mtasa-blue

Then compile it thus:

./mta-build.sh

Then copy the configuration files, network module and resources into '''Bin/server''' by running this command:

./mta-install.sh

And the server should be ready in '''Bin/server'''

=== '''Troubleshooting''' ===

If you’re getting any unexpected errors while compiling, please check our [http://bugs.mtasa.com/ Bug tracker] or our [irc://irc.multitheftauto.com/ IRC channel]

[[ru:Building MTASA Server on GNU Linux]]
[[Category: Development]]

CURL Errors

2016-10-19T20:47:25Z

CiBeR: Changed page to historical as recent updates to curl can be found on official website.

{{Historical}}
List of CURL Errors, updates can be found [http://curl.haxx.se/libcurl/c/libcurl-errors.html here]

'''CURLE_OK (0)'''

All fine. Proceed as usual.

'''CURLE_UNSUPPORTED_PROTOCOL (1)'''

The URL you passed to libcurl used a protocol that this libcurl does not support. The support might be a compile-time option that you didn't use, it can be a misspelled protocol string or just a protocol libcurl has no code for.

'''CURLE_FAILED_INIT (2)'''

Very early initialization code failed. This is likely to be an internal error or problem.

'''CURLE_URL_MALFORMAT (3)'''

The URL was not properly formatted.

'''CURLE_COULDNT_RESOLVE_PROXY (5)'''

Couldn't resolve proxy. The given proxy host could not be resolved.

'''CURLE_COULDNT_RESOLVE_HOST (6)'''

Couldn't resolve host. The given remote host was not resolved.

'''CURLE_COULDNT_CONNECT (7)'''

Failed to connect() to host or proxy.

'''CURLE_FTP_WEIRD_SERVER_REPLY (8)'''

After connecting to a FTP server, libcurl expects to get a certain reply back. This error code implies that it got a strange or bad reply. The given remote server is probably not an OK FTP server.

'''CURLE_REMOTE_ACCESS_DENIED (9)'''

We were denied access to the resource given in the URL. For FTP, this occurs while trying to change to the remote directory.
'''
CURLE_FTP_WEIRD_PASS_REPLY (11)'''

After having sent the FTP password to the server, libcurl expects a proper reply. This error code indicates that an unexpected code was returned.

'''CURLE_FTP_WEIRD_PASV_REPLY (13)'''

libcurl failed to get a sensible result back from the server as a response to either a PASV or a EPSV command. The server is flawed.

'''CURLE_FTP_WEIRD_227_FORMAT (14)'''

FTP servers return a 227-line as a response to a PASV command. If libcurl fails to parse that line, this return code is passed back.

'''CURLE_FTP_CANT_GET_HOST (15)'''

An internal failure to lookup the host used for the new connection.

'''CURLE_FTP_COULDNT_SET_TYPE (17)'''

Received an error when trying to set the transfer mode to binary or ASCII.

'''CURLE_PARTIAL_FILE (18)'''

A file transfer was shorter or larger than expected. This happens when the server first reports an expected transfer size, and then delivers data that doesn't match the previously given size.

'''CURLE_FTP_COULDNT_RETR_FILE (19)'''

This was either a weird reply to a 'RETR' command or a zero byte transfer complete.

'''CURLE_QUOTE_ERROR (21)'''

When sending custom "QUOTE" commands to the remote server, one of the commands returned an error code that was 400 or higher (for FTP) or otherwise indicated unsuccessful completion of the command.

'''CURLE_HTTP_RETURNED_ERROR (22)'''

This is returned if CURLOPT_FAILONERROR is set TRUE and the HTTP server returns an error code that is >= 400. (This error code was formerly known as CURLE_HTTP_NOT_FOUND.)

'''CURLE_WRITE_ERROR (23)'''

An error occurred when writing received data to a local file, or an error was returned to libcurl from a write callback.

'''CURLE_UPLOAD_FAILED (25)'''

Failed starting the upload. For FTP, the server typically denied the STOR command. The error buffer usually contains the server's explanation for this. (This error code was formerly known as CURLE_FTP_COULDNT_STOR_FILE.)

'''CURLE_READ_ERROR (26)'''

There was a problem reading a local file or an error returned by the read callback.

'''CURLE_OUT_OF_MEMORY (27)'''

A memory allocation request failed. This is serious badness and things are severely screwed up if this ever occurs.

'''CURLE_OPERATION_TIMEDOUT (28)'''

Operation timeout. The specified time-out period was reached according to the conditions.

'''CURLE_FTP_PORT_FAILED (30)'''

The FTP PORT command returned error. This mostly happens when you haven't specified a good enough address for libcurl to use. See CURLOPT_FTPPORT.

'''CURLE_FTP_COULDNT_USE_REST (31)'''

The FTP REST command returned error. This should never happen if the server is sane.

'''CURLE_RANGE_ERROR (33)'''

The server does not support or accept range requests.

'''CURLE_HTTP_POST_ERROR (34)'''

This is an odd error that mainly occurs due to internal confusion.

'''CURLE_SSL_CONNECT_ERROR (35)'''

A problem occurred somewhere in the SSL/TLS handshake. You really want the error buffer and read the message there as it pinpoints the problem slightly more. Could be certificates (file formats, paths, permissions), passwords, and others.

'''CURLE_FTP_BAD_DOWNLOAD_RESUME (36)'''

Attempting FTP resume beyond file size.

'''CURLE_FILE_COULDNT_READ_FILE (37)'''

A file given with FILE:// couldn't be opened. Most likely because the file path doesn't identify an existing file. Did you check file permissions?

'''CURLE_LDAP_CANNOT_BIND (38)'''

LDAP cannot bind. LDAP bind operation failed.

'''CURLE_LDAP_SEARCH_FAILED (39)'''

LDAP search failed.

'''CURLE_FUNCTION_NOT_FOUND (41)'''

Function not found. A required zlib function was not found.

'''CURLE_ABORTED_BY_CALLBACK (42)'''

Aborted by callback. A callback returned "abort" to libcurl.

'''CURLE_BAD_FUNCTION_ARGUMENT (43)'''

Internal error. A function was called with a bad parameter.

'''CURLE_INTERFACE_FAILED (45)'''

Interface error. A specified outgoing interface could not be used. Set which interface to use for outgoing connections' source IP address with CURLOPT_INTERFACE. (This error code was formerly known as CURLE_HTTP_PORT_FAILED.)
'''
CURLE_TOO_MANY_REDIRECTS (47)'''

Too many redirects. When following redirects, libcurl hit the maximum amount. Set your limit with CURLOPT_MAXREDIRS.

'''CURLE_UNKNOWN_TELNET_OPTION (48)'''

An option set with CURLOPT_TELNETOPTIONS was not recognized/known. Refer to the appropriate documentation.

'''CURLE_TELNET_OPTION_SYNTAX (49)'''

A telnet option string was Illegally formatted.

'''CURLE_PEER_FAILED_VERIFICATION (51)'''

The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.

'''CURLE_GOT_NOTHING (52)'''

Nothing was returned from the server, and under the circumstances, getting nothing is considered an error.

'''CURLE_SSL_ENGINE_NOTFOUND (53)'''

The specified crypto engine wasn't found.

'''CURLE_SSL_ENGINE_SETFAILED (54)'''

Failed setting the selected SSL crypto engine as default!

'''CURLE_SEND_ERROR (55)'''

Failed sending network data.

'''CURLE_RECV_ERROR (56)'''

Failure with receiving network data.

'''CURLE_SSL_CERTPROBLEM (58)'''

problem with the local client certificate.

'''CURLE_SSL_CIPHER (59)'''

Couldn't use specified cipher.

'''CURLE_SSL_CACERT (60)'''

Peer certificate cannot be authenticated with known CA certificates.

'''CURLE_BAD_CONTENT_ENCODING (61)'''

Unrecognized transfer encoding.

'''CURLE_LDAP_INVALID_URL (62)'''

Invalid LDAP URL.

'''CURLE_FILESIZE_EXCEEDED (63)'''

Maximum file size exceeded.

'''CURLE_USE_SSL_FAILED (64)'''

Requested FTP SSL level failed.

'''CURLE_SEND_FAIL_REWIND (65)'''

When doing a send operation curl had to rewind the data to retransmit, but the rewinding operation failed.

'''CURLE_SSL_ENGINE_INITFAILED (66)'''

Initiating the SSL Engine failed.

'''CURLE_LOGIN_DENIED (67)'''

The remote server denied curl to login (Added in 7.13.1)

'''CURLE_TFTP_NOTFOUND (68)'''

File not found on TFTP server.

'''CURLE_TFTP_PERM (69)'''

Permission problem on TFTP server.

'''CURLE_REMOTE_DISK_FULL (70)'''

Out of disk space on the server.

'''CURLE_TFTP_ILLEGAL (71)'''

Illegal TFTP operation.

'''CURLE_TFTP_UNKNOWNID (72)'''

Unknown TFTP transfer ID.

'''CURLE_REMOTE_FILE_EXISTS (73)'''

File already exists and will not be overwritten.

'''CURLE_TFTP_NOSUCHUSER (74)'''

This error should never be returned by a properly functioning TFTP server.

'''CURLE_CONV_FAILED (75)'''

Character conversion failed.

'''CURLE_CONV_REQD (76)'''

Caller must register conversion callbacks.

'''CURLE_SSL_CACERT_BADFILE (77)'''

Problem with reading the SSL CA cert (path? access rights?)

'''CURLE_REMOTE_FILE_NOT_FOUND (78)'''

The resource referenced in the URL does not exist.

'''CURLE_SSH (79)'''

An unspecified error occurred during the SSH session.

'''CURLE_SSL_SHUTDOWN_FAILED (80)'''

Failed to shut down the SSL connection.

'''CURLE_AGAIN (81)'''

Socket is not ready for send/recv wait till it's ready and try again. This return code is only returned from curl_easy_recv(3) and curl_easy_send(3) (Added in 7.18.2)

'''CURLE_SSL_CRL_BADFILE (82)'''

Failed to load CRL file (Added in 7.19.0)

'''CURLE_SSL_ISSUER_ERROR (83)'''

Issuer check failed (Added in 7.19.0)

GetPlayerName

2016-10-19T20:26:36Z

CiBeR: Adding spanish documentation.

__NOTOC__
{{Server client function}}
This function returns a string containing the name of the specified player.

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerName ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getName|name|setPlayerName}}
===Required Arguments===
* '''thePlayer:''' the Player that you want to get his name

===Returns===
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.

===Limits===
* Player name can consist of ASCII characters between 33 and 126 are allowed (basic latin):
<nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
* Minimal player name length is 1 character.
* Maximum player name length is 22 characters.
* Player names are case-insensitive. It is not possible to have two clients with same name but different character case.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function(playerSource)
outputChatBox("Your name: "..getPlayerName(playerSource), playerSource)
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example outputs the local player name to the chatbox.
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function()
local localPlayerName = getPlayerName(getLocalPlayer())
--and we output it to the chatbox
outputChatBox(localPlayerName)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client player functions}}
[[es:getPlayerName]]

Es/getPlayerName

2016-10-19T20:23:44Z

CiBeR: CiBeR moved page Es/getPlayerName to ES/getPlayerName

#REDIRECT [[ES/getPlayerName]]

ES/getPlayerName

2016-10-19T20:23:44Z

CiBeR: CiBeR moved page Es/getPlayerName to ES/getPlayerName

__NOTOC__
{{Server client function}}
Esta funcion devuelve un string conteniendo el nombre de un jugador especifico.

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerName ( player thePlayer )
</syntaxhighlight>

===Argumentos requeridos===
* '''thePlayer:''' el jugador de quien quieres obtener el nombre.

===Returns===
Devuelve un string conteniendo el nombre del jugador, o ''false'' si el jugador pasado en el argumento no es valido.

===Limites===
* El nombre de un jugador puede en caracteres ASCII entre 33 y 126 estan permitidos ( latino basico ):
<nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
* Minimo de caracteres en el nombre de un jugador es de 1.
* Maximo de caracteres en el nombre de un jugador es de 22.
* No es posible obtener el nombre de un jugador repetido.

==Ejemplo==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function(playerSource)
outputChatBox("Tu nombre: "..getPlayerName(playerSource), playerSource)
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
Este ejemplo pone el nombre del jugador en el chat.
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function()
local localPlayerName = getPlayerName(getLocalPlayer())
--y nosotros lo ponemos en el chat
outputChatBox(localPlayerName)
end
)
</syntaxhighlight>
</section>

==Mira tambien==
{{Client player functions}}

LogOut

2016-10-19T20:13:06Z

CiBeR: Adding spanish documentation.

__NOTOC__
{{Server function}}
This function logs the given player out of his current [[account]].

==Syntax==
<syntaxhighlight lang="lua">
bool logOut ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:logOut}}

===Required Arguments===
*'''thePlayer:''' The player to log out of his current account

===Returns===
Returns ''true'' if the player was successfully logged out, ''false'' or ''nil'' if it failed for some reason, ie. the player was never logged in.

==Example==
This example logs every player out of their account when the resource is (re)started. This would be handy for resources that show a login screen onClientResourceStart.
<syntaxhighlight lang="lua">
function logoutAll ()
local players = getElementsByType ( "player" ) -- Get every player
for k, player in ipairs ( players ) do -- For every player do the following...
account = getPlayerAccount ( player ) -- Get every player's account
if ( not isGuestAccount ( account ) ) then -- For every player that's logged in....
logOut ( player ) -- Log them out.
end
end
end
-- Trigger it when the resource (re)starts
addEventHandler ( "onResourceStart", getResourceRootElement(), logoutAll )</syntaxhighlight>

==See Also==
{{Account_functions}}

[[ru:logOut]]
[[es:logOut]]

GetXMLNodes

2016-10-18T04:48:13Z

CiBeR: Normalization

{{Useful Function}}
__NOTOC__

<lowercasetitle/>

==Syntax==
<syntaxhighlight lang="lua">table getXMLNodes( string xmlfilename, string nodename)</syntaxhighlight>

===Required Arguments===
* '''xmlfilename''': The xml file name and path
* '''nodename''': Node name in xml file

===Optional Arguments===
{{OptionalArg}}

==Code==
<section name="Serverside/clientside" class="server/client" show="true">
<syntaxhighlight lang="lua">
function getXMLNodes(xmlfile,nodename)
local xml = xmlLoadFile(xmlfile)
if xml then
local ntable={}
local a = 0
while xmlFindChild(xml,nodename,a) do
table.insert(ntable,a+1)
ntable[a+1]={}
local attrs = xmlNodeGetAttributes ( xmlFindChild(xml,nodename,a) )
for name,value in pairs ( attrs ) do
table.insert(ntable[a+1],name)
ntable[a+1][name]=value
end

ntable[a+1]["nodevalue"]=xmlNodeGetValue(xmlFindChild(xml,nodename,a))

a=a+1
end
return ntable
else
return {}
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local aTeam = getXMLNodes("teams.xml","team")
for ka,vc in ipairs(aTeam) do
outputDebugString(vc.tag)
end
</syntaxhighlight>
</section>
XML<teams.xml>
<syntaxhighlight lang="xml">
<teams>
<team tag="|OS|" />
<teams>
</syntaxhighlight>

Author: NeoN

==See Also==
{{Useful_Functions}}

GetGuestPlayers

2016-10-18T04:45:26Z

CiBeR: Normalization

{{Useful Function}}
__NOTOC__

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

===Returns===
Returns All Players not Login or All Players Guest Account , And vice false

==Code==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua">
function getGuestPlayers ( )

local Guest = { } ;

for _ , players_ in ipairs ( getElementsByType ( "player" ) ) do

local playerAcc = getPlayerAccount ( players_ )

if isGuestAccount ( playerAcc ) then

table.insert ( Guest , players_ )

end
end
return Guest
end
</syntaxhighlight></section>

==Example 1==
This example gets players Guest Account and show msg login or register
<syntaxhighlight lang="lua">
addCommandHandler ( "getGuestPlayers_" , function ( )

local GuestPlayers = getGuestPlayers ( )

if ( #GuestPlayers ~= 0 ) then

for _ , v in ipairs ( GuestPlayers ) do

outputChatBox ( getPlayerName ( v ) : gsub ( "#%x%x%x%x%x%x", "" ) .. "plz Login or Register" , v , 255 , 255 , 255 , true )

end
end
end
) ;

-- F8 Say : getGuestPlayers_
</syntaxhighlight>

==Example 2==
This example gets players Guest Account and kill them
<syntaxhighlight lang="lua">
addCommandHandler ( "killGuestPlayers" , function ( )

local GuestPlayers = getGuestPlayers ( )

if ( #GuestPlayers ~= 0 ) then

for _ , v in ipairs ( GuestPlayers ) do

killPed ( v )

end
end
end
) ;

--F8 Say : killGuestPlayers
</syntaxhighlight>

==Example 3==
This example show number players not login or Guest Account
<syntaxhighlight lang="lua">
outputChatBox ( #getGuestPlayers ( ) )

</syntaxhighlight>

Author: Abdul_KariM

==See Also==
{{Useful_Functions}}

GetPlayersInACLGroup

2016-10-18T04:43:44Z

CiBeR: Normalization

{{Useful Function}}
__NOTOC__
==Syntax==
<syntaxhighlight lang="lua">table getPlayersInGroup ( string GroupName )</syntaxhighlight>

===Required Arguments===
* '''GroupName''': A string Group Name To Get All Players In It

===Returns===
Returns All Players In Groups if it was Argument true , And vice false

==Code==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua">
function getPlayersInGroup ( GroupName )

local aTable = {}

assert ( tostring ( GroupName ) , "Bad Argument At Argument #1 Group Moust String" )

assert ( aclGetGroup ( tostring ( GroupName ) ) , "Bad Argument At Argument #1 Group not Found " )

for i , player_ in ipairs ( getElementsByType ( "player" ) ) do

local TheAcc = getPlayerAccount ( player_ )

if not isGuestAccount ( TheAcc ) then

if isObjectInACLGroup ( "user." ..getAccountName ( TheAcc ) , aclGetGroup ( tostring ( GroupName ) ) ) then

table.insert ( aTable , player_ )
end
end
end
return aTable
end
</syntaxhighlight></section>

==Example==
This example gets Player In Group specific and Kill Players This Group
<syntaxhighlight lang="lua">
addCommandHandler ( "killPlayerGroup",

function ( _ , _ , GroupName_ )

Players = getPlayersInGroup ( GroupName_ )

for i , PlayersGroup in ipairs ( Players ) do

killPed ( PlayersGroup )
end
end
) ;

-- F8 Say : killPlayerGroup Console
</syntaxhighlight>

==Example 2==
This example gets Player In Group specific and Give Players Money This Group
<syntaxhighlight lang="lua">
addCommandHandler("GiveGroupMoney",

function ( p , _ , Group_ , aMoney )

Players = getPlayersInGroup ( Group_ )

for i , PlayersGroup in ipairs ( Players ) do

givePlayerMoney ( PlayersGroup , tonumber ( aMoney ) )

end
end
) ;

--F8 Say : GiveGroupMoney Console 500
</syntaxhighlight>

Author: Abdul_KariM

==See Also==
{{Useful_Functions}}

GenerateRandomASCIIString

2016-10-18T04:39:33Z

CiBeR: Normalization

{{Useful Function}}
__NOTOC__
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int generateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(32, 126)))
end
return str
end
</syntaxhighlight>

Author: UnLimiTeD^
Idea by: Poof
==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

GetCursorMoveOn

2016-10-18T04:35:16Z

CiBeR: Fix showing contents of other functions

{{Useful Function}}
__NOTOC__
This function checks in which way the cursor is currently moving.
==Syntax==
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight>

===Returns===
Returns left,right,up or down.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getCursorMoveOn()
if ( isCursorShowing() ) then
left = "left"
right = "right"
up = "up"
down = "down"
zero = "nil"
if getElementData(localPlayer,"movew") == right then
return right
elseif getElementData(localPlayer,"movew") == left then
return left
elseif getElementData(localPlayer,"movew") == up then
return up
elseif getElementData(localPlayer,"movew") == down then
return down
elseif getElementData(localPlayer,"movew") == zero then
return false
end
end
end

function executeMoveOn(cursorX,cursorY)
if ( isCursorShowing() ) then
setElementData(localPlayer,"moveX",cursorX)
setElementData(localPlayer,"moveY",cursorY)
if cursorX > cX then
setElementData(localPlayer,"movew",right)
elseif cursorX < cX then
setElementData(localPlayer,"movew",left)
elseif cursorY > cY then
setElementData(localPlayer,"movew",down)
elseif cursorY < cY then
setElementData(localPlayer,"movew",up)
end
end
end
addEventHandler("onClientCursorMove",root,executeMoveOn)

setTimer(
function()
if ( isCursorShowing() ) then
local curX = getElementData(localPlayer,"moveX")
local curY = getElementData(localPlayer,"moveY")
if cursorX == cX then
setElementData(localPlayer,"movew",zero)
elseif cursorY == cY then
setElementData(localPlayer,"movew",zero)
end
end
end
,50,0)

function previousM()
if ( isCursorShowing() ) then
cX = getElementData(localPlayer,"moveX")
cY = getElementData(localPlayer,"moveY")
end
end
setTimer(previousM,50,0)
</syntaxhighlight>
</section>

==Example==
<section name="Client-side example" class="client" show="true">
This clientside example checks in which way cursor is currently moving.
<syntaxhighlight lang="lua">
bindKey ("m", "down",
function()
showCursor( not isCursorShowing() )
end
)

addEventHandler("onClientCursorMove",root,
function()
if ( isCursorShowing() ) then
moveOn = getCursorMoveOn()
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)
end
end
)
</syntaxhighlight>
</section>

By '''ronwolf1705'''.

==See Also==
{{Useful_Functions}}

User:CiBeR

2016-06-13T00:30:28Z

CiBeR: /* Contact */

== Contact ==
Current Community Website: [http://mtalpm.net MTA-LPM]

Mail: [mailto:admin@mtalpm.net admin@mtalpm.net]

Math.hypot

2016-06-11T06:42:09Z

CiBeR: Creating page math.hypot

{{Useful Function}}
__NOTOC__
This function returns the Hypotenuse of the triangle given by sides x and y. 

==Syntax==
<syntaxhighlight lang="lua">float math.hypot(float sideX, float sideY)</syntaxhighlight>

===Required Arguments===
* '''sideX''': The triangle's side X.
* '''sideY''': The triangle's side Y.
<section name="Serverside script" class="server" show="true">
<syntaxhighlight lang="lua">
function math.hypot( x, y )
return ((x ^ 2) + (y ^ 2)) ^ .5
end
</syntaxhighlight>
</section>

==Example==
This example gets the hypotenuse of a triangle.
<syntaxhighlight lang="lua">
local h = math.hypot(3,4)
print(h)
-- This prints 5.0
</syntaxhighlight>

Author: CiBeR

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2016-06-11T06:30:27Z

CiBeR: Adding math.hypot

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

CSharp SDK

2016-06-01T20:08:22Z

CiBeR: Re-Uploaded file

__TOC__
Many languages can make HTTP POST requests with JSON, C# can do too. This is C# SDK for MTA. It allows you to call any HTTP exported functions from resources. The SDK itself is very basic and easy to use. It was mainly created to extend [[MTASE|MTA:Script Editor]] functionality. Feel free to modify it however you like but don't remove original author. If you want your changes to be published, please speak to [[User:50p|50p]] on MTA forums [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 HERE]

==How to==
First of all, you have to include your files in your project. Once you've done this, you are ready to use SDK.

1. Add MTA_SDK.cs and MTA_LuaArgs.cs to your project file and import the SDK namespace in your file:

<syntaxhighlight lang="lua">using MTA_SDK;</syntaxhighlight>

2. Create instance of MTA class:

<syntaxhighlight lang="lua">MTA server = new MTA(); //-- default params (for IP and port, respectively) are: "localhost" and 22005</syntaxhighlight>

'''OR'''
<syntaxhighlight lang="lua">//-- if you don't want to make a call to your local server then you can connect to remote server with the following parameters:
MTA server = new MTA( "IP", port );</syntaxhighlight>

'''OR'''

<syntaxhighlight lang="lua">//-- if you get errors about authorization then you should use the account you created on your server
//-- (the account that is allowed to visit HTTP sites of your server, preferably admin):
MTA server = new MTA( "IP", port, "username", "password" );</syntaxhighlight>

3. Create instance of MTA_LuaArgs class to create list of arguments that is passed to the function call:

<syntaxhighlight lang="lua">MTA_LuaArgs luaArgs = new MTA_LuaArgs( );
luaArgs.AddValue( "hello" );
luaArgs.AddValue( "world" );</syntaxhighlight>

'''OR'''

<syntaxhighlight lang="lua">MTA_LuaArgs luaArgs = new MTA_LuaArgs( "hello", "world" );</syntaxhighlight>

4. Call function exported from resource (in meta.xml: <export function="functionName" http="true" />, REMEMBER! http attribute has to be true!):

<syntaxhighlight lang="lua">string returned = server.CallFunction( "sampleResource", "functionName", luaArgs );</syntaxhighlight>

And here is the sample Lua function (functionName) that we're trying to call:

<syntaxhighlight lang="lua">
function functionName( param1, param2 )
outputChatBox( "Function called from SDK with args: " .. param1 .. ", " .. param2 );
return true;
end
</syntaxhighlight>

==Download==
You can download C# MTA SDK here:
*[https://drive.google.com/file/d/0B4oc9Fbk4CkUelRrQWVqdmZ3ZDg/view?usp=sharing C# MTA SDK 1.0]

==Contact==
If you have any questions/suggestions you can contact author on MTA forum or IRC '''#mta''' and '''#mtatools''' channels hosted on GTANet.com server.
*[http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p]

IsMouseInPosition

2015-11-02T17:06:27Z

CiBeR: Corrected example, missing variables.

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to check whether the mouse cursor/pointer is within a rectangular position
==Syntax==
<syntaxhighlight lang="lua">bool isMouseInPosition ( int x, int y, int width, int height )</syntaxhighlight>

===Required arguments===
* '''x''': Left-most X position for detection (absolute)
* '''y''': Top-most Y position for detection (absolute)
* '''width''': Width for detection (absolute)
* '''heigh''': Height for detection (absolute)

===Return===
Returns true/false depending on whether the mouse is within the specified position or not

==Code==
<syntaxhighlight lang="lua">
function isMouseInPosition ( x, y, width, height )
if ( not isCursorShowing ( ) ) then
return false
end

local sx, sy = guiGetScreenSize ( )
local cx, cy = getCursorPosition ( )
local cx, cy = ( cx * sx ), ( cy * sy )
if ( cx >= x and cx <= x + width ) and ( cy >= y and cy <= y + height ) then
return true
else
return false
end
end

-- Modified version for DX Text
function isCursorOverText(posX, posY, sizeX, sizeY)
if(isCursorShowing()) then
local cX, cY = getCursorPosition()
local screenWidth, screenHeight = guiGetScreenSize()
local cX, cY = (cX*screenWidth), (cY*screenHeight)
if(cX >= posX and cX <= posX+(sizeX - posX)) and (cY >= posY and cY <= posY+(sizeY - posY)) then
return true
else
return false
end
else
return false
end
end
</syntaxhighlight>

==Example==
<section name="Example" class="client" show="true">
Changes the image when you move your cursor over it.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
local imgX, imgY, imgWidth, imgHeight = 50, 50, 200, 200
dxDrawImage ( imgX, imgY, imgWidth, imgHeight, ( isMouseInPosition ( imgX, imgY, imgWidth, imgHeight ) and "myImage2.png" or "myImage.png" ), tocolor ( 255, 255, 255 ) )
end
)
</syntaxhighlight>
</section>

Author: Castillo

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2015-11-02T17:02:42Z

CiBeR:

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

User:CiBeR

2015-10-30T14:06:32Z

CiBeR: Created page with "== Contact == Website: [http://ciberscripting.xyz CiBeR Scripting] Mail: contact@ciberscripting.xyz"

== Contact ==
Website: [http://ciberscripting.xyz CiBeR Scripting]
Mail: contact@ciberscripting.xyz

FileGetPath

2015-10-30T14:00:19Z

CiBeR:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|7446|
Use this function to get file's path.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' with the path, ''false'' if there's something wrong with the file in the argument.

==Example==

<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path,root,0,255,0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight>

==See Also==
{{File functions}}

OnVehicleExplode

2014-12-20T17:59:40Z

CiBeR:

__NOTOC__
{{Server event}}
This event is triggered when a vehicle explodes.
{{Note|Remember, this event can not be canceled.}}

==Parameters==
No arguments

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that exploded.

==Example==
'''Example 1'''
<syntaxhighlight lang="lua">
vagosVehicle = nil

-- This will get called when the vagos vehicle explodes
function onVagosVehicleExplode ()
outputChatBox ( "VAGOS VEHICLE DESTROYED!" )
end

-- This is called when THIS resource starts
function onThisResourceStart ()

-- Create the vagos vehicle. A van.
vagosVehicle = createVehicle ( 522, 0, 0, 5 )

-- Add its explode handler. When this car explodes, onVagosVehicleExplode is called
addEventHandler ( "onVehicleExplode", vagosVehicle, onVagosVehicleExplode )
end

--Add the resource start event
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource () ), onThisResourceStart )
</syntaxhighlight>

'''Example 2:''' This will show the name of any vehicle that blew up:
<syntaxhighlight lang="lua">
function notifyAboutExplosion()
-- source is the element that triggered the event and can be used in other events as well
outputChatBox(getVehicleName(source) .. " just blew up")
end

-- by using getRootElement() as root, it works for any vehicle
addEventHandler("onVehicleExplode", getRootElement(), notifyAboutExplosion)
</syntaxhighlight>

{{See also/Server event|Vehicle events}}