Multi Theft Auto: Wiki - User contributions [en]

Talk:GetRealMonthH

2016-11-09T14:56:37Z

Walid: Created page with "Wrong hijri months order it should be like this: --Walid (talk) '''Note:''' i don't know why the wiki page change the order (maybe because..."

Wrong hijri months order it should be like this: --[[User:Walid|Walid]] ([[User talk:Walid|talk]])

'''Note:''' i don't know why the wiki page change the order (maybe because it's arabic language) just copy and paste the code in your text editor (notpad++), you can go here to change a page language: [[Special:PageLanguage]].

<syntaxhighlight lang="lua">
local hijriMonths = {"محرم","صفر","ربيع الأول","ربيع الثّاني", "جمادى الأولى","جمادي الثاني", "رجب","شعبان","رمضان","شوال","ذو القعدة","ذو الحجة"}

function getHijriMonth()
local time = getRealTime()
local month = time.month + 1
return hijriMonths[month]
end
</syntaxhighlight>

Also try to change the function name to getHijriMonth.

Talk:GetRealMonthM

2016-11-09T14:35:58Z

Walid: Created page with "Simply it can be like this (much faster): --Walid (talk) <syntaxhighlight lang="lua"> local monthsTable = {"January","February","March","Ap..."

Simply it can be like this (much faster): --[[User:Walid|Walid]] ([[User talk:Walid|talk]])

<syntaxhighlight lang="lua">
local monthsTable = {"January","February","March","April","May","June","July","August","September","October","November","December"}

function getRealMonthName()
local time = getRealTime()
local month = time.month + 1
return monthsTable[month]
end
</syntaxhighlight>

On more thing try to change the function name to getRealMonthName (much better)

User talk:Angelagraph

2016-11-07T14:18:21Z

Walid: Stop spamming

Stop spamming. --[[User:Walid|Walid]] ([[User talk:Walid|talk]])

Object IDs

2016-11-06T09:45:31Z

Walid: Miscellaneous Objects

This page displays object id's.

==Beach and Sea==
<gallery mode="packed">
Image:BeachandSeaGeneral.jpg|'' General
Image:ShipsDocksandPiers1.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers2.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers3.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers4.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers5.jpg|'' Ships, Docks and Piers
</gallery>

==Buildings==
<gallery mode="packed" >
Image:BarsClubsandCasinos.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos2.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos3.jpg|'' Bars, Clubs and Casinos
Image:FactoriesandWarehouses.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses2.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses3.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses4.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses5.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses6.jpg|'' Factories and Warehouses
Image:OfficesandSkyscrapers.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers2.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers3.jpg|'' Offices and Skyscrapers
Image:OtherBuildings.jpg|'' Other Buildings
Image:OtherBuildings2.jpg|'' Other Buildings
Image:OtherBuildings3.jpg|'' Other Buildings
Image:OtherBuildings4.jpg|'' Other Buildings
Image:RestaurantsandHotels.jpg|'' Restaurants and Hotels
Image:RestaurantsandHotels2.jpg|'' Restaurants and Hotels
Image:SportsandStadiums.jpg|'' Sports and Stadiums
Image:SportsandStadiums2.jpg|'' Sports and Stadiums
</gallery>

==Miscellaneous==
<gallery mode="packed" >
Image:MiscellaneousFoodAndDrinks1.jpg|'' Food and Drinks
Image:MiscellaneousLaddersStairsAndScaffolding1.jpg|'' Ladders Stairs and Scaffolding
Image:MiscellaneousMilitary1.jpg|'' Military
Image:MiscellaneousPickupsAndIcons1.jpg|'' Pickups and Icons
Image:MiscellaneousSpecialObjects1.jpg|'' Special
Image:MiscellaneousStreetAndRoad1.jpg|'' Street and Road items
Image:MiscellaneousTrash1.jpg|'' Trash
</gallery>

==Industrial==
<gallery mode="packed">
Image:Cranes.jpg|'' Cranes
Image:CratesDrumsandRacks.jpg|'' Crates, Drums and Racks
Image:CratesDrumsandRacks2.jpg|'' Crates, Drums and Racks
Image:IndustrialGeneral.jpg|'' General
Image:IndustrialGeneral2.jpg|'' General
</gallery>

==Nature==
<gallery mode="packed">
Image:Rocks.jpg|'' Rocks
Image:Plants.jpg|'' Plants
Image:trees.jpg|'' Trees
</gallery>

==Structures==
<gallery mode="packed">
Image:Airport.jpg|'' Airport and Aircraft
Image:Ramps.jpg|'' Ramps
Image:signs.jpg|'' Signs, Billboards and Statues
</gallery>

File:MiscellaneousTrash1.jpg

2016-11-06T09:40:51Z

Walid:

File:MiscellaneousStreetAndRoad1.jpg

2016-11-06T09:40:40Z

Walid:

File:MiscellaneousSpecialObjects1.jpg

2016-11-06T09:40:26Z

Walid:

File:MiscellaneousPickupsAndIcons1.jpg

2016-11-06T09:40:15Z

Walid:

File:MiscellaneousMilitary1.jpg

2016-11-06T09:40:06Z

Walid:

File:MiscellaneousLaddersStairsAndScaffolding1.jpg

2016-11-06T09:39:56Z

Walid:

File:MiscellaneousFoodAndDrinks1.jpg

2016-11-06T09:39:45Z

Walid:

Object IDs

2016-11-06T09:35:16Z

Walid: Structures

This page displays object id's.

==Beach and Sea==
<gallery mode="packed">
Image:BeachandSeaGeneral.jpg|'' General
Image:ShipsDocksandPiers1.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers2.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers3.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers4.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers5.jpg|'' Ships, Docks and Piers
</gallery>

==Buildings==
<gallery mode="packed" >
Image:BarsClubsandCasinos.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos2.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos3.jpg|'' Bars, Clubs and Casinos
Image:FactoriesandWarehouses.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses2.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses3.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses4.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses5.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses6.jpg|'' Factories and Warehouses
Image:OfficesandSkyscrapers.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers2.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers3.jpg|'' Offices and Skyscrapers
Image:OtherBuildings.jpg|'' Other Buildings
Image:OtherBuildings2.jpg|'' Other Buildings
Image:OtherBuildings3.jpg|'' Other Buildings
Image:OtherBuildings4.jpg|'' Other Buildings
Image:RestaurantsandHotels.jpg|'' Restaurants and Hotels
Image:RestaurantsandHotels2.jpg|'' Restaurants and Hotels
Image:SportsandStadiums.jpg|'' Sports and Stadiums
Image:SportsandStadiums2.jpg|'' Sports and Stadiums
</gallery>

==Industrial==
<gallery mode="packed">
Image:Cranes.jpg|'' Cranes
Image:CratesDrumsandRacks.jpg|'' Crates, Drums and Racks
Image:CratesDrumsandRacks2.jpg|'' Crates, Drums and Racks
Image:IndustrialGeneral.jpg|'' General
Image:IndustrialGeneral2.jpg|'' General
</gallery>

==Nature==
<gallery mode="packed">
Image:Rocks.jpg|'' Rocks
Image:Plants.jpg|'' Plants
Image:trees.jpg|'' Trees
</gallery>

==Structures==
<gallery mode="packed">
Image:Airport.jpg|'' Airport and Aircraft
Image:Ramps.jpg|'' Ramps
Image:signs.jpg|'' Signs, Billboards and Statues
</gallery>

File:Signs.jpg

2016-11-06T09:33:20Z

Walid:

File:Ramps.jpg

2016-11-06T09:32:59Z

Walid:

File:Airport.jpg

2016-11-06T09:32:29Z

Walid:

Object IDs

2016-11-06T09:31:07Z

Walid: Added nature objects

This page displays object id's.

==Beach and Sea==
<gallery mode="packed">
Image:BeachandSeaGeneral.jpg|'' General
Image:ShipsDocksandPiers1.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers2.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers3.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers4.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers5.jpg|'' Ships, Docks and Piers
</gallery>

==Buildings==
<gallery mode="packed" >
Image:BarsClubsandCasinos.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos2.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos3.jpg|'' Bars, Clubs and Casinos
Image:FactoriesandWarehouses.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses2.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses3.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses4.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses5.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses6.jpg|'' Factories and Warehouses
Image:OfficesandSkyscrapers.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers2.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers3.jpg|'' Offices and Skyscrapers
Image:OtherBuildings.jpg|'' Other Buildings
Image:OtherBuildings2.jpg|'' Other Buildings
Image:OtherBuildings3.jpg|'' Other Buildings
Image:OtherBuildings4.jpg|'' Other Buildings
Image:RestaurantsandHotels.jpg|'' Restaurants and Hotels
Image:RestaurantsandHotels2.jpg|'' Restaurants and Hotels
Image:SportsandStadiums.jpg|'' Sports and Stadiums
Image:SportsandStadiums2.jpg|'' Sports and Stadiums
</gallery>

==Industrial==
<gallery mode="packed">
Image:Cranes.jpg|'' Cranes
Image:CratesDrumsandRacks.jpg|'' Crates, Drums and Racks
Image:CratesDrumsandRacks2.jpg|'' Crates, Drums and Racks
Image:IndustrialGeneral.jpg|'' General
Image:IndustrialGeneral2.jpg|'' General
</gallery>

==Nature==
<gallery mode="packed">
Image:Rocks.jpg|'' Rocks
Image:Plants.jpg|'' Plants
Image:trees.jpg|'' Trees
</gallery>

File:Trees.jpg

2016-11-06T09:26:37Z

Walid:

File:Rocks.jpg

2016-11-06T09:26:23Z

Walid:

File:Plants.jpg

2016-11-06T09:26:04Z

Walid:

Template:Useful Functions

2016-11-04T12:39:47Z

Walid: Fixed the function name

=== 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.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle .
*[[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.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== 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.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
[[Category:Useful Functions]]

SlowlyMusicStop

2016-11-04T12:36:50Z

Walid: Walid moved page SlowlyMusicStop to StopSoundSlowly: slowlyMusicStop > stopSoundSlowly

#REDIRECT [[StopSoundSlowly]]

StopSoundSlowly

2016-11-04T12:36:50Z

Walid: Walid moved page SlowlyMusicStop to StopSoundSlowly: slowlyMusicStop > stopSoundSlowly

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function stops the [[sound]] [[element]] slowly.

==Syntax==
<syntaxhighlight lang="lua">int stopSoundSlowly( element sound )</syntaxhighlight>

===Required Arguments===
* '''sound''': The sound element that needs to be stopped.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' if the sound is not found.

==Code==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
function stopSoundSlowly (sElement)
if not isElement(sElement) then return false end
local soundVolume = getSoundVolume(sElement)
local slowlyStop = setTimer(
function ()
setSoundVolume(sElement,soundVolume - 0.5)
if soundVolume >= 0 then stopSound(sElement) end
end,400,soundVolume*2
)
end
</syntaxhighlight>
</section>

==Example==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("stopS",
function (command,sound)
stopSoundSlowly (sound)
end
)
</syntaxhighlight>
</section>

Author: J.Chaikos

==See Also==
{{Useful_Functions}}

StopSoundSlowly

2016-11-04T12:33:38Z

Walid: Translate to English

Server mtaserver.conf

2016-11-02T19:47:49Z

Walid: Undo revision by Gerry (talk)

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====serverip====
:''<serverip></serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:It is generally only needed for professional servers and should be left blank otherwise. This parameter specifies the IP to use for servers that have multiple IP addresses. If left blank, it will default to server's standard local IP address.
:SERVERIP SHOULD BE LEFT BLANK UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:People who set this and then ask for support will be the first ones against the wall when the revolution comes

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====
:''<httpserver>1</httpserver>
:This parameter specifies whether the builtin http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

{{New feature/item|3.0136|1.3.5|6301|
====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4
}}

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins.
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none or peds ; default value: none
:'''From server version 1.4.1-9.07268

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma seperated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide|Anti-cheat guide]]

====enablesd====
:''<enablesd></enablesd>
:Comma seperated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications. Competitive servers may wish to enable special detections, but most servers should leave this setting blank.
:e.g. To enable special detection #12 (disallow custom D3D9.DLL) use: 12
:More information: [[Anti-cheat_guide|Anti-cheat guide]]

====networkencryption====
:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[http://nightly.mtasa.com/ver highest available]].'''

{{New feature/item|3.0136|1.3.4|6023|
====minclientversion_auto_update====
:''<minclientversion_auto_update></minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommened for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.
}}

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[http://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the ingame server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 40000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 200 - 400; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>1000</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 200 - 4000; default value: 1000
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>0</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:'''It only works on server build 4247 or later, and when enabled, connecting clients will be auto-updated if required.'''
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered expermental.
:'''It only works on server build 4456 or later.'''
:Available range: 0 to 100. Default - 0 -->

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:'''It only works on server build 4456 or later.'''
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: http://bugs.mtasa.com/view.php?id=8191 + http://bugs.mtasa.com/view.php?id=8226

====threadnet====
:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase cpu usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

{{New feature/item|3.0136|1.3.4|5809|
====loadstringfile====
:''
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.
}}

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>5</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 5

{{New feature/item|3.0136|1.3.4|5950|
====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented. Details: http://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1
}}

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0"/>
:''<resource src="defaultstats" startup="1" protected="0"/>
:''<resource src="helpmanager" startup="1" protected="0"/>
:''<resource src="joinquit" startup="1" protected="0"/>
:''<resource src="mapcycler" startup="1" protected="0"/>
:''<resource src="mapmanager" startup="1" protected="0"/>
:''<resource src="parachute" startup="1" protected="0"/>
:''<resource src="resourcebrowser" startup="1" protected="1" default="true"/>
:''<resource src="resourcemanager" startup="1" protected="1"/>
:''<resource src="scoreboard" startup="1" protected="0"/>
:''<resource src="spawnmanager" startup="1" protected="0"/>
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0"/>
:''<resource src="webadmin" startup="1" protected="0"/>
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

Server Commands

2016-11-02T19:44:04Z

Walid: Undo

This page lists all built in commands that the server can process. All these commands can be entered via the server console or the client console depending upon permissions unless otherwise stated.

==Resource commands==
====check====
:<ins>Server console only</ins>
:Usage: check [ ''all'' | ''<resource-name>'' ] 
:Checks which files would be changed with [[Server_Commands#upgrade|upgrade]] command. Does not modify anything.
====info====
:<ins>Server console only</ins>
:Usage: info ''<resource-name>'' 
:Get info for a resource eg: info admin
====list====
:<ins>Server console only</ins>
:Shows a list of resources

====refresh====
:Refresh resource list to find new resources
====refreshall====
:Refresh resources and restart any changed resources
====restart====
:Usage: info ''<resource-name>'' 
:Restarts a running resource eg: restart admin
====start====
:Usage: start ''<resource-name>'' 
:Start a loaded resource eg: start admin
====stop====
:Usage: stop ''<resource-name>'' 
:Stop a resource eg: stop admin
====stopall====
:Stop all running resources
====upgrade====
:<ins>Server console only</ins>
:Usage: upgrade [ ''all'' | ''<resource-name>'' ] 
:Perform a basic upgrade of all resources. The [[Server_Commands#checkall|check]] command shows the list of changes this command will make.

====aclrequest====
:Usage: aclrequest [ ''list'' | ''allow'' | ''deny'' ] ''<resource-name>'' [ ''<right>'' | ''all'' ] 
:Manage ACL requests from resources implementing <aclrequest> in their [[meta.xml]]

==Account commands==
====aexec====
:Usage: aexec ''<nick>'' ''<command>'' 
:Force a player to execute a command eg: aexec playername say hello

====addaccount====
:Usage: addaccount ''<accountname>'' ''<password>'' 
:Add an account eg: addaccount accountname password

====chgpass====
:Usage: chgpass ''<accountname>'' ''<password>'' 
:Change an accounts password eg: chgpass account newpw
====delaccount====
:Usage: delaccount ''<accountname>'' 
:Delete an account eg: delaccount accountname

==Server commands==
====ase====
:<ins>Server console only</ins>
:See the amount of master server list queries
====debugdb====
:Usage: debugdb ''<''0-2''>'' 
:<ins>Server console only</ins>
:Set logging level for database functions. [0-Off  1-Errors only  2-All]
:By default, logging output is written to the file '''logs/db.log''' unless another file is declared in the [[Mtaserver.conf#dbfile|<dbfile> section of mtaserver.conf]]
====help====
:<ins>Server console only</ins>
:Displays these list of commands
====loadmodule====
:<ins>Server console only</ins>
:Usage: loadmodule ''<module-filename>'' 
:Load a module eg: loadmodule ml_sockets.dll
====unloadmodule====
:<ins>Server console only</ins>
:Usage: unloadmodule ''<module-filename>'' 
:Unload a module eg: unloadmodule ml_sockets.dll
====reloadmodule====
:<ins>Server console only</ins>
:Usage: reloadmodule ''<module-filename>'' 
:Reload a module eg: reloadmodule ml_sockets.dll
====openports====
:<ins>Server console only</ins>
:Test if server ports are open
====shutdown====
:Usage: shutdown ''<reason>'' 
:Shutdown the server eg: shutdown put reason here
====sver====
:Get the server MTA version

==Other commands==
====say====
:Usage: say ''<text>'' 
:Show a message to all players on the server eg: say hello
====whois====
:Usage: whois ''<nick>'' 
:Get the IP of a player currently connected (use whowas for IP/serial/version)
====whowas====
:Usage: whowas ''<nick>'' 
:Get IP/Serial/username of a player that was previously connected to the server
====ver====
:Get the MTA version

==Client relevant only==
====chgmypass====
:<ins>Client only</ins>
:Usage: chgmypass ''<oldpass>'' ''<newpass>'' 
:Change your password eg: chgmypass oldpw newpw
====debugscript====
:<ins>Client only</ins>
:Usage: debugscript ''<''0-3''>'' 
:Remove (This does not work "Incorrect client type for this command")
====login====
:<ins>Client only</ins>
:Usage: login ''<accountname>'' ''<password>'' 
:Login to an account eg: login accountname password

====logout====
:<ins>Client only</ins>
:Log out of the current account
====me====
:<ins>Client only</ins>
:Usage: me ''<text>'' 
:Show a message to all players on the server, with your nick prepended
====msg====
:<ins>Client only</ins>
:Usage: msg ''<nick>'' ''<text>'' 
:Send a message to a player eg: msg playername hello
====nick====
:<ins>Client only</ins>
:Usage: nick ''<old-nick>'' ''<new-nick>'' 
:Change your ingame nickname
====teamsay====
:<ins>Client only</ins>
:Usage: teamsay ''<test>'' 
:Send a message to all players on the same team

[[Category: Support]]
[[ru:Server Commands]]

Scripting Introduction

2016-11-02T19:38:40Z

Walid: Undo revision 49746 by Gerry (talk)

Resources are a key part of MTA. A resource is essentially a folder or zip file that contains a collection of files, plus a meta file that describes to the server how the resource should be loaded and what files it does contain. A resource can be seen as being partly equivalent to a program running in an operating system - it can be started and stopped, and multiple resources can run at once.

Everything that has to do with scripting happens in resources, what a resource does defines if it is a gamemode, a map or anything else. MTA comes with resources that you can optionally use in your gamemodes, such as maplimits to keep playings within a playing area or deathpickups to create weapon pickups.
{{tip|Your first step to begin Lua scripting should be using an Lua editor. This makes scripting much easier. We recommend [http://www.sublimetext.com/ Sublime Text], [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] or [http://luaedit.sourceforge.net/ LuaEdit]. There is also an unofficial [[MTASE|MTA Script Editor]] (in work-in-progress state) that you can test out.}}

==Creating a working script==
We will first learn how to make a basic script that lets the player walk around in the city, step by step.
===Where are all the scripts?===
Let's take a look at the script's file structure. Go to your MTA Server folder, and follow the path below:

server/mods/deathmatch/resources/

You will see a lot of .zip files, which are the packaged sample scripts shipped with MTA. Each file is a "resource", and they will all be unzipped and loaded by the server when it starts. To create your own resource, simply make a folder with your preferred name. We'll use "myserver" for this tutorial.

Now you should be under this directory:

server/mods/deathmatch/resources/myserver/

===Identifying your resource===
In order to let the server know what's in the resource, a ''meta.xml'' file must be created to list the resource's content. It must be located in the resource's root directory, which is the "myserver" folder in our case. So create a text file and name it "meta.xml", and open it with notepad.

Enter the following codes in the ''meta.xml'' file:
<syntaxhighlight lang="xml">
<meta>
<info author="YourName" type="gamemode" name="My Server" description="My first MTA server" />
<script src="script.lua" />
</meta>
</syntaxhighlight>
In the ''<info />'' tag, there's a "type" field which indicates that the resource is a ''gamemode'' instead of a regular include or a ''map'', which will be explained later. A gamemode is what you need to make a stand-alone server.

The ''<script />'' tag indicates the script files contained in the resource, which we will create next.
===Creating a simple script===
Note that in the ''<script />'' tag above, the .lua file is not under another directory. Therefore we'll create the file in the same folder as meta.xml. Now you can copy and paste the following code into script.lua:
<syntaxhighlight lang="lua">
local spawnX, spawnY, spawnZ = 1959.55, -1714.46, 10
function joinHandler()
spawnPlayer(source, spawnX, spawnY, spawnZ)
fadeCamera(source, true)
setCameraTarget(source, source)
outputChatBox("Welcome to My Server", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>
The script will spawn you at the coordinate (x, y, z) specified above, when you join the game. Note that the ''fadeCamera'' function must be used or the screen will be black. Also, in releases after DP2, you need to set the camera target (otherwise all the player will see is blue sky).

The '''source''' variable indicates who triggered the event. Since a player has joined when the code is triggered, you use this variable to look which has joined. So it'll spawn that player instead of everyone or a random person.

If we have a closer look on [[addEventHandler]], you can see 3 things: 'onPlayerJoin', which indicates when it's triggered. getRootElement(), which shows by what/who it can be triggered. (getRootElement() is everything/everyone) And joinHandler, which indicates the function that has to be triggered after the event is triggered. Other details will be explained later in another example, now let's just run the server and try it out!

===Running the script===
To get the server started, simply run the executable under the server/ directory. A list of server stats will be shown first; note the port number, which you'll need when joining the game. Then the server loads all the resources under the mods/deathmatch/resources/ directory, and then "ready to accept connections!"

Before you connect to the server, you must run the gamemode. Type "start myserver" and press Enter. The server will start the gamemode you just created, and will also show any errors and warnings from this point on. Now you can start the MTA client, and "Quick Connect" using the IP address of your server and the port number you saw earlier. If all goes well, after a few seconds your character will be walking on the streets of Los Santos.

Next we'll add a command to your script that players can use to spawn a vehicle beside their position. You may skip it and check out more advanced scripting with the [[Map manager|Map Manager]], which continues this tutorial. Another branch from this tutorial is [[Introduction to Scripting GUI]], you may follow it to see how Graphical User Interface in MTA is drawn and scripted.

==Creating a simple command==
Let's go back to the content of the ''script.lua'' file. As mentioned above, we want to provide a command to create a vehicle beside your current position in the game. Firstly we need to create a function we want to call and a command handler that creates the command the player will be able to enter in the console.

<syntaxhighlight lang="lua">
-- create the function the command handler calls, with the arguments: thePlayer, command, vehicleModel
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- create a vehicle and stuff
end

-- create a command handler
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>
''Note: Function names are clickable in code examples on the wiki and linked to the functions' documentation.''

====About command handlers====
The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.

If you have already experience in scripting, you will know that you call a function like this:
<syntaxhighlight lang="lua">
functionName(argument1, argument2, argument3, ..)
</syntaxhighlight>
<syntaxhighlight lang="lua">
functionName(thePlayer, commandName, argument3, ..)
</syntaxhighlight>
If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.

We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similiar manner, internally.

For example: Someone types "createvehicle 468" ingame in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:
<syntaxhighlight lang="lua">
createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command
</syntaxhighlight>
As we can see, it provides several parameters: the player who called the command, the command he entered and whatever text he had after that, in this case "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).

''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''

====Writing the function====
In order to fill the function we created, we need to think about what we have to do:
* Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)
* Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)
* Spawn the vehicle
* Check if it has been spawned successfully, or output a message

In order to achieve our goals, we have to use several functions. To find function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First we need a function to get the players position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns and usually an example. The syntax shows us what arguments we can or have to submit.

For [[getElementPosition]], the syntax is:
<syntaxhighlight lang="lua">
float, float, float getElementPosition ( element theElement )
</syntaxhighlight>

The three ''float'' in front of the function name are the return type. In this case it means the function returns three floating point numbers. (x, y and z) Within the parentheses, you can see what arguments you have to submit. In this case only the element whose position you want to get, which is the player in our example.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- get the position and put it in the x,y,z variables
-- (local means, the variables only exist in the current scope, in this case, the function)
local x,y,z = getElementPosition(thePlayer)
end
</syntaxhighlight>

Next we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
end
</syntaxhighlight>

Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.

We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
-- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
end
</syntaxhighlight>

Of course this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.

Now we have our complete script:
<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
-- check if the return value was ''false''
if (createdVehicle == false) then
-- if so, output a message to the chatbox, but only to this player.
outputChatBox("Failed to create vehicle.",thePlayer)
end
end
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>

As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].

==What you need to know==
You already read some things about resources, command handlers and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things, while linking to related pages if possible.
===Clientside and Serverside scripts===
You may have already noticed these or similiar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features, but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still others are better off to be serverside or just don't work clientside.

Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script for example, you would create a ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:
<syntaxhighlight lang="xml">
<script src="client.lua" type="client" />
</syntaxhighlight>
The ''type'' attribute defaults to 'server', so you only need to specify it for clientside scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].

===More complex resources===
The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:

====First example - A utility script====
<syntaxhighlight lang="xml">
/admin_commands
/meta.xml
/commands.lua
/client.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="admin commands" />
<script src="commands.lua" />
<script src="client.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server
* The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily

This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also wont interfere with the gameplay, unless an admin decides to take some action of course.

====Second example - A gamemode====
<syntaxhighlight lang="xml">
/counterstrike
/meta.xml
/counterstrike.lua
/buymenu.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike remake" type="gamemode" />
<script src="counterstrike.lua" />
<script src="buymenu.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''counterstrike.lua'' contains similiar to the following features:
** Let players choose their team and spawn them
** Provide them with weapons, targets and instructions (maybe read from a Map, see below)
** Define the game's rules, e.g. when does the round end, what happens when a player dies
** .. and maybe some more
* The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons

This example can be called a gamemode, since it not only intereferes with the gameplay, but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.

This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example for a map is stated in the next example.

====Third example - A Map====
<syntaxhighlight lang="xml">
/cs-airport
/meta.xml
/airport.map
/airport.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" />
<map src="airport.map" />
<script src="airport.lua" />
</meta>
</syntaxhighlight>

* The ''airport.map'' in a XML file that provides information about the map to the gamemode, these may include:
** Where the players should spawn, with what weapons, what teams there are
** What the targets are
** Weather, World Time, Timelimit
** Provide vehicles
* The ''airport.lua'' might contain map-specific features, that may include:
** Opening some door/make something explode when something specific happens
** Create or move some custom objects, or manipulate objects that are created through the .map file
** .. anything else map-specific you can think of

As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case the gamemode from the above example.
What may come as a surprise is that there is also a script in the Map resource. Of course this is not necessarily needed in a map, but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.

The ''airport.map'' file might look similiar to this:
<syntaxhighlight lang="xml">
<map mode="deathmatch" version="1.0">
<terrorists>
<spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" />
</terrorists>
<counterterrorists>
<spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" />
</counterterrorists>

<bomb posX="23342.23" posY="" posZ="" />

<vehicle posX="" posY="" posZ="" model="602" />
<vehicle posX="" posY="" posZ="" model="603" />
</map>
</syntaxhighlight>

When a gamemode is started with a map, the map resources is automatically started by the mapmanager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.

===Events===
[[Event|Events]] are the way MTA tells scripts about things that happen. For example when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similiar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].

This example will output a message with the name of the player who died:
<syntaxhighlight lang="lua">
function playerDied(totalAmmo, killer, killerWeapon, bodypart)
outputChatBox(getPlayerName(source).." died!")
end
addEventHandler("onPlayerWasted",getRootElement(),playerDied)
</syntaxhighlight>

Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similiar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea how ''source'' is used.

==Where to go from here==
You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.
{{note|From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts. We also recommend you to use the [[predefined variables list]] to help you with certain tasks and make scripting easier and faster.}}
'''See also:'''
* [[OOP_Introduction|OOP Scripting Introduction]]
* [[Advanced Topics]]
* [[Script_security|Script security]]
* [[Scripting Introduction Urdu]]
[[es:Introducción a la Programación]]
[[it:Introduzione allo scripting]]
[[nl:Scripting_introductie]]
[[pt-br:Introdução ao Scripting]]
[[ru:Scripting Introduction]]
[[ar:مقدمه_في_البرمجه]]
[[zh-cn:脚本编写介绍]]
[[Category:Tutorials]]

User:J.Chaikos

2016-10-31T01:01:48Z

Walid:

When posting useful functions to the wiki, you should write their articles in English, because it is an international section of this wiki that should be understandable by everybody. Could you please translate the [[slowlyMusicStop]] article to English, then? Thank you. --[[User:AlexTMjugador|AlexTMjugador]] ([[User talk:AlexTMjugador|talk]]) 16:31, 30 October 2016 (UTC)

Just do it by yourself, the title says it all. sorry i'm using the phone maybe i will translate it later. --[[User:Walid|Walid]] ([[User talk:Walid|talk]])

OnPlayerWeaponFire

2016-10-25T23:40:26Z

Walid: The source of this event is the player who fired the weapon.

{{Server event}}
__NOTOC__
{{New feature/item|3.0153|1.5.3|9921|
This event is called when a player fires a weapon. This does not trigger for projectiles, melee weapons, or camera.
}}
{{Note|This event works only with weapons which have enabled bullet sync.}}
==Parameters==
<syntaxhighlight lang="lua">
int weapon, float endX, float endY, float endZ, element hitElement, float startX, float startY, float startZ
</syntaxhighlight>
*'''weapon''': an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''endX''', '''endY''', '''endZ''': [[float]] world coordinates representing an end point.
*'''hitElement''': an [[element]] which was hit by a shot.
*'''startX''', '''startY''', '''startZ''': [[float]] world coordinates representing the start of the bullet. Note: This is not the gun muzzle.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who fired the weapon.

==Example==
This code outputs the information on debug screen when a player shoots.
<syntaxhighlight lang="lua">
addEventHandler ("onPlayerWeaponFire", root,
function (weapon, endX, endY, endZ, hitElement, startX, startY, startZ)
iprint (getPlayerName(source).. " just shot a " .. getElementType (hitElement) .. " at X: ".. endX .. " Y: " .. endY .. " Z: " .. endZ .. " from X: " .. startX .. " Y: ".. startY .. " Z: " .. startZ .. " with a ".. getWeaponNameFromID (weapon))
end
)
</syntaxhighlight>

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

ShowPlayerHudComponent

2016-10-25T21:53:49Z

Walid: Deprecated function

__NOTOC__
{{Server client function}}
{{Deprecated|setPlayerHudComponentVisible}}

This function will show or hide a part of the player's HUD.
{{Deprecated_feature|3|1.0|
Component 'clock' does not hide the clock
}}

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( player thePlayer, string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player element for which you wish to show/hide a HUD component
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature/item|3.0110|1.1||
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>

===Returns===
Returns ''true'' if the component was shown or hidden succesfully, ''false'' if an invalid argument was specified.

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
function hudChanger ()
showPlayerHudComponent ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
showPlayerHudComponent ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

WarpPlayerIntoVehicle

2016-10-16T17:42:01Z

Walid: Deprecated function

__NOTOC__
{{Server function}}
{{Deprecated|warpPedIntoVehicle}}

This function is used to warp or force a player into a vehicle. There are no animations involved when this happens.

==Syntax==
<syntaxhighlight lang="lua">
bool warpPlayerIntoVehicle ( player thePlayer, vehicle theVehicle, [ int seat=0 ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player which you wish to force inside the vehicle
*'''theVehicle:''' The vehicle you wish to force the player into

===Optional Arguments===
{{OptionalArg}}
*'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats.

===Returns===
Returns ''true'' if the operation is successful, ''false'' otherwise.

==Example==
This example creates a vehicle and warps a player inside immediately
<syntaxhighlight lang="lua">
function createstartvehicles ( playerSource, commandName, car, x, y, z ) -- the function allows specification of your car, and the position
local racevehicle = createVehicle ( car, x, y, z ) -- create a vehicle at the position specified by the startrace command
warpPlayerIntoVehicle ( playerSource, racevehicle ) -- warp them straight into the vehicle
end
addCommandHandler ( "startrace", createstartvehicles ) -- add a command to start race
</syntaxhighlight>

==See Also==
{{Player functions}}

SetPedArmor

2016-10-10T11:43:39Z

Walid:

__NOTOC__
{{Server function}}
This function allows you to set the armor value of a [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
bool setPedArmor ( ped thePed, float armor )
</syntaxhighlight>
{{OOP||[[ped]]:setArmor|armor|getPedArmor}}

===Required Arguments===
*'''thePed''': the [[ped]] whose armor you want to modify.
*'''armor''': the amount of armor you want to set on the ped. Valid values are from 0 to 100.

===Returns===
Returns ''true'' if the armor was changed succesfully. Returns ''false'' if an invalid ped was specified, or the armor value specified is out of acceptable range.

==Example==
This example removes the armor of a player.
<syntaxhighlight lang="lua">
function armor (player, command)
if command == "addarmor" then
setPedArmor ( player, 100 ) -- Set player's armor to 100 when he types the command 'addarmor'
elseif command == "removearmor" then
setPedArmor ( player, 0 ) -- Set player's armor to 0 when he types the command 'removearmor'
end
end
addCommandHandler ("addarmor", armor)
addCommandHandler ("removearmor", armor)

</syntaxhighlight>

In this, adds an amount of armor that the player defined in command 'addarmor'.
<syntaxhighlight lang="lua">
function givePlayerArmor( player, command, amount )
if getPedArmor(player) == 100 then
outputChatBox("Your armor already is complete!", player, 220, 0, 0 ) -- Inform the player if your armor already is complete.
return
end

if amount and tonumber(amount) >= 1 or tonumber(amount) <= 100 then -- If amount is between 1 and 100.
setPedArmor(player, tonumber(amount)) -- Set amount armor that player chosen on the command.
else
outputChatBox( "Syntax: /addarmor [armor-amount] the amount should be between 1 and 100", player, 220, 0, 0 ) -- Inform the player if 'amount' argument is missing.
end
end
addCommandHandler( "addarmor", givePlayerArmor )
</syntaxhighlight>

==See Also==
{{Ped functions}}
[[ru:setPedArmor]]

IsElementWithinAColShape

2016-10-10T11:30:20Z

Walid: The predefined variable localPlayer and getLocalPlayer() are the same thing.

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function checks if the [[element]] is in a [[colshape]].

==Syntax==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( element theElement ) </syntaxhighlight></section>
<section name="Client" class="client" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( [ element theElement ] ) </syntaxhighlight></section>

===Required/Optional Arguments===
* '''theElement''': The element you want to check. (If not entered in client-side function, local player will be checked instead.)

===Returns===
Returns a [[colshape]] the [[element]] is in else false if the element isn't in one or no arguments were passed.

===Code===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isElementWithinAColShape(element)
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Invalid arguments or element does not exist",1)
return false
end</syntaxhighlight></section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isElementWithinAColShape(element)
local element = element or localPlayer
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Element does not exist",1)
return false
end</syntaxhighlight></section>

===Example===
<section name="Server" class="server" show="true">
This code will destroy the colshape the player is currently in when he types the command '/deletecol'.
<syntaxhighlight lang="lua">
function deleteColShape(thePlayer, command)
local colshape = isElementWithinAColShape(thePlayer)
if colshape then -- if the player who entered the command is in a colshape
outputChatBox("The colshape you are in has been successfully deleted!", thePlayer, 0, 255, 0)
destroyElement(colshape) -- destroy the col shape he is in
else
outputChatBox("You are currently not in a colshape", thePlayer, 255, 0, 0) -- if he is not in the colshape
end
end
addCommandHandler("deletecol", deleteColShape)
</syntaxhighlight></section>

==See Also==
{{Useful_Functions}}

GetKeyState

2016-10-10T11:03:31Z

Walid:

__NOTOC__
{{Client function}}
This function determines if a certain key is pressed or not.

'''Note:''' 'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr

==Syntax==
<syntaxhighlight lang="lua">
bool getKeyState ( string keyName )
</syntaxhighlight>

===Required Arguments===
*'''keyName:''' The name of the key you're checking state of. See [[Key names]].

===Returns===
Returns ''true'' if the specified key is pressed, ''false'' if it isn't or if an invalid key name is passed.

==Example==
This clientside example prints a message when "p" is pressed, and a different one for the "control+p" combination.
<syntaxhighlight lang="lua">
-- define a function that outputs a message if control is pressed, and a different one if it isn't
function printMessageFunction()
-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
if getKeyState( "lctrl" ) == true or getKeyState( "rctrl" ) == true then
outputChatBox ( "You have pressed 'control+p'." )
-- if none of those were pressed, he just pressed the "p" key
else
outputChatBox ( "You have pressed 'p'." )
end
end
-- bind the "p" key to our function
bindKey( "p", "down", printMessageFunction )
</syntaxhighlight>

==See Also==
{{Client_input_functions}}

Object IDs

2016-10-09T20:47:49Z

Walid:

This page displays object id's.

==Beach and Sea==
<gallery mode="packed">
Image:BeachandSeaGeneral.jpg|'' General
Image:ShipsDocksandPiers1.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers2.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers3.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers4.jpg|'' Ships, Docks and Piers
Image:ShipsDocksandPiers5.jpg|'' Ships, Docks and Piers
</gallery>

==Buildings==
<gallery mode="packed" >
Image:BarsClubsandCasinos.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos2.jpg|'' Bars, Clubs and Casinos
Image:BarsClubsandCasinos3.jpg|'' Bars, Clubs and Casinos
Image:FactoriesandWarehouses.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses2.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses3.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses4.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses5.jpg|'' Factories and Warehouses
Image:FactoriesandWarehouses6.jpg|'' Factories and Warehouses
Image:OfficesandSkyscrapers.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers2.jpg|'' Offices and Skyscrapers
Image:OfficesandSkyscrapers3.jpg|'' Offices and Skyscrapers
Image:OtherBuildings.jpg|'' Other Buildings
Image:OtherBuildings2.jpg|'' Other Buildings
Image:OtherBuildings3.jpg|'' Other Buildings
Image:OtherBuildings4.jpg|'' Other Buildings
Image:RestaurantsandHotels.jpg|'' Restaurants and Hotels
Image:RestaurantsandHotels2.jpg|'' Restaurants and Hotels
Image:SportsandStadiums.jpg|'' Sports and Stadiums
Image:SportsandStadiums2.jpg|'' Sports and Stadiums
</gallery>

==Industrial==
<gallery mode="packed">
Image:Cranes.jpg|'' Cranes
Image:CratesDrumsandRacks.jpg|'' Crates, Drums and Racks
Image:CratesDrumsandRacks2.jpg|'' Crates, Drums and Racks
Image:IndustrialGeneral.jpg|'' General
Image:IndustrialGeneral2.jpg|'' General
</gallery>

work in progress

IsPlayerMapVisible

2016-10-09T20:22:58Z

Walid: Removed {{Needs Example}}

__NOTOC__
{{Client function}}
This function checks if the local player has their map showing

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerMapVisible ()</syntaxhighlight>

===Returns===
Returns ''true'' if the player has the map visible, ''false'' otherwise.

==Example==
<section name="Example 1" class="client" show="true"><syntaxhighlight lang="lua">
function checkMap()
local text = (isPlayerMapVisible() and "You are currently viewing your map!") or "Your map is not visible!"
outputChatBox(text, 255, 255, 0) -- output text
end
addCommandHandler("map", checkMap) -- add '/map' command to the check
</syntaxhighlight></section>

<section name="Example 2" class="client" show="true"><syntaxhighlight lang="lua">
function showMap()
if isPlayerMapVisible() then
outputChatBox("Radar closed", 0, 255, 0)
forcePlayerMap(false)
else
outputChatBox("Viewing radar", 0, 255, 0)
forcePlayerMap(true)
end
end
addCommandHandler("showmap", showMap)
</syntaxhighlight></section>

==See Also==
{{Client player functions}}

GetCommandHandlers

2016-10-09T20:12:13Z

Walid:

{{Server function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).
}}

==Syntax==
<syntaxhighlight lang="lua">
table getCommandHandlers ( [ resource theResource ] )
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.

===Returns===
Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } ). See examples below if you don't understand it.

==Example==
<section class="server" name="Server" show="true">
This example add a command to output list of all commands in the chat.
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function(player)
local commandsList = {} --table to store commands

--store/sort commands in the table where key is resource and value is table with commands
for _, subtable in pairs( getCommandHandlers() ) do
local commandName = subtable[1]
local theResource = subtable[2]

if not commandsList[theResource] then
commandsList[theResource] = {}
end

table.insert( commandsList[theResource], commandName )
end

--output sorted information in the chat
for theResource, commands in pairs( commandsList ) do
local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

--output list of commands
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
end
)
</syntaxhighlight>
</section>

<section class="server" name="Server" show="true">
This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
<syntaxhighlight lang="lua">
addCommandHandler("commands",
function( player, _, resourceName)
local theResource = (resourceName and getResourceFromName(resourceName)) or resource
outputChatBox( "* Commands from "..getResourceName(theResource).." resource", player, 0, 255, 0 )

local commands = getCommandHandlers( theResource )
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

IsPlayerDoingTask

2016-09-30T11:35:31Z

Walid: Deprecated function

__NOTOC__
{{Client function}}
{{Deprecated|isPedDoingTask}}

This function checks if the specified player is carrying out a certain [[List of player tasks|task]].

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerDoingTask ( player thePlayer, string taskName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': A [[player]] object referencing the specified player.
* '''taskName''': A string containing the name of the [[List of player tasks|task]] you're checking for.

===Returns===
Returns ''true'' if the player is currently doing the task, ''false'' otherwise.

==Example==
This example checks if the player who entered the 'doingdriveby' command is doing a drive-by (clientside).
<syntaxhighlight lang="lua">
function amIDoingADriveby ()
if ( isPlayerDoingTask ( getLocalPlayer(), "TASK_SIMPLE_GANG_DRIVEBY" ) ) then
outputChatBox ( getPlayerName ( getLocalPlayer() ) .. " is doing a driveby!!!" )
else
outputChatBox ( getPlayerName ( getLocalPlayer() ) .. " is not doing a driveby" )
end
end
addCommandHandler ( "doingdriveby", amIDoingADriveby )
</syntaxhighlight>

==See Also==
{{Client player functions}}

AR/setMarkerSize

2016-09-27T17:04:55Z

Walid:

<lowercasetitle/>
__NOTOC__
{{Server client function}}
هذه الوظيفة تقوم بتعديل حجم الماركر

==Syntax==
<syntaxhighlight lang="lua">
bool setMarkerSize ( marker theMarker, float size )
</syntaxhighlight>
{{OOP||[[Marker]]:setSize|size|getMarkerSize}}
===Required Arguments===
*'''theMarker:''' الماركر الذي تريد تغيير حجمه
*'''size:''' الحجم الذي تريده للماركر

هذا المثال يقوم بعمل ماركر ويعطيه حجم 2.5
<syntaxhighlight lang="lua">
newmarker = createMarker ( 1000, 1000, 1000, "cylinder" ) --- نصنع الماركر
setMarkerSize ( newmarker, 2.5 ) --- و نعطيه حجم 2.5
</syntaxhighlight>

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

AR/getAccounts

2016-09-26T23:30:53Z

Walid:

__NOTOC__
{{Server function}}
internal.db هذه الوظيفة تقوم بالرد بجدول يحتوي على جميع الحسابات الموجودة في السيرفر في الملف

(1.0.4 لم يعد يستخدم في الأصدارات الأحدث من accounts.xml ملاحظة: الملف)
==Syntax==
<syntaxhighlight lang="lua">
table getAccounts()
</syntaxhighlight>

===Returns===
قد يكون الجدول فارغاً . internal.db يحتوي على جميع الحسابات الموجودة في السيرفر في الملف [[table]] جدول

==مـــثال==
يستخدم هذا المثال في معرفة عدد الحسابات المسجلة في السيرفر
<syntaxhighlight lang="lua">
function printAmountOfAccounts(thePlayer)
local accountTable = getAccounts() -- الجدول الذي يحتوي على الحسابات
if #accountTable == 0 then -- إذا كان الجدول فارغاً
outputChatBox("There are no accounts. :(", thePlayer)
else -- إذا كان الجدول غير فارغاً
outputChatBox("There are "..#accountTable.." accounts in this server!", thePlayer)
end
end
addCommandHandler("accountcount", printAmountOfAccounts) -- نظيف امر جديد وهو 'accountcount'
</syntaxhighlight>

==انظر ايضاً==
{{AR Account functions}}

[[ar:addAcount]]

Special Skins Page

2016-09-15T23:20:44Z

Walid: New structure and Model names

Template:Useful Functions

2016-09-15T23:14:58Z

Walid: Added dxDrawTriangle

*[[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.
*[[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.
*[[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.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[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.
*[[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.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[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.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[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
*[[removeHex]] » This function is used to remove hex color codes from strings.
*[[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]]

DxDrawTriangle

2016-09-15T23:09:49Z

Walid: Created page with "{{Useful Function}} <lowercasetitle/> __NOTOC__ This is a function that will create a triangle with dx lines. ==Syntax== <syntaxhighlight lang="lua">bool dxDrawTriangle( float x, float y, f..."

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This is a function that will create a triangle with dx lines.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawTriangle( float x, float y, float width, float height, [int color, int width=1, bool postGUI=false ] )</syntaxhighlight>

===Required Arguments===
* '''x:''' An integer representing the absolute start X position of the line, represented by pixels on the screen.
* '''y:''' An integer representing the absolute start Y position of the line, represented by pixels on the screen.
* '''width:''' An float representing the width of the area, drawn in a right direction from the origin.
* '''height:''' An float representing the height of the triangle, drawn in a downwards direction from the origin.

==Optional Arguments==
{{OptionalArg}}
* '''color:''' the hex color of the triangle, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''width:''' An integer representing how thick the lines will be.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawTriangle(x, y, width, height, color, _width, postGUI)

if (type(x) ~= "number") or (type(y) ~= "number") then
return false
end

local _width = (type( _width ) == "number" and _width) or 1
local color = color or tocolor( 255, 255, 255, 200 )
local postGUI = (type( postGUI ) == "boolean" and postGUI) or false

dxDrawLine ( x+width/2, y, x, y+height, color, _width, postGUI )
dxDrawLine ( x+width/2, y, x+width, y+height, color, _width, postGUI )
return dxDrawLine ( x, y+height, x+width, y+height, color, _width, postGUI )
end</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a white triangle.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ()
dxDrawTriangle(900,350, 150, 150)
end
)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}

Character Skins

2016-09-13T11:47:57Z

Walid: Added the new skin page #13 (290-312)

Skins that the player may use (pedestrian skins).

*[[All Skins Page]] - Not recommended for slow Internet
*[[Special Skins Page]] - New skins available after MTA 1.1
*[[Gang Skins]]
*[[Female Skins]]
*[[Male Skins]]
<syntaxhighlight lang="lua">
maleSkins = {0, 1, 2, 7, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 57, 58, 59, 60, 61, 62, 66, 67, 68, 70, 71, 72, 73, 78, 79, 80, 81, 82, 83, 84, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 120, 121, 122, 123, 124, 125, 126, 127, 128, 132, 133, 134, 135, 136, 137, 142, 143, 144, 146, 147, 153, 154, 155, 156, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 170, 171, 173, 174, 175, 176, 177, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 200, 202, 203, 204, 206, 209, 210, 212, 213, 217, 220, 221, 222, 223, 227, 228, 229, 230, 234, 235, 236, 239, 240, 241, 242, 247, 248, 249, 250, 252, 253, 254, 255, 258, 259, 260, 261, 262, 264, 265, 266, 267, 268, 269, 270, 271, 272, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 290, 291, 292, 293, 294, 295, 296, 297, 299, 300, 301, 302, 303, 305, 306, 307, 308, 309, 310, 311, 312}
femaleSkins = {9, 10, 11, 12, 13, 31, 38, 39, 40, 41, 53, 54, 55, 56, 63, 64, 69, 75, 76, 77, 85, 87, 88, 89, 90, 91, 92, 93, 129, 130, 131, 138, 139, 140, 141, 145, 148, 150, 151, 152, 157, 169, 172, 178, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 201, 205, 207, 211, 214, 215, 216, 218, 219, 224, 225, 226, 231, 232, 233, 237, 238, 243, 244, 245, 246, 251, 256, 257, 263, 298, 304}
</syntaxhighlight>

{{New items|3.0160|1.6.0|
* The following ID's were unused by GTA SA, so in MTA SA we have applied the same character skin to each of the following ID's. This allows servers to apply skin mods to these new ID's. These are the new 236 ID's you can use for new skins:
<syntaxhighlight lang="lua">
3, 4, 5, 6, 8, 42, 65, 74, 86, 119, 149, 208, 273, 289, 329, 340, 382, 383, 398, 399,
612, 613, 614, 662, 663, 665, 666, 667, 668, 699, 793, 794, 795, 796, 797, 798, 799, 907,
908, 909, 965, 999, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205,
1206, 1326, 1573, 1699, 2883, 2884, 3136, 3137, 3138, 3139, 3140, 3141, 3142, 3143, 3144,
3145, 3146, 3147, 3148, 3149, 3150, 3151, 3152, 3153, 3154, 3155, 3156, 3157, 3158, 3159,
3160, 3161, 3162, 3163, 3164, 3165, 3166, 3176, 3177, 3179, 3180, 3181, 3182, 3183,
3184, 3185, 3186, 3188, 3189, 3190, 3191, 3192, 3194, 3195, 3196, 3197, 3198, 3199, 3200,
3201, 3202, 3203, 3204, 3205, 3206, 3207, 3208, 3209, 3210, 3211, 3212, 3213, 3215,
3216, 3217, 3218, 3219, 3220, 3222, 3223, 3224, 3225, 3226, 3227, 3228, 3229, 3230, 3231,
3232, 3233, 3234, 3235, 3236, 3237, 3238, 3239, 3240, 3245, 3247, 3248, 3251, 3254,
3266, 3348, 3349, 3416, 3429, 3610, 3611, 3784, 3870, 3871, 3883, 3889, 3974, 4542, 4543,
4544, 4545, 4546, 4547, 4548, 4549, 4763, 4764, 4765, 4766, 4767, 4768, 4769, 4770, 4771,
4772, 4773, 4774, 4775, 4776, 4777, 4778, 4779, 4780, 4781, 4782, 4783, 4784, 4785, 4786,
4787, 4788, 4789, 4790, 4791, 4792, 4793, 4794, 4795, 4796, 4797, 4798, 4799, 4800, 4801,
4802, 4803, 4804, 4805, 5090, 5104, 5376, 5377, 5378, 5379, 5380, 5381, 5382, 5383,
5384, 5385, 5386, 5387, 5388, 5389
</syntaxhighlight>
|7701}}

'''Sectioned Skin Pages:'''
----
*[[Skins Page 1]]: 7, 9-29
*[[Skins Page 2]]: 30-41, 43-52
*[[Skins Page 3]]: 53-64, 66-73, 75-76
*[[Skins Page 4]]: 77-85, 87-99
*[[Skins Page 5]]: 100-118, 120-122
*[[Skins Page 6]]: 123-144
*[[Skins Page 7]]: 145-148, 150-167
*[[Skins Page 8]]: 168-189
*[[Skins Page 9]]: 190-207, 209-212
*[[Skins Page 10]]: 213-234
*[[Skins Page 11]]: 235-238, 240-257
*[[Skins Page 12]]: 258-264, 274-288
*[[Skins Page 13]]: 290-312

==Notes:==
*Last valid skin ID: 312

*The following pairs of IDs produce same character (1st ID used in lists, 2nd disabled)
**118:119
**148:149

*Non-working IDs
**3 4 5 6 8 42 65 74 86 119 149 208 273 289

==Skin functions==
{{Template:Skin_functions}}

==See Also==
[[id|ID Lists]]

[[tr:Karakter Tipleri]]
[[it:Skin Personaggi]]
[[ru:Character Skins]]
[[es:Skins de Personajes]]
[[de:Charakterskins]]
[[zh-cn:角色皮肤]]

[[Category:ID Lists]]

Skins Page 13

2016-09-13T11:46:16Z

Walid: Added Skin Page 13

Skins Page 12

2016-09-13T11:44:13Z

Walid:

Skins Page 11

2016-09-13T11:42:05Z

Walid:

Skins Page 10

2016-09-13T11:41:27Z

Walid:

Skins Page 9

2016-09-13T11:40:49Z

Walid:

Skins Page 8

2016-09-13T11:40:04Z

Walid:

Skins Page 7

2016-09-13T11:39:17Z

Walid: