Multi Theft Auto: Wiki - User contributions [en]

IsVehicleReversing

2017-12-20T20:18:03Z

Banex: /* Syntax */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is moving backwards or not. This is useful to create back lights on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleMovingBackwards(vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is going backwards, otherwise it returns ''false'' if the vehicle is going forwards or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleMovingBackwards(theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleMovingBackwards(vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleMovingBackwards(vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

IsVehicleReversing

2017-12-20T20:17:50Z

Banex: /* Examples */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is moving backwards or not. This is useful to create back lights on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleReturning (vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is going backwards, otherwise it returns ''false'' if the vehicle is going forwards or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleMovingBackwards(theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleMovingBackwards(vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleMovingBackwards(vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

IsVehicleReversing

2017-12-20T20:16:58Z

Banex: /* Examples */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is moving backwards or not. This is useful to create back lights on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleReturning (vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is going backwards, otherwise it returns ''false'' if the vehicle is going forwards or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleMovingBackwards(theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleMovingBackwards(vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleReturning (vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

IsVehicleReversing

2017-12-20T20:16:25Z

Banex: /* Function source */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is moving backwards or not. This is useful to create back lights on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleReturning (vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is going backwards, otherwise it returns ''false'' if the vehicle is going forwards or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleMovingBackwards(theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleReturning (vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleReturning (vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

Template:Useful Functions

2017-12-20T20:12:50Z

Banex: /* Vehicle funcions */

=== ACL functions ===
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span>
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span>
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span>
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span>

=== Account functions ===
*[[setAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to change an existing account's name.</span>
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from account .</span>

=== Camera functions ===
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.

=== Cursor functions ===
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>

=== Drawing functions ===
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span>
*[[dxDrawCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a number of 2D lines in order to achieve a circle shape on the screen.</span>
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span>
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span>
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span>
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle .</span>
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span>
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span>
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span>
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span>
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span>
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span>
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span>
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span>
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span>

=== Effects functions ===
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span>

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

=== Events ===
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span>

=== Input functions ===
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span>
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span>
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span>

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

=== GUI functions ===
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span>
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span>
=====Gridlists=====
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span>
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span>
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span>
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span>

=== Math functions ===
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span>
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span>
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span>
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span>
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span>

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

=== Resource functions ===
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span>
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files

=== Sound functions ===
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span>
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span>

=== Table functions ===
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span>
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span>
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span>
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span>
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span>
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span>
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span>
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span>
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span>
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span>
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span>

=== Team functions ===
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span>
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span>

=== Vehicle funcions ===
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span>
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span>
*[[getVehicleRespawnPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get the respawn position of a vehicle.</span>
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span>
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span>
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span>
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span>
*[[isVehicleMovingBackwards]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span>
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span>

=== XML functions ===
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span>

=== Utility ===
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span>
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span>
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span>
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span>
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span>
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span>
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span>
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span>
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span>
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span>
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span>
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span>
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span>

[[Category:Useful Functions]]

IsVehicleReturning

2017-12-20T20:11:40Z

Banex: Banex moved page IsVehicleReturning to IsVehicleMovingBackwards: This name is best suited for this function

#REDIRECT [[IsVehicleMovingBackwards]]

IsVehicleReversing

2017-12-20T20:11:40Z

Banex: Banex moved page IsVehicleReturning to IsVehicleMovingBackwards: This name is best suited for this function

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is moving backwards or not. This is useful to create back lights on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleReturning (vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is going backwards, otherwise it returns ''false'' if the vehicle is going forwards or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleReturning (theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleReturning (vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleReturning (vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

IsVehicleReversing

2017-12-20T11:41:38Z

Banex: /* Function source */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks if a vehicle is going back or not. This is useful to create back lights to the vehicle.

==Syntaxe==
<syntaxhighlight lang="lua">bool isVehicleReturning (vehicle theVehicle)</syntaxhighlight>

===Required arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the rear status of.

===Returns===
This function returns ''true'' if the vehicle is returning, otherwise it returns ''false'' if the vehicle is going forward or is stoped.

==Function source==
<section name="Script" class="both" show="true">
<syntaxhighlight lang="lua">function isVehicleReturning (theVehicle)
local getMatrix = getElementMatrix (theVehicle)
local getVelocity = Vector3 (getElementVelocity(theVehicle))
local getVectorDirection = (getVelocity.x * getMatrix[2][1]) + (getVelocity.y * getMatrix[2][2]) + (getVelocity.z * getMatrix[2][3])
if (getVectorDirection >= 0) then
return false
end
return true
end</syntaxhighlight>
</section>

==Examples==
<section name="Example 1" class="client" show="true">
This example shows to the player if their current vehicle is going back or not.
<syntaxhighlight lang="lua">
function vehCheck ()
local vehicle = getPedOccupiedVehicle (localPlayer)
if vehicle then
dxDrawText (tostring(isVehicleReturning (vehicle)), 10, 5) -- Show 'true' or 'false' on the screen.
end
end
addEventHandler ("onClientRender", getRootElement(), vehCheck)</syntaxhighlight>
Example by: LordHenry
</section>
<section name="Example 2" class="server" show="true">
This example creates a white corona marker attached to the current vehicle when it is going back and set the marker invisible (size 0) when not.
<syntaxhighlight lang="lua">
rearLightL = {}
rearLightR = {}

function setVehicleRearLightState (theVehicle, light, state)
local x, y, z = getElementPosition (theVehicle)
if getElementModel (theVehicle) == 426 or getElementModel (theVehicle) == 420 then -- If is a Premier or a Taxi
if light == 0 then
if state == 0 then
if not rearLightL[theVehicle] then
rearLightL[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightL[theVehicle], 0.1)
attachElements (rearLightL[theVehicle], theVehicle, -0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightL[theVehicle] then
setMarkerSize (rearLightL[theVehicle], 0)
end
elseif state == 2 then
if rearLightL[theVehicle] then
destroyElement (rearLightL[theVehicle])
rearLightL[theVehicle] = nil
end
end
elseif light == 1 then
if state == 0 then
if not rearLightR[theVehicle] then
rearLightR[theVehicle] = createMarker (x, y, z, "corona", 0.1, 255, 255, 255, 255)
end
setMarkerSize (rearLightR[theVehicle], 0.1)
attachElements (rearLightR[theVehicle], theVehicle, 0.85, -2.7, -0.05)
elseif state == 1 then
if rearLightR[theVehicle] then
setMarkerSize (rearLightR[theVehicle], 0)
end
elseif state == 2 then
if rearLightR[theVehicle] then
destroyElement (rearLightR[theVehicle])
rearLightR[theVehicle] = nil
end
end
else
return false
end
end
end

function isRearing ()
local everyone = getElementsByType ("player")
for i,v in ipairs (everyone) do
local vehicle = getPedOccupiedVehicle (v)
if vehicle then
if isVehicleReturning (vehicle) then
setVehicleRearLightState (vehicle, 0, 0) -- Turns the 'back light' on.
setVehicleRearLightState (vehicle, 1, 0)
else
setVehicleRearLightState (vehicle, 0, 1) -- Turns the 'back light' off.
setVehicleRearLightState (vehicle, 1, 1)
end
end
end
end
setTimer (isRearing, 100, 0)</syntaxhighlight>
Example by: LordHenry
</section>

== See also ==
{{Useful_Functions}}

O arquivo Meta

2015-09-27T23:15:36Z

Banex: /* Tags */ download_priority_group added

O ''meta.xml'' é um arquivo de metadados que define ao MTA os conceitos iniciais de um recurso. Exemplos seriam seu nome, os scripts a serem usados e quais devem ser pré-carregados para serem transferidos ao cliente; junto a outros de sua natureza. Ele também transforma arquivos em elementos, a exemplo de sons, imagens e modelos. É escrito em XML, o qual é baseado em HTML e é pai do XHTML.

''obs'': Metadados são dados sobre outros dados. O termo é estranho, mas o próprio nome já diz. No caso do MTA eles seriam metadados descritivos, pois se referem ao conteúdo do jogo.

=Tags=
O XML é um formato de texto muito usado para representar dados, inclusive pelo MTA. As tags a seguir são todas as possibilidades:

*'''<info />''' Representa informações sobre o recurso que podem ser usados de forma opcional, e lidos pela função [[getResourceInfo]], caso necessário:
** '''author:''' O autor do recurso
** '''version:''' A versão do recurso
** '''name:'''' O nome do recurso
** '''description:''' Uma breve descrição do recurso
** '''type:''' Qual é o tipo do recurso, pode ser um "gamemode", "script", "map", ou "misc".
* '''<script />''' O código fonte do recurso, os possíveis parâmetros são:
** '''src:''' O nome do arquivo do código fonte
** '''type:''' O tipo de código-fonte: "client", "server" ou "shared".
** '''cache:''' Quando o script é do tipo client, esse atributo diz se o arquivo será salvo ou não no disco rígido dele. O padrão é "true", se for usado o contrário, será apagado quando o recurso parar.
** '''validate:''' Se for definido como falso, o MTA não verificará se é compatível
* '''<map />''' Define mapa do gamemode, os possíveis atributos são:
** '''src:''' o nome do arquivo .map (pode também ser o diretório, ex: ''maps/nome-do-mapa.map)
** '''dimension:''' Dimensão em que o mapa será carregado (opcional)
* '''<File />''' Um arquivo do lado do cliente. Geralmente são imagens, .txd, .col, .dff ou arquivos .xml. Eles vão ser baixado pelos clientes quando o recurso é iniciado (ou quando ele entrar no servidor)
** '''src:''' nome do arquivo do lado do cliente (pode ser outro caminho por exemplo, "images/imagem.png".)
** '''download:''' Vai ou não ser enviado para o cliente automaticamente(opcional). O padrão é "true". Usando "false" significa que eles não são enviados no início de recursos, mas poderia ser usado posteriormente por DownloadFile (a partir da versão 1.4)
*'''<include />''' Inclui os recursos necessários a estarem rodando
**'''resource:''' Nome do recurso que você quer iniciar junto com esse
**'''minversion:''' A versão mínima desse recurso (opcional)
**'''maxversion:''' A versão máxima desse recurso (opcional)
*'''<config />''' O arquivo de configuração em XML a ser usado pelo recurso:
**'''src:''' Seu nome
**'''type:''' Seu tipo: "client" ou "server"
*'''<export />''' Exporta uma função do seu recurso, para que outros possam usa-la com o [[call]]
**'''function:''' O nome da função
**'''type:''' Diz se será exportado para o lado do cliente ou servidor (valores válidos são: "server" ou "client")
**'''http:''' Indica se ele pode ser chamado via HTTP ("true" ou "false")
*'''<html />'''
**'''src:''' O nome do arquivo HTTP (pode ser um diretório)
**'''default:''' Qual arquivo html a ser mostrado por padrão ao acessar o caminho ''/nome-do-recurso/'' no servidor. Somente um html pode ser definido, os outros são ignorados (true/false)
**'''raw:''' O arquivo html não é interpretado pelo Lua e assim só passa como um dado binário. Deve ser usado para arquivos binários, como imagens principalmente (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Muitos gamemodes usam o [[PT-BR/Sistema_de_Configurações|sistema de configurações]] para habilitar administradores do servidor configurá-los como desejarem. Um exemplo seria definir o tempo de duração da partida e usar o [[get]] e [[set]] para manipular o valor responsável por isso.
*'''<min_mta_version />''' Versão mínima do MTA para o recurso rodar sem problemas. Quando estiver terminando um recurso, a versão mínima deve a mesma da versão do MTA:SA que está usando (a qual no momento é {{Current Version|full}}). Veja o exemplo abaixo.
**'''client:''' A versão mínima do cliente
**'''server:''' A versão mínima do servidor
*'''<aclrequest />''' Indica uma lista de permissões do [[Access_Control_List|ACL]] a serem usados pelo recurso.
*'''<sync_map_element_data />''' Indica se os dados de elemento como "PosX" e "DoubleSided" são tranferidos para o cliente. Esses geralmente não são necessários por muitos gamemodes ou recursos, exceto ''Map Editor'' e ''Interiors''; caso contrário, não funcionarão. Quando definido no recurso, se aplicará a todos os mapas carregados por ele.
**'''false:''' Desabilita essa transferência para todos os recursos. Isso pode reduzir a demora de download consideravelmente.
**'''true:''' Habilita essa tranferência. Se esses valores forem definidos de forma distinta entre os recursos, o que estiver configurado como "true" terá prioridade e todos os demais transferirão esse mesmo dado.
*'''<oop/>''' OOP - Veja mais informações na página: [[OOP]]
**'''false:''' Desabilita o OOP.
**'''true:''' Habilita-o
*'''<download_priority_group/>''' O valor padrão do grupo de prioridade de download do recurso é 0. Se este for definido para um valor maior que 0, então o recurso será baixado e iniciado no cliente antes dos outros recursos. Se defindo para um valor menor que 0, o recurso será baixado e iniciado no cliente depois dos outros recursos.

== Exemplo ==
Aqui está um exemplo de um arquivo meta usando algumas das tags mencionadas:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<download_priority_group>0</download_priority_group>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<sync_map_element_data>false</sync_map_element_data>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client" validate="true"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>
<map src="base.map" dimension="1"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" download="true"/>
<file src="camera.png" download="false"/>
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<export function="exampleExport1" type="server" />
<export function="exampleExport2" type="client" />
<export function="exampleExport3" type="shared" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
<setting name="isAllowedToShoot" value="true" />
</settings>

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>
</meta>
|lang="xml"}}
[[Category:Conceitos de Scripting]]
[[en:Meta.xml]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

Math.round

2015-09-11T19:31:14Z

Banex: /* Example */ fix code

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function is a full featured round function for Lua's math-library.
Bear in mind that both the floor and the ceil method may not work properly clientside when you pass something greater than 0 as second argument. This is because of some weird clientside number bug. It's fixed for the round method.

==Syntax==
<syntaxhighlight lang="lua">int/float math.round( float number, [ int decimals = 0, string method = "round" ] )</syntaxhighlight>

===Required Arguments===
* '''number''': The number to round.

===Optional Arguments===
{{OptionalArg}}
* '''decimals''': The number of decimals to keep.
* '''method''': The round method that should be used. Valid values are "round" (which is default), "floor" and "ceil".

===Returns===
Returns the rounded number.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua" lang="lua">
function math.round(number, decimals, method)
decimals = decimals or 0
local factor = 10 ^ decimals
if (method == "ceil" or method == "floor") then return math[method](number * factor) / factor
else return tonumber(("%."..decimals.."f"):format(number)) end
end
</syntaxhighlight>
</section>

==Example==
<section name="Serverside Example" class="server" show="true">
This example adds a command that outputs the players current position approximated to three decimals.
<syntaxhighlight lang="lua" lang="lua">
function pos(thePlayer, command)
local x, y, z = getElementPosition(getPedOccupiedVehicle(thePlayer) or thePlayer)
outputChatBox("Your current position: ["..math.round(x, 3).."|"..math.round(y, 3).."|"..math.round(z, 3).."]", thePlayer)
end
addCommandHandler("pos",pos)
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}

SetPedWalkingStyle

2015-04-02T23:53:08Z

Banex: /* Example */

__NOTOC__
{{Server client function}}
Sets the walking style of a ped. A walking style consists of a set of animations that are used for walking, running etc.

==Syntax==
<syntaxhighlight lang="lua">bool setPedWalkingStyle ( ped thePed, int style )</syntaxhighlight>
{{OOP||[[Ped|ped]]:setWalkingStyle|walkingStyle|getPedWalkingStyle}}
===Required Arguments===
*'''thePed:''' the ped whose walking style to change.
*'''style:''' the walking style to set.

The possible walking styles are:

{{Ped walking styles}}

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

==Example==
<section name="Client example" class="client" show="true">
Changes the walking style of the player when the resource is started
<syntaxhighlight lang="lua">
function onClientResourceStart()
setPedWalkingStyle(localPlayer,126)
end
addEventHandler("onClientResourceStart",resourceRoot, onClientResourceStart)
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

SetPedWalkingStyle

2015-02-16T16:09:03Z

Banex: /* Returns */

__NOTOC__
{{Server client function}}
Sets the walking style of a ped. A walking style consists of a set of animations that are used for walking, running etc.

==Syntax==
<syntaxhighlight lang="lua">bool setPedWalkingStyle ( ped thePed, int style )</syntaxhighlight>
{{OOP||[[Ped|ped]]:setWalkingStyle|walkingStyle|getPedWalkingStyle}}
===Required Arguments===
*'''thePed:''' the ped whose walking style to change.
*'''style:''' the walking style to set.

The possible walking styles are:

{{Ped walking styles}}

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

==Example==
<section name="Client example" class="client" show="true">
Changes the walking style of the player when the resource is started
<syntaxhighlight lang="lua">
function onStart()
setPedWalkingStyle(localPlayer,126)
end
addEventHandler("onClientResourceStart",getResourceRootElement(getThisResource()), onStart)
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

SetPlayerHudComponentVisible

2015-01-25T14:42:18Z

Banex: /* Example */

__NOTOC__
{{Server client function}}
{{Note|This function is identical to showPlayerHudComponent}}
This function will show or hide a part of the player's HUD.

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( player thePlayer, string component, bool show )
</syntaxhighlight>
{{OOP|[[player]]:setHudComponentVisible||}}
===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:
:*'''all:''' All of the following at the same time
:*'''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
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''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
}}
*'''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.

==Requirements==
{{Requirements|1.3.2|1.3.2}}

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide some of the hud components when a player joins the server
addEventHandler ( "onPlayerJoin", root,
function ()
setPlayerHudComponentVisible ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
setPlayerHudComponentVisible ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide the hud when the resource is started
local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" }

addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
for _, component in ipairs( components ) do
setPlayerHudComponentVisible( component, false )
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

SetPlayerHudComponentVisible

2015-01-25T14:41:12Z

Banex: /* Example */

__NOTOC__
{{Server client function}}
{{Note|This function is identical to showPlayerHudComponent}}
This function will show or hide a part of the player's HUD.

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( player thePlayer, string component, bool show )
</syntaxhighlight>
{{OOP|[[player]]:setHudComponentVisible||}}
===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:
:*'''all:''' All of the following at the same time
:*'''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
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''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
}}
*'''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.

==Requirements==
{{Requirements|1.3.2|1.3.2}}

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide some of the hud components when a player joins the server
addEventHandler ( "onPlayerJoin", root,
function ()
setPlayerHudComponentVisible ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
setPlayerHudComponentVisible ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide the hud when the resource is started
local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" }

addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
for _, component in ipairs( components ) do
showPlayerHudComponent( component, false )
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

FileCreate

2015-01-11T21:25:49Z

Banex: /* Example */

__NOTOC__
{{Server client function}}

Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
{{Note|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.)}}
{{Tip|If you do not want to share the content of the created file with other servers, prepend the file path with @ (See [[filepath]] for more information)}}
==Syntax==
<syntaxhighlight lang="lua">
file fileCreate ( string filePath )
</syntaxhighlight>
{{OOP|This function is a static function underneath the File class.|[[File]].new}}

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to be created in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.

===Returns===
If successful, returns a file handle which can be used with other file functions ([[fileWrite]], [[fileClose]]...). Returns ''false'' if an error occured.

==Example==
This example creates a text file in the current resource and writes a string to it.
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight>

Notice that you can't simply do ''fileWrite("test.txt", "File content")''. Instead, file functions operate on a '''file handle''', which is a special object representing an open file. ''fileCreate'' creates a file, opens it, and returns the resulting handle.

It is also important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
If the file already exists, a new file will be created on local.

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

O arquivo Meta

2014-12-07T14:56:13Z

Banex: /* Tags */

O ''meta.xml'' é um arquivo de metadados que define ao MTA os conceitos iniciais de um recurso. Exemplos seriam seu nome, os scripts a serem usados e quais devem ser pré-carregados para serem transferidos ao cliente; junto a outros de sua natureza. Ele também transforma arquivos em elementos, a exemplo de sons, imagens e modelos. É escrito em XML, o qual é baseado em HTML e é pai do XHTML.

''obs'': Metadados são dados sobre outros dados. O termo é estranho, mas o próprio nome já diz. No caso do MTA eles seriam metadados descritivos, pois se referem ao conteúdo do jogo.

=Tags=
O XML é um formato de texto muito usado para representar dados, inclusive pelo MTA. As tags a seguir são todas as possibilidades:

*'''<info />''' Representa informações sobre o recurso que podem ser usados de forma opcional, e lidos pela função [[getResourceInfo]], caso necessário:
** '''author:''' O autor do recurso
** '''version:''' A versão do recurso
** '''name:'''' O nome do recurso
** '''description:''' Uma breve descrição do recurso
** '''type:''' Qual é o tipo do recurso, pode ser um "gamemode", "script", "map", ou "misc".
* '''<script />''' O código fonte do recurso, os possíveis parâmetros são:
** '''src:''' O nome do arquivo do código fonte
** '''type:''' O tipo de código-fonte: "client", "server" ou "shared".
** '''cache:''' Quando o script é do tipo client, esse atributo diz se o arquivo será salvo ou não no disco rígido dele. O padrão é "true", se for usado o contrário, será apagado quando o recurso parar.
** '''validate:''' Se for definido como falso, o MTA não verificará se é compatível
* '''<map />''' Define mapa do gamemode, os possíveis atributos são:
** '''src:''' o nome do arquivo .map (pode também ser o diretório, ex: ''maps/nome-do-mapa.map)
** '''dimension:''' Dimensão em que o mapa será carregado (opcional)
* '''<File />''' Um arquivo do lado do cliente. Geralmente são imagens, .txd, .col, .dff ou arquivos .xml. Eles vão ser baixado pelos clientes quando o recurso é iniciado (ou quando ele entrar no servidor)
** '''src:''' nome do arquivo do lado do cliente (pode ser outro caminho por exemplo, "images/imagem.png".)
** '''download:''' Vai ou não ser enviado para o cliente automaticamente(opcional). O padrão é "true". Usando "false" significa que eles não são enviados no início de recursos, mas poderia ser usado posteriormente por DownloadFile (a partir da versão 1.4)
*'''<include />''' Inclui os recursos necessários a estarem rodando
**'''resource:''' Nome do recurso que você quer iniciar junto com esse
**'''minversion:''' A versão mínima desse recurso (opcional)
**'''maxversion:''' A versão máxima desse recurso (opcional)
*'''<config />''' O arquivo de configuração em XML a ser usado pelo recurso:
**'''src:''' Seu nome
**'''type:''' Seu tipo: "client" ou "server"
*'''<export />''' Exporta uma função do seu recurso, para que outros possam usa-la com o [[call]]
**'''function:''' O nome da função
**'''type:''' Diz se será exportado para o lado do cliente ou servidor (valores válidos são: "server" ou "client")
**'''http:''' Indica se ele pode ser chamado via HTTP ("true" ou "false")
*'''<html />'''
**'''src:''' O nome do arquivo HTTP (pode ser um diretório)
**'''default:''' Qual arquivo html a ser mostrado por padrão ao acessar o caminho ''/nome-do-recurso/'' no servidor. Somente um html pode ser definido, os outros são ignorados (true/false)
**'''raw:''' O arquivo html não é interpretado pelo Lua e assim só passa como um dado binário. Deve ser usado para arquivos binários, como imagens principalmente (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Muitos gamemodes usam o [[PT-BR/Sistema_de_Configurações|sistema de configurações]] para habilitar administradores do servidor configurá-los como desejarem. Um exemplo seria definir o tempo de duração da partida e usar o [[get]] e [[set]] para manipular o valor responsável por isso.
*'''<min_mta_version />''' Versão mínima do MTA para o recurso rodar sem problemas. Quando estiver terminando um recurso, a versão mínima deve a mesma da versão do MTA:SA que está usando (a qual no momento é {{Current Version|full}}). Veja o exemplo abaixo.
**'''client:''' A versão mínima do cliente
**'''server:''' A versão mínima do servidor
*'''<aclrequest />''' Indica uma lista de permissões do [[Access_Control_List|ACL]] a serem usados pelo recurso.
*'''<sync_map_element_data />''' Indica se os dados de elemento como "PosX" e "DoubleSided" são tranferidos para o cliente. Esses geralmente não são necessários por muitos gamemodes ou recursos, exceto ''Map Editor'' e ''Interiors''; caso contrário, não funcionarão. Quando definido no recurso, se aplicará a todos os mapas carregados por ele.
**'''false:''' Desabilita essa transferência para todos os recursos. Isso pode reduzir a demora de download consideravelmente.
**'''true:''' Habilita essa tranferência. Se esses valores forem definidos de forma distinta entre os recursos, o que estiver configurado como "true" terá prioridade e todos os demais transferirão esse mesmo dado.
*'''<oop/>''' OOP - Veja mais informações na página: [[OOP]]
**'''false:''' Desabilita o OOP.
**'''true:''' Habilita-o

== Exemplo ==
Aqui está um exemplo de um arquivo meta usando algumas das tags mencionadas:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<sync_map_element_data>false</sync_map_element_data>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client" validate="true"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>
<map src="base.map" dimension="1"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" download="true"/>
<file src="camera.png" download="false"/>
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<export function="exampleExport1" type="server" />
<export function="exampleExport2" type="client" />
<export function="exampleExport3" type="shared" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
<setting name="isAllowedToShoot" value="true" />
</settings>

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>
</meta>
|lang="xml"}}
[[Category:Translated/Scripting Concepts]]
[[en:Meta.xml]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

Depuração

2014-12-06T02:22:50Z

Banex: /* Exemplo */

Quando você estiver fazendo seu script, certos problemas surgirão. O problema é que nem todos são tão aparentes assim, então esta página irá descrever algumas estratégias básicas para localiza-los.

==Debug no console==
O MTA vem com um sistema no console onde mensagens de ''debug'' relacionadas às funções e scripts são mostradas. Lembrando que é necessário ter uma permissão de administrador para ativá-lo (a não ser se você modificar o ACL). Para fazer isso, digite ''debugscript *x*'' no console, em que ''x'' é o nível:

* '''1:''' mostra somente os erros
* '''2:''' erros e avisos
* '''3:''' erros, avisos e mensagens informativas
Ao digitar ''debugscript 3'', todas as ocorrências serão mostradas. O nível 3 ou o 2 são os recomendados para a maioria dos casos. É de extrema importância estar com o ''debugscript'' ligado para testar seu script e detectar os erros de digitação. Como também, resolver outros eventuais problemas.

===Exemplo===
Neste código há dois erros:
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Cebola")
outputChatbox("Hello Fedor")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>
Quando este script for carregado, no console irá aparecer algo assim:
:{{Debug info|Loading script failed: meuRecurso\script.lua:2: 'then' expected near ´outputChatbox'}}

Isso significa que o script não pode ser executado porque há um erro de sintaxe. Nesta mensagem, primeiramente aparece qual script de qual recurso deu problema. Depois disso, há dois pontos e um número mostrando a linha onde está o erro; para facilitar o trabalho do programador quando se trata de scripts maiores. Depois disso, a mensagem irá variar de acordo com o tipo de erro. Neste caso, é fácil concluir que o erro está localizado no '''meuRecurso''' e na linha dois do arquivo '''script.lua'''. Desta vez está na cara: precisamos colocar o "then" na cláusula ''if''.
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Fedor") then
outputChatbox("Hello Fedor")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>
Agora tudo será carregado com sucesso e nenhum erro aparecerá até que um jogador apelidado "Cebola" dizer algo no chat. Aí no console irá aparecer:
:{{Debug error|myResource\script.lua:2: attempt to call global 'outputChatbox' (a nil value)}}
Isso significa que a função '''outputChatbox''' é um valor ''nil'', ou seja, ele não existe! Isso porque a função na verdade se chama [[outputChatBox]], e não [[outputChatbox]]. Então, tome cuidado com a letra maiúscula B.:
<syntaxhighlight lang="lua">
function SayHello(message, player)
if (getPlayerName(player) == "Cebola") then
outputChatBox("Bem vindo, Cebola!")
end
end
addEventHandler("onChatMessage", root, SayHello)
</syntaxhighlight>

É óbvio que isso é só um exemplo e não será sempre desse jeito, pois há vários tipos de erros em diversos casos. Mas até aqui, uma boa base já foi ensinada.

==Log de debug do Cliente e Servidor==
====Servidor====
Na pasta ''../server/mods/deathmatch'', haverá dois arquivos com funções parecidas:

*''local.conf'' - são as configurações oriundas do item "host game" no menu principal do MTA. Isto é uma maneira rápida de iniciar um servidor de testes dentro do próprio programa. Quando o usuário fecha o jogo, ele é automaticamente desligado também.

*''mtaserver.conf'' - é usado quando se inicia o "MTA Server.exe" dentro da pasta ''../server/''. Em outras palavras, o servidor é rodado em prompt de comando e não necessita de o MTA estar executando junto. Isso é muito útil para os interessados em montar um servidor dedicado ou mesmo experimentar como é mexer em um servidor de verdade.

Dependendo das suas necessidades, com certeza irá querer alterar essas configurações abaixo:

<syntaxhighlight lang="xml">

<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>


<scriptdebugloglevel>0</scriptdebugloglevel></syntaxhighlight>

Como as descrições acima já dizem, é opcional salvar um arquivo de log de acordo com o nível desejado. Os três níveis estão descritos acima, sendo neste caso o zero como a não ativação do debugscript - fazendo o arquivo ficar em branco. Se 3 for ativado, todos os erros encontrados no '''lado do servidor''' serão salvos em: ''../server/mods/deathmatch/logs/scripts.log''

====Cliente====
Todos os erros '''do cliente''' serão salvos na pasta ''../server/clientscript.log''. Isso já é definido por padrão, então nenhuma configuração é necessária.

==Habilidades em Deubug==

Em vez de ficar procurando no código os erros cometidos, há algumas coisas a serem feitas para ajudar a encontrar-los. A maioria delas estão relacionadas com a adição de alguma mensagem de debug informando o que está ocorrendo no script.

===Funções Úteis===
As funções abaixo podem lhe ajudar com o debug:
* [[outputDebugString]] ou [[outputChatBox]] para escrever qualquer informação na tela (de preferência outputDebugString para suporte técnico)
* [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] para tornar qualquer variável em uma ''string''. Muito útil para saber o que ela é, escrevendo na tela. Não será necessário usa-la se a variável já uma string ou um número.
* [[getElementType]] verifica o tipo de elemento do MTA em questão.
* [[isElement]] verifica se elemento existe.

===Adicionando mensagens de debug para verificar ''se'', ''quando'' ou por qual ''frequência'' um código é executado===
Se você terminou de escrever um código e percebe que algo esperado não acontece e fica em dúvida se as instruções foram executadas ou não; nesse caso é recomendado adicionar mensagens de debug para verificar os passos.<br>
Um exemplo típico seria checar se uma clausula ''if'' foi atendida ou não:
<syntaxhighlight lang="lua">
if (variable1 == variable2) then
outputDebugString("A variável 1 é igual a 2.")
-- portanto, faça alguma coisa
end
</syntaxhighlight>

Outra maneira semelhante seria verificar se alguma variável muda. Em outras palavras, é só adicionar uma mensagem de debug depois de cada vez que isso acontece.

===Adicionando uma mensagem de debug para verificar o ''valor'' de uma variável===
Digamos que desejas criar um marcador (marker), mas ele não aparece na posição esperada. A primeira coisa a ser feita é verificar se a função [[createMarker]] foi executada com sucesso. Depois disso, só precisamos verificar os valores usados nela.
<syntaxhighlight lang="lua">
local marker = createMarker(x,y,z)
if not marker then
outputChatBox("O marcador não pode ser criado.")
end
outputChatBox("A posX é "..x..", posY "..y..", e posZ "..z)
</syntaxhighlight>
Feito isso, as variáveis usadas como coordenadas serão mostradas. Lembrando que se uma variável não for uma frase ou número, é recomendado usar a função [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()], pois ela torna qualquer variável agrupável em uma ''string'', mesmo se for uma ''bool'' ou tabela.

==Exemplo==
Imagine que você criou um [[Colshape|detector de colisão]] e se o jogador ficar dez segundos dentro dele, algo vai acontecer:
<syntaxhighlight lang="lua">
function colShapeHit(player)
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit", root, colShapeHit)

function colShapeLeave(player)
-- destrua o timer quando o jogador sair do colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave", root, colShapeLeave)
</syntaxhighlight>
Quando o jogador entrar no colshape, o debugscript irá escrever a seguinte mensagem:
:{{Debug error|..[path]: attempt to index global 'colshapeTimer' (a nil value)}}
Isso significa que você tentou endereçar uma tabela não existente quando tentou colocar o timer dentro dela; ou seja, ela é um valor ''nil'' - portanto, não existe. Para corrigir isso, precisamos verificar se a tabela não existe, e caso a resposta for positiva; a criaremos.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit", root, colShapeHit)

function colShapeLeave(player)
-- destrua o timer quando o jogador sair do colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",root,colShapeLeave)
</syntaxhighlight>

Desta vez receberemos um aviso quando o jogador entrar no colshape, esperar a mensagem e sair de lá:

:{{Debug warning|[..]: Bad argument @ 'killTimer' Line: ..}}

Tirando isso (vamos corrigir mais tarde!), tudo parece funcionar bem. O jogador entra no colshape e o ''timer'' começa a contar: se ele esperar, a mensagem é escrita, caso contrário o ''timer'' é destruído. Mas...

===Um erro imperceptível===
Por alguma razão, quando o jogador entra no colshape usando um veículo, a mensagem é escrita duas vezes; como se o código tivesse sido executado duas vezes. Então, adicionamos uma mensagem de debug para verificar isso.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- adicionamos uma mensagem de debug
outputDebugString("colShapeHit")
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- adicionamos outra mensagem de debug
outputDebugString("colShapeLeave")
-- destrua o timer quando o jogador sair do colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>
Agora dá pra ter certeza que as funções são executadas duas vezes quando entramos com um veículo, mas só uma quando se está a pé. É possível que o veículo seja um elemento a parte e ativa a função de forma independente ao jogador. Para confirmar essa teoria, verificamos se a variável ''player'' realmente se refere ao jogador.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- adicionamos uma mensagem de debug, seguido do elemento "jogador"
outputDebugString("colShapeHit"..getElementType(player))
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- adicionamos outra mensagem de debug, incluindo o jogador
outputDebugString("colShapeLeave "..getElementType(player))
-- destrua o timer quando o jogador sair do colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

A mensagem de debug nos diz que uma referência da variável ''player'' é realmente o jogador, mas outra é o veículo. Já que nós destinamos o evento especificamente ao boneco dele, adicionaremos uma cláusula ''if'', obrigando o término da execução do código caso a variável '''não''' for o jogador.

<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- adicionamos um verificador
if (getElementType(player) ~= "player") then return end
-- adicionamos uma mensagem de debug, seguido do elemento "jogador"
outputDebugString("colShapeHit"..getElementType(player))
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- adicionamos ele novamente
if (getElementType(player) ~= "player") then return end
-- adicionamos outra mensagem de debug, incluindo o jogador
outputDebugString("colShapeLeave "..getElementType(player))
-- destrua o timer quando o jogador sair do colshape
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>
Agora tudo está funcionando como o planejado, mas aquela mensagem de aviso mencionada acima ainda aparece. Isso porque quando tentamos destruir o timer depois que o jogador saí do colshape, ele não existe mais, já que os 10 segundos se passaram. Em outras palavras, o timer é automaticamente destruído quando ele conta os 10 segundos. Há diversas formas de se livrar do aviso, uma vez que temos conhecimento da não existência do ''timer''. Uma delas seria verificar se ele existe na tabela. Para fazer isto, usamos a função [[isTimer]] na hora de destruí-lo:
<syntaxhighlight lang="lua">
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
end
</syntaxhighlight>

Então o código completo ficará assim:
<syntaxhighlight lang="lua">
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- adicionamos um verificador
if (getElementType(player) ~= "player") then return end
-- adicionamos uma mensagem de debug, seguido do elemento "jogador"
outputDebugString("colShapeHit"..getElementType(player))
-- criamos um timer para escrever uma mensagem (pode também ativar uma função)
-- e inserimos ele em uma tabela, usando o jogador como index
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"O jogador permaneceu dez segundos dentro do colshape!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
-- adicionamos ele novamente
if (getElementType(player) ~= "player") then return end
-- adicionamos outra mensagem de debug, incluindo o jogador
outputDebugString("colShapeLeave "..getElementType(player))
-- destrua o timer quando o jogador sair do colshape
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>

==Verificando problemas na performance==
Se o seu servidor estiver trabalhando muito além da conta ou você deseja se certificar que seus scripts são eficientes, é possível matar o problema pela raiz usando uma boa ferramenta inclusa na instalação: [[Resource:Performancebrowser|performancebrowser]]. É só inicia-lo usando ''''start performancebrowser''''. Caso ele não exista, pode encontrá-lo no último pacote de recursos hospedado no [http://code.google.com/p/mtasa-resources Google Code]. Esta ferramenta inclui uma série de informações relativas a performance, como:
* Memory leaks - uso excessivo de memória
* Element leaks - criação excessiva de elementos
* CPU usage - uso excessivo de CPU

Para acessar o performancebrowser, é preciso ir até o navegador e digitar o endereço: <nowiki>http://<ip-do-servidor>:<porta>/performancebrowser/</nowiki>. Um exemplo seria o endereço do servidor local: http://127.0.0.1:22005/performancebrowser/. Lembrando que é preciso:
* colocar a barra (/) no final do endereço
* logar no jogo com uma conta de administrador ou outra que tenha acesso no ACL a:
:* '''resource.performancebrowser.http''' e '''resource.ajax.http'''

{{Dica|A maioria das informações relevantes estão nas categorias ''Lua timing'' e ''Lua memory''. E, o problema está nos valores mais altos apresentados.}}

===Exemplos de scripts problemáticos===

Um deles seria adicionar dados a alguma tabela, mas não remover posteriormente. Porém, isso levaria alguns meses ou até anos para danificar o funcionamento do servidor.
<syntaxhighlight lang="lua">
local someData = {}

function storeData()
someData[source] = true
-- não há nenhum evento para retirar os dados quando o jogador sair. Isso é considerado memory leak
-- Entrando na aba Lua timing, você pode verificar o uso de RAM de cada recurso.
end
addEventHandler("onPlayerJoin", root, storeData)
</syntaxhighlight>

Um caso possível de ''Element leak'' é criar colisores temporários e nunca destruí-los mais tarde. Isso aumenta muito o uso de transferência dados (bandwidth), CPU e memória pelo servidor.
<syntaxhighlight lang="lua">
function useTemporaryCol()
local col = createColCircle(some code here)
if (algo que deveria acontecer...) then
destroyElement(col)
end
-- E as vezes não acontece, fazendo o colisor permanecer no mapa pra sempre...
-- Criando de centenas à milhares de coliores sem função alguma.
-- Na aba Lua timing é possível ver quantos elementos cada script criou.
end
</syntaxhighlight>

O alto uso de CPU resulta na queda de FPS, fazendo o servidor um lugar ruim para se jogar. Em 24 horas, isso pode causar sérios prejuízos. O número de elementos criados detectados na aba ''Lua timing'' não ajudará neste caso, mas o ''Lua memory'' sim.
<syntaxhighlight lang="lua">
addEventHandler("onPlayerJoin", root, function()
-- [Código para o novo jogador]
-- Até que um evento é adicionado para quando ele sair
addEventHandler("onPlayerQuit", root, function()
-- Encontrou o problema? Esse evento além de usar o root como o seu causador, é criado infinitamente...
end)
end)
</syntaxhighlight>
Uma função usa muito o CPU quando ela demora para terminar de ser executada. O exemplo abaixo é uma delas. Sem o performancebrowser, você não perceberia tão cedo que esta é a causa do problema. Mas com ele, verá na aba ''Lua timing'' que o seu recurso usa muito o potencial do CPU. Ficará mais fácil descobrir isso se usar o parâmetro ''''d'''' na caixa de entrada ''Options''. Isso porque ela lhe dirá também a linha em que está o código problemático.
<syntaxhighlight lang="lua">
function umaFuncaoPoucoEficaz()
-- para cada cem mil coisas quaisquer
for i=1, 100000 do
-- [código abaixo]
end
end
</syntaxhighlight>

[[en:Debugging]]
[[it:Guida al Debug]]
[[ru:Debugging]]
[[Category:Translated/Scripting Concepts]]
[[Category:Tutorials]]

PT-BR/Introdução ao Scripting

2014-12-06T02:10:55Z

Banex: /* E agora, Scooby Doo? */

O que será abordado neste artigo são os conceitos básicos de scripting, ou seja, não iremos fazer nada além do que escrever um arquivo em uma linguagem que o computador entenda. Para deixar mais claro, a linguagem de programação utilizada pelo MTA é a Lua. Antes de começar a entender como esta linguagem funciona, é preciso esclarecer o que é um recurso (resource, em inglês).

Um recurso é um componente essencial de um servidor de MTA. Este pode ser caracterizado por uma pasta ou um arquivo comprimido, no qual há um conjunto de arquivos. Dentre eles, está presente o meta.xml, que por sua vez, informa ao servidor como/quais arquivos devem ser carregados e o que estes representam dentro do jogo. Em outras palavras, podemos comparar o recurso como se fosse um "programa de computador", o qual é iniciado ou interrompido sob demanda, além disso, o servidor tem a funcionalidade de rodar não só um recurso, mas vários ao mesmo tempo.

''Obs:'' Os recursos são comprimidos em .zip e não em .rar

Tudo relacionado a scripting tem relação com os recursos, afinal, os recursos são nada mais que, geralmente, um conjunto de scripts destinados a realizar alguma tarefa. Um recurso pode ser classificado, via o meta.xml, como um gamemode, um mapa ou qualquer outra coisa. O MTA já vem por padrão com alguns recursos interessantes que você pode, além de reaproveitá-los, adaptá-los às suas necessidades. Por exemplo, você pode editar as texturas do gamemode race para deixar-lo com a cara do seu servidor ou mudar o comportamento do modo de jogo perante a mudança de mapa.
{{dica|Para facilitar seus primeiros passos na programação em linguagem Lua, é recomendado utilizar um editor de textos com highlight, ou seja, o programa vai destacar cada tipo de instrução com uma cor distinta. Isso facilita a leitura e escrita de qualquer código independente da linguagem. Muito utilizado e recomendado por nós é o [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] ou [http://luaedit.sourceforge.net/ LuaEdit]. <br> Há também um editor de códigos (criado por fãs do MTA) com foco na linguagem Lua para o MTA: [[MTASE|MTA Script Editor]] (ainda em fase de desenvolvimento, mas você já pode testá-lo). }}

==Criando nosso primeiro script==
Neste capítulo, vamos aprender a criar um script para permitir o jogador explorar o mundo do San Andreas.
===Onde estão todos os scripts?===
Vamos dar uma olhada na estrutura dos scripts. Vá até a pasta de instalação do seu MTA, que por padrão é C:/Arquivo de Programas/MTA San Andreas 1.x.

# Navegue até a pasta /server/mods/deathmatch/resources/
#* Dentro desta há várias outras pastas no formato [nome_da_pasta]. O motivo disto está na necessidade de organizar os recursos em certas categorias.
#* Como criaremos um modo de jogo totalemente novo, abriremos a pasta [gamemodes]
#* Para que o MTA possa reconhecer nossa pasta como um recurso, criemos outra dentro de [gamemodes] com um nome de sua preferência e sem os colchetes. Nós iremos usar "myserver" neste artigo.
# No final, o seu resultado deve ser o seguinte:

/server/mods/deathmatch/resources/[gamemodes]/myserver

===Identificando seu recurso===
Para que o servidor reconheça os arquivos de um determinado recurso (para carregá-los), um arquivo ''meta.xml'' deve ser criado, contendo uma lista de todo o conteúdo do recurso. O arquivo ''meta.xml'' deve ser salvo na pasta principal (nesse caso, na pasta "myserver"). Então, abra um editor de textos (recomenda-se o Notepad++) e salve-o com o nome de "meta.xml".

Entre com as seguintes linhas no arquivo ''meta.xml'':
<syntaxhighlight lang="xml">
<meta>
<info author="Seu_Apelido" type="gamemode" name="Meu_jogo" description="Meu primeiro recurso" />
<script src="script.lua" />
</meta>
</syntaxhighlight>

Na tag ''<info />'', existem:
* ''type'' - indica que o recurso criado é um ''gamemode''. Pode também ser um ''map'' (mapa), que iremos explicar depois
* ''name'' - o próprio nome já diz: o nome do recurso
* ''description'' - uma breve descrição a fim de outros jogadores e/ou donos de servidores possam saber do que se trata seu recurso

A tag ''<script />'' indica o caminho dos arquivos (escritos em Lua) presentes no seu recurso. Criaremos no próximo passo o exemplo (script.lua).

{{Dica|Um gamemode é o que você precisa para criar um servidor independente, pois é um recurso que envolve toda a programação principal do jogo online.}}

===Criando um script simples===
Observe que na tag ''<script />'' anterior, o arquivo .lua está presente na pasta principal do recurso, e não em uma subpasta. Então precisamos salvar o script na pasta principal, assim como indicado na tag.

* Salve o seguinte código no arquivo 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("Bem-vindo ao meu servidor!", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>

Este script criado faz parte da esfera do servidor. Ou seja, ele é executado somente no servidor. Caso ele seja definido no cliente, cada um dos jogadores receberá o arquivo contendo o código. Mas neste exemplo, por enquanto, não necessitamos usar funções específicas do cliente. Vamos ao que interessa:

O script irá gerar o seu personagem (seu boneco) nas coordenadas (x, y, z) especificadas assim que você entrar no jogo. Note que a função ''fadeCamera()'' precisa ser usada ou, do contrário, a tela ficará preta (e você não verá nada). Outra função é a ''setCameraTarget()'', que foca a câmera do jogo no seu personagem (do contrário, a câmera estaria virada para o céu).

A variável '''source''' representa o elemento responsável pela chamada do evento (haverá um tópico adiante sobre isso). Assim, quando um jogador entra no jogo, o evento "onPlayerJoin" é chamado e, em seguida, chama a função. O evento automaticamente define o jogador na variável ''source''.

Se olharmos bem para o [[addEventHandler]], veremos 3 argumentos:
* ''onPlayerJoin'' - define o evento que chamará a função. No caso, esse evento é chamado assim que o jogador entra no jogo, logo, a função é executada assim que o jogador entra no jogo
* ''getRootElement()'' - indica quem poderá chamar o evento. Neste caso, usamos a função getRootElement() para nos retornar um elemento padrão do MTA denominado '''RootElement'''. Ele, por sua vez, representa todos os outros elementos existentes no servidor; ou seja, todos os jogadores estão representados nele. Consequentemente, todo jogador que entrar no servidor, causará o evento e a função será executada.
* ''joinHandler'' - indica o nome da função a ser executada quando o evento ocorrer.

Vamos agora rodar nosso servidor e testar o script.

{{Dica|A variável ''source'' armazena sempre o elemento que chamou determinado evento. Ou seja, nem sempre ''source'' será o jogador.}}

===Executando o script===
Para iniciar o servidor, execute o arquivo "MTA Server.exe" situado na pasta ''../server/''. Primeiramente, é mostrada uma lista com os principais status do seu servidor; observe o número da porta, da qual você irá precisar quando entrar no jogo. Logo após, o servidor carrega todos os recursos presentes no diretório ''../server/mods/deathmatch/resources/'', caso estejam corretos. E finalmente "fica pronto para aceitar conexões" (ready to accept connections!).

Antes de se conectar ao seu servidor, você precisa executar o gamemode criado. Para isso, digite no console (a janela do MTA Server.exe) o comando ''gamemode myserver'' e pressione Enter. O servidor irá carregar o gamemode e mostrar os erros do seu script, caso existam.

''obs'': "myserver" é o nome da pasta criada no início deste tutorial e, consequentemente, a identificação do seu recurso)

Agora você pode se conectar ao seu servidor de duas maneiras:
* Clique em ''Quick Connect'' > Insira o endereço IP do servidor e o número da porta no seguinte formato - IP:Porta
* Navegue até ''Server Browser'' > Aba ''Local'' > Clique duas vezes no seu servidor.

Se tudo correr bem, seu personagem será criado nas coordenadas especificadas.

No próximo tópico iremos criar um comando para que o jogador possa gerar um veículo ao seu lado. Se preferir, embora não recomendado caso seja iniciante, você pode visitar alguns scripts mais avançados clicando [[Map manager|aqui]]. Outra parte interessante da seção "Scripting", na qual obviamente você está, é [[PT-BR/Introducão_ao_GUI_scripting|Conhecendo a Interface Gráfica]]. Nela, se discute a criação de interfaces gráficas para seus scripts.

==Criando um comando simples==
Como foi mencionado anteriormente, criaremos agora um comando que irá gerar um carro ao lado do seu personagem. Antes de tudo, precisamos adicionar uma função e um evento específico, chamado de [[addCommandHandler]]() ao nosso script.lua.

''obs'': Um comando é como se fosse uma função chamada pelo jogador quando ele está no chat. Ele digita seu nome e envia-o argumentos especificando o que ele quer. Sempre no formato: /[nome do comando] <argumentos> Exemplo: /cv 410

<syntaxhighlight lang="lua">
-- adiciona a função a ser executada pelo comando.
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- aqui colocaremos, mais tarde, o código para gerar o veículo
end

-- adiciona um gerenciador de comandos
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>

{{Dica|As funções nativas do MTA são clicáveis em todo o Wiki e lhe redirecionam à páginas sobre elas.}}

====Sobre os gerenciadores de comandos====
Esse é um ponto interessante a ser discutido, já que envolve eventos e seus derivados. No MTA, para se criar um comando, usamos um tipo específico de evento que ocorre quando um jogador entra com um comando. Usamos a função [[addCommandHandler]] para cria-los. Como um comando é necessariamente um evento, vale a teoria de eventos para ele:
* Um evento é criado por uma função para determinar suas propriedades
* Todo evento ativa quando algo acontece no jogo e este sempre envia à função determinadas informações sobre o que ocoreu
* A relação evento-função é nada mais que uma troca de argumentos, de propriedades

Deve-se prestar atenção nesta troca, pois envolve conceitos fundamentais de Lua. Se você já teve alguma experiência com programação, deve se lembrar como funciona os argumentos de uma função:

<syntaxhighlight lang="lua">
nomeDaFuncao(argumento1, argumento2, argumento3, ..)
</syntaxhighlight>
<syntaxhighlight lang="lua">
addCommandHandler("createvehicle", createVehicleForPlayer, ..)
createVehicleForPlayer(thePlayer, commandName, vehicleModel, ..)
</syntaxhighlight>

Como você observa no exemplo acima, nas duas funções se define quem são os argumentos para indicar como o código deve-se comportar:
* [[addCommandHandler]] é uma na qual se define que quando o jogador digitar o comando ''createvehicle'', a função ''createVehicleForPlayer'' irá ser executada.
* Em createVehicleForPlayer há o recebimento de certas informações enviadas pelo evento, na sequência:
# ''thePlayer'' - Qual é o jogador que ativou o evento?
# ''commandName'' - Qual foi o comando digitado?
# ''vehicleModel'' - Qual foi o ID digitado pelo jogador?

Nota-se nesse caso uma clara troca de informações entre o evento e a função determinada. Quem define como será essa troca é o próprio tipo de evento, que neste caso é um comando. Como ele está sendo executado no servidor, ele sempre enviará na ordem: Quem Digitou? Qual Comando? Quais Argumentos digitados por este jogador? E aí será sua função quem decidirá o que fazer com essas informações; você, programador, dá o nome a esses argumentos e pode até não querer recebê-los, caso elas não forem necessárias.

Vamos a um exemplo prático: alguém digita ''/createvehicle 468'' no chat para gerar uma Sanchez (ID dela é 468. Veja outros [[Vehicle_IDs|neste link]]), então o gerenciador de comandos chama a função determinada de uma forma como se o jogador tivesse feito o script dele e digitado no arquivo:

<syntaxhighlight lang="lua">
createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer seria o próprio jogador
</syntaxhighlight>

É claro que ele não vai querer seguir este tutorial para fazer isso, e desta forma você está aqui para fazer um comando pra ele. Simplesmente ele digita no chat e seu script cria o veículo desejado.

''obs'': Os dois primeiros argumentos colocados na função addCommandHandler ''sempre'' serão do mesmo tipo: quem foi? o que digitou? Em diante, você pode definir quantas variáveis quiser, de acordo com sua necessidade. Se o comando precisar criar um cavalo (pouco provável) e precisar que o jogador diga qual é a cor dele, a raça, a altura, o humor, poderá definir quantas quiser. Algo nesse estilo: addCommandHandler("criarcavalo" criarCavaloParaJodador(), cor, raça, altura, humor)

{{Dica|A função sempre deverá existir antes de você criar o comando (vale para eventos também). O computador é uma coisa linear, portanto se você pedir pra ele definir algo que não existe ainda, vai dar erro! Então sempre coloque a função em cima (lógico, é lido de cima pra baixo) do addEventHandler()}}

====Elaborando a função====
É hora de escrever nossa função; Sempre que for fazer isso é necessário pensar como faremos um veículo ser criado de forma mais simples o possível:
* Obter a posição do jogador, para sabermos onde desovar o veículo
* Calcular essa posição favorável para que a máquina de, em média, 450 quilos não cair em cima do coitado
* Pedir ao jogo gerar este veículo
* Verificar se foi gerado com sucesso, ou informá-lo um erro

Para fazer isso, teremos que usar várias funções. Portanto, nós nos direcionamos à página contendo uma [[Scripting Functions|Lista de funções de servidor]] para achá-las. Já que precisamos obter a posição do jogador e como jogador é um Elemento, clicamos primeiro em '''Element functions''' onde haverá a função [[getElementPosition]] para tal fim. Ao clicar no link, uma página contendo detalhes sobre essa função será mostrada. Nela contém a sintaxe a ser usada, acompanhada de um exemplo. Como a sintaxe do português, a de programação indica como/quais argumentos se pode usar ou omitir.

Para [[getElementPosition]], a sintaxe é:
<syntaxhighlight lang="lua">
float, float, float getElementPosition ( element theElement )
</syntaxhighlight>

Os três itens na frente do nome da função indica o tipo de informação que ela retorna. Neste caso, são ''float'' (números com decimais). Em outras palavras, é retornado ao programador três números decimais indicando a posição (x, y, z). Depois do nome, sempre em parênteses, é o que você precisa mandar pra função funcionar. Neste caso, só é preciso de um elemento do qual a posição será retornada e no nosso exemplo, este elemento é o jogador:

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- retorna a posição do jogador nas variáveis (x, y, z)
-- o termo "local" significa que as três variáveis só existirão dentro do bloco - este é a função
local x,y,z = getElementPosition(thePlayer)
end
</syntaxhighlight>

Neste passo precisamos garantir que o veículo não esmagará o jogador, então adicionamos algumas unidades no eixo x; fazendo este gerar a leste dele

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- retorna a posição do jogador
x = x + 5 adiciona 5 unidades na variável x
end
</syntaxhighlight>

Agora precisamos de outra função para gerar o veículo. Novamente, procuramos na [[Scripting Functions|Lista de funções de servidor]]. Só que como estamos falando de veículos, procuramos na seção '''Vehicle functions'''; onde encontraremos [[createVehicle]]. Na sintaxe desta função, temos somente um tipo de retorno (o qual é mais comum): um elemento do tipo veículo criado pela própria função. Além do mais, percebemos alguns argumentos inseridos em colchetes ([]), indicando opcionalidade.

Oras, já temos todos os argumentos necessários para a função funcionar: os (x, y, z) calculados anteriormente e o ID do veículo fornecido pelo jogador através do comando; na variável (vehicleModel). É só digitar:

<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>

É claro que esse código pode melhorar em vários aspectos, mas pelo menos adicionaremos uma condição para verificar o sucesso na criação do veículo. Como foi lido (e infelizmente para uns, era pra ter sido) na página do [[createVehicle]]; em baixo de '''Returns''', a função retorna ''false'' quando não é possível criar o veículo. Portanto, verificaremos o valor retornado pela variável ''createdVehicle''

Agora temos o script completo:
<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- retorna a posição do jogador
x = x + 5 adiciona 5 unidades na variável x
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
-- verifica se o retorno foi falso
if (createdVehicle == false) then
-- Se sim, retorne uma mensagem de erro somente para o jogador
outputChatBox("Não foi possível criar o veículo. A sintaxe é: /createvehicle [id]",thePlayer)
end
end
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>

Deve-se destacar os seguintes pontos:
* Quando tentamos usar qualquer função que crie algum elemento no MTA e esta criação falha, uma ''bool'' é retornada como falso. Isso quer dizer: ou há um erro de sintaxe/programação no seu script, ou realmente o servidor não conseguiu computar essa informação
* Foi introduzida outra função denominada [[outputChatBox]], a qual simplesmente escreve no chat a mensagem de erro

A partir de agora, você pode dar uma olhada na documentação sobre as funções aqui no Wiki. Se desejar, há a página do [[Map manager|Map Manager]] só falando de scripting avançado.

==Importante Saber==
Já foi dito anteriormente algumas coisas sobre os recursos, gerenciadores de comandos e funções, porém há muita coisa ainda pra aprender. Essa seção lhe fornecerá outras coisas importantes sobre o funcionamento do MTA, ao mesmo tempo linkando à páginas relacionadas se possível.

===Lado do Cliente e Servidor===
É notório a semelhança dos termos (Cliente/Servidor) em várias partes do site, até mesmo nas funções. O MTA não suporta scripts somente rodando no servidor e oferecendo aos seus jogadores comandos como aquele do exemplo acima ou algo parecido. Ele também oferece a possibilidade de rodar um script no computador de cada jogador logado. Isso porque algumas vantagens oferecidas pelo programa precisam rodar no computador deles. Imagine um servidor mandar o todo tempo informações para desenhar a interface gráfica, sendo esta necessitar uma renderização em uma faixa de 30 vezes por segundo. Não faz o menor sentido, e nem é viável! Ainda mais em PC's antigos com ping alto. Há outras razões além da performance, como o fato de alguns funcionarem melhor em um dos lados ou justamente porque não rola.

A maioria dos scripts (gamemodes ou mapas) provavelmente serão no lado do servidor, como foi feito anteriormente. Se caso acontecer de algo não poder ser resolvido com script do servidor, vá tranquilo pro cliente. Um exemplo de fazer isso seria criar um arquivo pacato chamado client.lua e defini-lo no meta.xml, como a seguir:
<syntaxhighlight lang="xml">
<script src="client.lua" type="client" />
</syntaxhighlight>
O atributo ''type'' define automaticamente o arquivo como servidor, então só precisa especificar se for rodado no cliente. Quando terminar, este arquivo será baixado para o computador do brother quando ele conectar ao servidor. Para mais informações, segue o [[Client side scripts|link]] (Em inglês).

===Recursos Complicados===
A última seção explicou brevemente como adicionar um script no cliente, mas há muita coisa possível a ser feita. Como foi dito nesta página, recursos praticamente são a alma do jogo. Sua função é definida pelo que eles podem fazer. Então vão aí uns exemplos de recursos hipotéticos retirados da instalação, mostrando suas distintas funções:

====Primeiro exemplo - Um utilitário====
<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>

* O ''commands.lua'' oferece alguns comandos de administrador, como banir algum pateta ou algo útil para se administrar o servidor
* O ''client.lua'' cria janelas para executar-los de forma muito mais clara e rápida

Este exemplo pode estar rodando o tempo todo (talvez até auto-carregado quando o servidor iniciar) se útil durante a jogatina, e claro, não interferir no processo; só se o administrador decidir intervir.

====Segundo exemplo - Um 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>

* O ''counterstrike.lua'' oferece:
** A possibilidade dos jogadores escolherem o time e nascerem
** Lhe dá armas, alvos e instruções (talvez tiradas do Mapa, veja adiante)
** Define as regras do jogo; exemplos: o que acontece no fim da partida ou quando um jogador falece?
** E muita coisa que não dá ser citada aqui...
* O ''buymenu.lua'' é um script do cliente e adiciona um menu para adquirir armas

Esse exemplo pode ser denominado um ''gamemode'', pois não só complementa a partida, como também define as regras dela. O atributo ''type'' indica que este recurso funciona com o [[Map manager]] ou outro escrito pelos desenvolvedores com finalidade de gerenciar os gamemodes e carregamento de mapas. É bem recomendado começar seu gamemode a partir do diferencial que este apresenta.

E mais, um gamemode provavelmente não rodará sem um mapa. Gamemodes sempre precisarão ser o mais genérico possível. Um exemplo de mapa pode ser visto no próximo exemplo.

====Terceiro exemplo - Um mapa====
<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>

* O ''airport.map'' no arquivo XML acima oferece diversas informações sobre o mapa do gamemode, podendo incluir:
** Onde os jogadores deverão nascer, com quais armas, em qual time
** Quais são os alvos
** Clima, horário e limite de tempo da partida.
** Veículos espalhados pelo local
* O ''airport.lua'' também pode conter objetos específicos, como:
** Abrir alguma porta/fazer algo explodir quando uma coisa acontece
** Criar ou mover objetos customizados, ou manipular objetos criados no arquivo .map
** .. ou infinitas coisas limitadas pela sua imaginação

Nota-se a presença do atributo ''type'' classificando o recurso como um mapa, consequentemente avisando o [[Map manager]] disso; Enquanto o atributo ''gamemodes'' indica com qual o gamemode ele é compatível. Neste caso é o próprio gamemode do exemplo acima.
O que pode incomodar é a presença de um script em um mapa. É claro, não há a necessidade de haver isso nele. Entretanto, isso abre uma gama de possibilidades para criadores de mapas concretizarem seus próprios mundos nas regras do gamemode pra ele criado.

O arquivo ''airport.map'' contém algo parecido com isso:
<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>

Quando um gamemode é iniciado com um mapa, este é automaticamente iniciado pelo Map manager e a informação contida é lida pelo gamemode. Quando um mapa muda durante a partida, o atual é fechado e o escolhido, iniciado. Para mais detalhes e exemplos sobre como os mapas são utilizados na programação principal, visite a página [[Writing Gamemodes|Escrevendo Gamemodes]] (Em inglês).

===Eventos===
Foi dada uma breve explicação no inicio da página, mas um conceito mais formal (criado pelo pessoal do MTA) nunca é demais:
* Eventos são a forma como o MTA diz aos scripts sobre as coisas que acontecem. Por exemplo, quando um jogador morre, o evento [[onPlayerWasted]] é ativado. Com o objetivo de providenciar ações caso isso aconteça, deve ser adicionado um evento, como mostrado no [[#Criando_nosso_primeiro_script|primeiro capítulo]].

Este exemplo irá escrever uma mensagem no chat com o apelido do jogador falecido:
<syntaxhighlight lang="lua">
function playerDied(totalAmmo, killer, killerWeapon, bodypart)
outputChatBox(getPlayerName(source).." feleceu!")
end
addEventHandler("onPlayerWasted",getRootElement(),playerDied)
</syntaxhighlight>

Em vez de mostrar aqui todos os tipos de eventos, uma página específica foi criada no Wiki só para especificar este tipo de coisa; o mesmo serve para os [[#About_command_handlers|gerenciadores de comandos]]. Um outro ponto importante é com relação a variável ''source''. Ela é automaticamente declarada na hora de a função ser executada. Ela agrega um diferente valor para cada tipo de evento, como no exemplo acima: para eventos relacionados a jogadores, ele retorna um elemento do tipo jogador. Uma outra forma de como a variável source é usada está no script básico de fazer o jogador nascer no topo da página.

==Para onde ir a partir daqui==
Agora você deve estar bem mais familiarizado com os aspectos básicos de scripting para o MTA e também com o Wiki. A [[PT-BR/Página_Inicial|Página Inicial]] contém todos os links para mais informações, tutoriais e referências para lhe propiciar todas as fontes necessárias a um estudo mais aprofundado.

{{Dica|Recomendamos ler o tutorial de [[debugging]] a partir daqui. Um bom treinamento em tirar os bugs de seus scripts é fundamental. Também é recomendado dar uma olhada nas variáveis pré-definidas para ajudá-lo com certas tarefas, e claro "scriptar" de forma mais rápida e prática.}}

'''Veja mais:'''
* [[Advanced Topics|Tópicos Avançados]] (Em inglês)

[[en:Scripting Introduction]]
[[ru:Scripting Introduction]]
[[it:Introduzione allo scripting]]
[[es:Introducción a la Programación]]
[[nl:Scripting_introductie]]

PT-BR/Novidades na versão 1.4.0

2014-12-06T02:06:40Z

Banex: /* Principais Mudanças */

{{PT-BR/Changelogs}}

== Principais Mudanças ==
* Tradução para os menus do MTA
* Classes [[OOP]]
* [[Matrix|Matrizes]] e [[Vector|Vetores]]
* Melhorou significativamente a sincronização de trens
* As funções relacionadas a áudio agora são compatíveis com os elementos do tipo jogador

== Scripting ==

=== Novas Funções ===

====Cliente====
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]
* [[getLocalization]]
* [[isChatVisible]]
* [[downloadFile]]
* [[isTrainChainEngine]]

==== Servidor ====
* [[isBan]]
* [[setBanAdmin]]
* [[setBanReason]]
* [[setUnbanTime]]
* [[getAccountsBySerial]]
* [[getAccountSerial]]

==== Compartilhados (Cliente e Servidor) ====
* Adicionado um parâmetro bInstant para setPlayerMoney a fim de definir o montante de dinheiro instantaneamente, sem aparecer a contagem/descontagem no HUD
* toJSON/fromJSON agora lida melhor com dados binários

=== Novos Eventos ===

==== Cliente ====
* [[onClientFileDownloadComplete]]

==== Servidor ====
* [[onWeaponFire]]

=== Mudanças, correções de bugs ===
* getResourceConfig() funciona para recursos adicionados posteriormente a inicialização do servidor
* Corrigido o bug do veiculo (ID: 570)
* attachTrailerToVehicle agora suporta trens

== Cliente ==

=== Novidades ===
* Distinção entre Shift, Ctrl e Alt esquerdo/direito
* Adicionados os parâmetros SettingHUDMatchAspectRatio, SettingAspectRatio para [[dxGetStatus]]
* Suporte de arquivos de áudio usando o [https://en.wikipedia.org/wiki/Opus_codec Opus Codec] nas funções [[playSound]] e [[playSound3D]]

=== Correções de bugs e mudanças ===
* Foram corrigidos as ocasiões:
** Corrigido o efeito do dinheiro "contagem regressiva" quando você muda de servidor.
** Os pedestres ficam invencíveis a tiros quando estão no banco de passageiro.
** O evento onClientPlayerDamage não ativar para a lata de spray.
** Satchels não são removidas com [[resetMapInfo]].
** getPedMoveState retornar falso quando o jogador estiver se movendo agachado
** guiScrollPaneGetVerticalScrollPosition retornar valores estranhos
** setPedCameraRotation não funcionar as vezes.
** Pedestres continuarem atirando depois de sua munição ter acabado.
** Títulos de rádio não aparecerem as vezes.
** As músicas da rádio serem puladas quando se estiver passando entre as estações.
** A função para pular uma faixa de áudio (F5) não funcionar.
** Veículos caírem de repente pelo mapa.

== Servidor ==

=== Novidades ===
* [[setElementDimension]] deve agora fazer efeito para elementos subordinados
* Erros de módulo estão mais explicados nas mensagens
* Novos comandos: unloadmodule e reloadmodule
* Adicionadas armas customizadas para o lado do servidor.

=== Correções de bugs e mudanças ===
* Agora há um limite de 128 caracteres para a função [[setAccountData]].
* Jogadores com nomes contendo caracteres especiais são verificados de forma correta ao conectar.
* Corrigidos os membros de times não serem enviados ao cliente se forem definidos pela função [[onResourceStart]].

== Resources ==
* Nada até agora

== Editor ==
* Nada até agora

== Informações Extras ==
''Informações mais detalhadas estão disponíveis em nosso Changelog do [https://bugs.multitheftauto.com/changelog_page.php Bug tracker] e no Google Code:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[en:Changes_in_1.4.0]]
[[pl:Changes_in_1.4]]
[[ru:Changes_in_1.4.0]]

[[Category:Changes_in_1.4]]
[[Category:Incomplete]]

PT-BR/Novidades na versão 1.4.0

2014-12-06T02:05:02Z

Banex: /* Novidades */

{{PT-BR/Changelogs}}

== Principais Mudanças ==
* Tradução para os menus do MTA
* Classes [[OOP]]
* [[Matrix|Matrizes]] e [[Vector|Vetores]]
* Melhorou muito a sincronização de trens
* As funções relacionadas a áudio agora são compatíveis com os elementos do tipo jogador

== Scripting ==

=== Novas Funções ===

====Cliente====
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]
* [[getLocalization]]
* [[isChatVisible]]
* [[downloadFile]]
* [[isTrainChainEngine]]

==== Servidor ====
* [[isBan]]
* [[setBanAdmin]]
* [[setBanReason]]
* [[setUnbanTime]]
* [[getAccountsBySerial]]
* [[getAccountSerial]]

==== Compartilhados (Cliente e Servidor) ====
* Adicionado um parâmetro bInstant para setPlayerMoney a fim de definir o montante de dinheiro instantaneamente, sem aparecer a contagem/descontagem no HUD
* toJSON/fromJSON agora lida melhor com dados binários

=== Novos Eventos ===

==== Cliente ====
* [[onClientFileDownloadComplete]]

==== Servidor ====
* [[onWeaponFire]]

=== Mudanças, correções de bugs ===
* getResourceConfig() funciona para recursos adicionados posteriormente a inicialização do servidor
* Corrigido o bug do veiculo (ID: 570)
* attachTrailerToVehicle agora suporta trens

== Cliente ==

=== Novidades ===
* Distinção entre Shift, Ctrl e Alt esquerdo/direito
* Adicionados os parâmetros SettingHUDMatchAspectRatio, SettingAspectRatio para [[dxGetStatus]]
* Suporte de arquivos de áudio usando o [https://en.wikipedia.org/wiki/Opus_codec Opus Codec] nas funções [[playSound]] e [[playSound3D]]

=== Correções de bugs e mudanças ===
* Foram corrigidos as ocasiões:
** Corrigido o efeito do dinheiro "contagem regressiva" quando você muda de servidor.
** Os pedestres ficam invencíveis a tiros quando estão no banco de passageiro.
** O evento onClientPlayerDamage não ativar para a lata de spray.
** Satchels não são removidas com [[resetMapInfo]].
** getPedMoveState retornar falso quando o jogador estiver se movendo agachado
** guiScrollPaneGetVerticalScrollPosition retornar valores estranhos
** setPedCameraRotation não funcionar as vezes.
** Pedestres continuarem atirando depois de sua munição ter acabado.
** Títulos de rádio não aparecerem as vezes.
** As músicas da rádio serem puladas quando se estiver passando entre as estações.
** A função para pular uma faixa de áudio (F5) não funcionar.
** Veículos caírem de repente pelo mapa.

== Servidor ==

=== Novidades ===
* [[setElementDimension]] deve agora fazer efeito para elementos subordinados
* Erros de módulo estão mais explicados nas mensagens
* Novos comandos: unloadmodule e reloadmodule
* Adicionadas armas customizadas para o lado do servidor.

=== Correções de bugs e mudanças ===
* Agora há um limite de 128 caracteres para a função [[setAccountData]].
* Jogadores com nomes contendo caracteres especiais são verificados de forma correta ao conectar.
* Corrigidos os membros de times não serem enviados ao cliente se forem definidos pela função [[onResourceStart]].

== Resources ==
* Nada até agora

== Editor ==
* Nada até agora

== Informações Extras ==
''Informações mais detalhadas estão disponíveis em nosso Changelog do [https://bugs.multitheftauto.com/changelog_page.php Bug tracker] e no Google Code:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[en:Changes_in_1.4.0]]
[[pl:Changes_in_1.4]]
[[ru:Changes_in_1.4.0]]

[[Category:Changes_in_1.4]]
[[Category:Incomplete]]

OnVehicleWeaponFire

2014-12-06T01:50:10Z

Banex: /* Code */

{{Useful Function}}
__NOTOC__
This code implements an '''event''' that is triggered when a player in a vehicle fires a vehicles weapon. A list of vehicles that have weapons are listed below:

* Hydra - Fighter Jet (ID: 520)
* Hunter - Assault Helicopter (ID: 425)
* Rustler - World War 2 style fighter (ID: 476)
* Predator - Police Boat with side guns (ID: 430)
* Rhino - Heavily armoured tank (ID: 432)
* Firetruck - Firetruck with sprayable hose (ID: 407)
* S.W.A.T. - Police tank with sprayable hose (ID: 601)
* RC Baron - A mini fighter (ID: 464)

==Parameters==
<syntaxhighlight lang="lua">string vehicleFireType, int vehicleModel</syntaxhighlight>

* vehicleFireType: this will be "primary" or "secondary" depending on which player the button pressed.
* vehicleModel: the model number the player is in when they triggered the event.

==Source==
The source of this event is the player who fired the vehicles gun(s).

==Code==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
armedVehicles = {[425]=true, [520]=true, [476]=true, [447]=true, [340]=true, [432]=true, [464]=true, [407]=true}
function vehicleWeaponFire(key, keyState, vehicleFireType)
local vehModel = getElementModel(getPedOccupiedVehicle(localPlayer))
if (armedVehicles[vehModel]) then
triggerEvent("onClientVehicleWeaponFire", localPlayer, vehicleFireType, vehModel)
end
end
bindKey("vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey("vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
</syntaxhighlight>
</section>
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
armedVehicles = {[425]=true, [520]=true, [476]=true, [447]=true, [340]=true, [432]=true, [464]=true, [407]=true}
function vehicleWeaponFire(thePresser, key, keyState, vehicleFireType)
local vehModel = getElementModel(getPedOccupiedVehicle(thePresser))
if (armedVehicles[vehModel]) then
triggerEvent("onVehicleWeaponFire", thePresser, vehicleFireType, vehModel)
end
end

function bindOnJoin()
bindKey(source, "vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey(source, "vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
end
addEventHandler("onPlayerJoin", root, bindOnJoin)

function bindOnStart()
for index, thePlayer in pairs(getElementsByType("player")) do
bindKey(thePlayer, "vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey(thePlayer, "vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
end
end
addEventHandler("onResourceStart", getResourceRootElement(), bindOnStart)
</syntaxhighlight>
</section>

==Example Code==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua">
function eventVehicleFire(typeOfFire, theModel)
outputChatBox(getPlayerName(source).." fired his "..getVehicleNameFromModel(theModel).."'s weapon ("..typeOfFire..")")
end
addEvent("onClientVehicleWeaponFire", false)
addEventHandler("onClientVehicleWeaponFire", getLocalPlayer(), eventVehicleFire)
</syntaxhighlight>
</section>
<section name="Serverside Example" class="server" show="true">
<syntaxhighlight lang="lua">
function eventVehicleFire(typeOfFire, theModel)
outputChatBox(getPlayerName(source).." fired his "..getVehicleNameFromModel(theModel).."'s weapon ("..typeOfFire..")", root, 0, 255, 0)
end
addEvent("onVehicleWeaponFire", false)
addEventHandler("onVehicleWeaponFire", root, eventVehicleFire)
</section>

'''Author: Tuna'''

==See Also==
{{Useful_Functions}}

SetBlipVisibleDistance

2014-12-05T21:28:44Z

Banex: /* Syntax */

{{Server client function}}
__NOTOC__
This function will set the visible distance of a blip.

==Syntax==
<syntaxhighlight lang="lua">float setBlipVisibleDistance ( blip theBlip, float theDistance )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:setVisibleDistance||getBlipVisibleDistance|}}

===Required Arguments===
*'''theBlip:''' The blip whose visible distance you wish to get.
*'''theDistance:''' The distance you want the blip to be visible for.

===Returns===
Returns true if successful, false otherwise.

==Example==
This example will demonstrate basic functionality of setBlipVisibleDistance
<syntaxhighlight lang="lua">
local blip = createBlip(0, 0, 0, 47, 0, 0, 0, 0, 0, 0, 1000)
outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip)) --1000
setBlipVisibleDistance(blip, 2000)
outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip)) --2000
</syntaxhighlight>

This example will set the visible distance of all blips to half the original value.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
local blips = getElementsByType("blip")
-- Loop through the list, storing the blips visible distance with the rest.
for index, blip in ipairs(blips) do
-- Retrieve the blip's visible distance and divide by 2
setBlipVisibleDistance(blip, getBlipVisibleDistance(blip) / 2)
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

SetBlipSize

2014-12-05T21:28:13Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function sets the size of a blip's icon.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipSize ( blip theBlip, int iconSize )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:setSize||getBlipSize|}}
===Required Arguments===
*'''theBlip:''' The blip you wish to get the size of.
*'''iconSize:''' The size you wish the icon to be. 2 is the default value.

===Returns===
Returns an ''true'' if the blip's size was set successfully. Returns ''false'' if the [[element]] passed was not a [[blip]] or if the icon size passed was invalid.

==Example==
This example will reset the size of all blips to the default.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
blips = getElementsByType ( "blip" )
-- Loop through the list
for blipKey, blipValue in ipairs(blips) do
-- Retrieve the blip's size into the variable 'blipSize'
blipSize = getBlipSize ( blipValue )
-- If the blip's size wasn't 2 (the default size) already
if ( blipSize ~= 2 ) then
-- Set the size to the default
setBlipSize ( blipValue, 2 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

SetBlipOrdering

2014-12-05T21:26:44Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function sets the Z ordering of a blip. It allows you to make a blip appear on top of or below other blips.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipOrdering ( blip theBlip, int ordering )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:setOrdering||getBlipOrdering|}}
===Required Arguments===
*'''theBlip:''' the blip whose Z ordering to change.
*'''ordering:''' the new Z ordering value. Blips with higher values will appear on top of blips with lower values. Possible range: -32767 to 32767. Default: 0.

===Returns===
Returns ''true'' if the blip ordering was changed successfully, ''false'' otherwise.

==Example==
This example will create a blip and make your blip on top of all other blip's.
<section class="server" name="Server" show="true">
<syntaxhighlight lang="lua">
function makeBlipHigher(thePlayer)
local setmeup = createBlipAttachedTo ( thePlayer, 3, 3, 255, 0,0,255,0,99999.0, root)
setBlipOrdering(setmeup, getBlipOrdering(setmeup) + 1)
outputChatBox("*INFO: #ffff00Your blip is now on top of others!", thePlayer, 255,0,0,true)
for i,v in ipairs(getElementsByType"player") do
if v ~= thePlayer then
outputChatBox("*INFO: #ffff00" .. getPlayerName(thePlayer) .. "'s blip is now on top of your blip!",v,255,0,0,true)
end
end
end
addCommandHandler("incrementBlip", makeBlipHigher, false, false)
</syntaxhighlight>
</section>

==See Also==
{{Blip functions}}

SetBlipColor

2014-12-05T21:26:18Z

Banex: /* Syntax */

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

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

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

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

==See Also==
{{Blip_functions}}

SetBlipIcon

2014-12-05T21:25:13Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function sets the icon for an existing blip element.

==Syntax==
<syntaxhighlight lang="lua">bool setBlipIcon ( blip theBlip, int icon )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:setIcon||}}

===Required Arguments===
*'''theBlip''' The blip you wish to set the icon of.
*'''icon:''' A number indicating the icon you wish to change it do. Valid values are:
{{Blip_Icons}}

===Returns===
Returns ''true'' if the icon was succesfully set, ''false'' if the element passed was not a valid blip or the icon value was not a valid icon number.

==Example==
This example resets all blip icons to the default blip icon, 0.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
blips = getElementsByType ( "blip" )
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in blips do
-- Retrieve the blip's icon into the variable 'blipIcon'
blipIcon = getBlipIcon ( blipValue )
-- If the blip's icon wasn't the default already
if ( blipIcon ~= 0 ) then
-- Set the blip's icon to the default
setBlipIcon ( blipValue, 0 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

GetBlipVisibleDistance

2014-12-05T21:24:10Z

Banex: /* Syntax */

{{Server client function}}
__NOTOC__
This function will tell you what visible distance a blip has.

==Syntax==
<syntaxhighlight lang="lua">float getBlipVisibleDistance ( blip theBlip )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getVisibleDistance||}}
===Required Arguments===
*'''theBlip:''' The blip whose visible distance you wish to get.

===Returns===
Returns one float with the blips visible distance, false if the blip is invalid.

==Example==
This example will demonstrate basic functionality of getBlipVisibleDistance
<syntaxhighlight lang="lua">
local blip = createBlip(0, 0, 0, 47, 0, 0, 0, 0, 0, 0, 1000)
outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip))
</syntaxhighlight>

This example will combine the total visible distances of all blips
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
local blips = getElementsByType("blip")
local distance = 0
-- Loop through the list, storing the blips visible distance with the rest.
for index, blip in ipairs(blips) do
-- Retrieve the blip's visible distance
distance = distance + getBlipVisibleDistance(blip) or 0 -- "or 0" just incase its false ;)
end
outputDebugString("Combined total of all blips visible distances: "..distance)
</syntaxhighlight>

==See Also==
{{Blip_functions}}

GetBlipSize

2014-12-05T21:22:53Z

Banex: /* Syntax */

{{Server client function}}
__NOTOC__
This function gets the size of a blip.

==Syntax==
<syntaxhighlight lang="lua">int getBlipSize ( blip theBlip )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getSize||}}

===Required Arguments===
*'''theBlip:''' The blip you wish to get the size of.

===Returns===
Returns an [[int]] indicating the size of the blip. The default value is 2.

==Example==
This example will reset the size of all blips to the default.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
blips = getElementsByType ( "blip" )
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in ipairs(blips) do
-- Retrieve the blip's size into the variable 'blipSize'
blipSize = getBlipSize ( blipValue )
-- If the blip's size wasn't 2 (the default size) already
if ( blipSize ~= 2 ) then
-- Set the blip's size to the default
setBlipSize ( blipValue, 2 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

GetBlipOrdering

2014-12-05T21:22:00Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function gets the Z ordering value of a blip. The Z ordering determines if a blip appears on top of or below other blips. Blips with a higher Z ordering value appear on top of blips with a lower value. The default value for all blips is 0.

==Syntax==
<syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getOrdering||}}
===Required Arguments===
*'''theBlip:''' the blip to retrieve the Z ordering value of.

===Returns===
Returns the Z ordering value of the blip if successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function getMyBlip(theBlip)
local ordering = getBlipOrdering ( theBlip )
if (ordering) then
outputChatBox("The following blip has a ordering of "..ordering)
end
end
</syntaxhighlight>

==See Also==
{{Blip functions}}

GetBlipIcon

2014-12-05T21:21:04Z

Banex: /* Syntax */

{{Server client function}}
__NOTOC__
This function returns the icon a blip currently has.
==Syntax==
<syntaxhighlight lang="lua">int getBlipIcon ( blip theBlip )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getIcon||}}
===Required Arguments===
*'''theBlip''': the blip we're getting the icon number of.

===Returns===
Returns an [[int]] indicating which icon the blip has. Valid values are:
{{Blip_Icons}}

==Example==
This example will find all the blips that exist and set them all to the default blip icon.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the blips that exist
blips = getElementsByType ( "blip" )
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in ipairs(blips) do
-- Retrieve the blip's icon into the variable 'blipIcon'
blipIcon = getBlipIcon ( blipValue )
-- If the blip's icon wasn't the default already
if ( blipIcon ~= 0 ) then
-- Set the blip's icon to the default
setBlipIcon ( blipValue, 0 )
end
end
</syntaxhighlight>

==See Also==
{{Blip_functions}}

GetBlipColor

2014-12-05T21:19:14Z

Banex: /* Syntax */

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

==Syntax==
<syntaxhighlight lang="lua">int int int int getBlipColor ( blip theBlip )</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getColor||}}

===Required Arguments===
*'''theBlip:''' The blip whose color you wish to get.

===Returns===
Returns four integers in RGBA format, with a maximum value of 255 for each. The values are, in order, ''red'', ''green'', ''blue'', and ''alpha''. Alpha decides the transparancy where 255 is opaque and 0 is fully transparent. ''false'' is returned if the blip is invalid.

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

==See Also==
{{Blip_functions}}

CreateBlipAttachedTo

2014-12-05T21:17:50Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function creates a [[blip]] that is attached to an [[element]]. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255, int ordering=0, float visibleDistance=99999.0, visibleTo = getRootElement()] )
</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:createAttachedTo||}}

===Required Arguments===
*'''elementToAttachTo:''' The [[element]] to attach the marker to.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default value is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible (0 - 65535)
}}
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0,
int a=255, int ordering=0, float visibleDistance=99999.0] )
</syntaxhighlight>

===Required Arguments===
*'''elementToAttachTo:''' The [[element]] to attach the marker to.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. 'Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible
}}
</section>

===Returns===
Returns a [[blip]] if the blip was created succesfully, or ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player.
<syntaxhighlight lang="lua">
-- Pick a random player
function setupRandomRobber ()
local myPlayer = getRandomPlayer ()
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
local myBlip = createBlipAttachedTo ( myPlayer, 52 )
end
</syntaxhighlight>
</section>

==See Also==
{{Blip_functions}}

CreateBlip

2014-12-05T21:16:07Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function creates a [[blip]] [[element]], which is displayed as an icon on the client's radar.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 99999.0, visibleTo = getRootElement( ) ] )
</syntaxhighlight>
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:create||}}

===Required Arguments===
*'''x:''' The x position of the blip, in world coordinates.
*'''y:''' The y position of the blip, in world coordinates.
*'''z:''' The z position of the blip, in world coordinates.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible
}}
*'''visibleTo:''' This defines which elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' The x position of the blip, in world coordinates.
*'''y:''' The y position of the blip, in world coordinates.
*'''z:''' The z position of the blip, in world coordinates.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible.
}}
</section>

==Returns==
Returns an [[element]] of the [[blip]] if it was created successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example creates a radar blip at a random player's position and makes it so that it is only visible to that player.
<syntaxhighlight lang="lua">
-- Pick a random player
local myPlayer = getRandomPlayer( )
-- Retrieve the player's position and store it in the variables x, y and z
local x, y, z = getElementPosition( myPlayer )
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player
local myBlip = createBlip( x, y, z, 51, 0, 0, 0, 255, myPlayer )
</syntaxhighlight>

'''Example 2:''' This example attaches a blip to a player. You can attach a blip to an element by just setting the blip's parent to that element.
<syntaxhighlight lang="lua">
-- Pick a random player
local myPlayer = getRandomPlayer( )
-- Create a radar blip in the middle of the map
local myBlip = createBlip( 0, 0, 0 )
-- Make the player the parent of the blip, so that the blip follows the player around
setElementParent( myBlip, myPlayer )
</syntaxhighlight>
</section>

==See Also==
{{Blip_functions}}

[[AR:createBlip]]
[[es:createBlip]]
[[DE:createBlip]]

GetCameraInterior

2014-12-05T21:02:17Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
Returns the interior of the local camera (independent of the interior of the local player).

==Procedural==
===Syntax===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int getCameraInterior ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getInterior}}

===Required Arguments===
'''thePlayer''': The player whose camera interior you want to get.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getCameraInterior ( )
</syntaxhighlight>
</section>

Returns an ''integer'' indicating the camera's interior, ''false'' if the argument is invalid.

===Example===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function outputCameraInterior ( player, command )
local interior = getCameraInterior ( player )
outputChatBox ( "The camera is in the interior " .. interior, player, 255, 255, 0 )
end
addCommandHandler ( "camera", outputCameraInterior )
</syntaxhighlight>
</section>

{{New items|3.0140|1.4|
==Object-oriented==
===Syntax===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int player:getCameraInterior ( )
-- or
int player.cameraInterior -- to get the camera interior value
player.cameraInterior = int someValue -- to set the camera interior value
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int Camera.getInterior ( )
</syntaxhighlight>
</section>

Returns an ''integer'' indicating the camera's interior, ''false'' if the argument is invalid.

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function outputCameraInterior ( command )
local interior = Camera.getInterior ( )
outputChatBox ( "The camera is in the interior " .. interior, localPlayer, 255, 255, 0 )
end
addCommandHandler ( "camera", outputCameraInterior )
</syntaxhighlight>
</section>
}}

==See Also==
{{Camera functions}}

SetCameraInterior

2014-12-05T21:00:10Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
Sets the interior of the local camera. Only the interior of the camera is changed, the local player stays in the interior he was in.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setCameraInterior ( player thePlayer, int interior )
</syntaxhighlight>
{{OOP||[[player]]:setInterior|cameraInterior|getCameraInterior}}
===Required Arguments===
*'''thePlayer:''' the player whose camera interior will be set.
*'''interior:''' the interior to place the camera in.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setCameraInterior ( int interior )
</syntaxhighlight>

===Required Arguments===
*'''interior:''' the interior to place the camera in.
</section>

===Returns===
Returns ''true'' if the camera's interior was changed successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">

<strong> This example make a command to change your cam interior to a selected one. </strong>

<syntaxhighlight lang="lua">
function setCamInt( thePlayer, commandName, intID )
if( intID )then -- If there is an ID
local seted = setCameraInterior( thePlayer, intID ) -- set the interior to the camera
if( seted )then -- If it has been changed correctly
outputChatBox( "Your camera's interior has been set to "..intID, thePlayer ) -- Tell to the player his new camera's interior
else -- otherwise
outputChatBox( "Can't change your camera's interior...", thePlayer, 255, 0, 0 ) -- Tell him the change failed
end
else -- otherwise
outputChatBox( "Syntax: /caminterior [interiorID] ", thePlayer, 255, 0, 0 ) -- Tell him the correct syntax
end
end
addCommandHandler( "caminterior", setCamInt )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<strong> This example make a command to change your cam interior to a selected one. </strong>
<syntaxhighlight lang="lua">
function setCam(command,int)
if (int) then
local setInt = setCameraInterior(int)
if (setInt) then
outputChatBox("Your camera's interior has been set to "..int,255,255,0)
else
outputChatBox("Can't change your camera's interior...",255,0,0)
end
else
outputChatBox("Syntax: /camera [interiorID] ",255,0,0)
end
end
addCommandHandler("camera",setCam)
</syntaxhighlight>
</section>

==See Also==
{{Client_camera_functions}}

FadeCamera

2014-12-05T20:58:23Z

Banex: /* Syntax */

{{Server client function}}
__NOTOC__
This function will fade a player's camera to a color or back to normal over a specified time period. This will also affect the sound volume for the player (50% faded = 50% volume, full fade = no sound). For clientside scripts you can perform 2 fade ins or fade outs in a row, but for serverside scripts you must use one then the other.

''Note: The speed of the effect depends directly on the current gamespeed.''

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool fadeCamera ( player thePlayer, bool fadeIn, [ float timeToFade = 1.0, int red = 0, int green = 0, int blue = 0 ] )
</syntaxhighlight>
{{OOP||[[player]]:fade}}
===Required Arguments===
* '''thePlayer:''' The player whose camera you wish to fade.
* '''fadeIn:''' Should the camera be faded in or out? Pass ''true'' to fade the camera in, ''false'' to fade it out to a color.

===Optional Arguments===
* '''timeToFade:''' The number of seconds it should take to fade. Any number less than 1 makes the fade instant.
* '''red:''' The amount of red in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''green:''' The amount of green in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''blue:''' The amount of blue in the color that the camera fades out to (0 - 255). Not required for fading in.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool fadeCamera ( bool fadeIn, [ float timeToFade = 1.0, int red = 0, int green = 0, int blue = 0 ] )
</syntaxhighlight>
{{OOP||Camera.fade}}
===Required Arguments===
* '''fadeIn:''' Should the camera be faded in our out? Pass ''true'' to fade the camera in, ''false'' to fade it out to a color.

===Optional Arguments===
* '''timeToFade:''' The number of seconds it should take to fade. Any number less than 1 makes the fade instant.
* '''red:''' The amount of red in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''green:''' The amount of green in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''blue:''' The amount of blue in the color that the camera fades out to (0 - 255). Not required for fading in.
</section>

===Returns===
Returns ''true'' if the camera was faded successfully, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Server example" class="server" show="true">
When a player gets damaged, place a quick fade-to-red effect on his screen.
<syntaxhighlight lang="lua">
function addRednessOnDamage ( )
fadeCamera ( source, false, 1.0, 255, 0, 0 ) -- fade the player's camera to red over a period of 1 second
setTimer ( fadeCameraDelayed, 500, 1, source ) -- don't let it go to opaque red, interrupt it after half a second and fade back to normal
end
addEventHandler ( "onPlayerDamage", getRootElement(), addRednessOnDamage )

function fadeCameraDelayed(player) -- This function prevents debug warnings when the player disconnects while the timer is running.
if (isElement(player)) then
fadeCamera(player, true, 0.5)
end
end
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

OOP client

2014-12-05T20:51:38Z

Banex: /* Marker */

The new OOP in MTA allows for better code organization and readability. This is a list of [[Client_Scripting_Functions|client-side functions]].

''See also: [[OOP]]''

==Element==

areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibleTo (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getBoundingBox (function: [[getElementBoundingBox]])
getByID (function: [[getElementByID]])
getByType (function: [[getElementsByType]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getDistanceFromCentreOfMassToBaseOfModel (function: [[GetElementDistanceFromCentreOfMassToBaseOfModel]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getWithinColShape (function: [[getElementsWithinColShape]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setLowLOD (function: [[setLowLODElement]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setVelocity (function: [[setElementVelocity]])
setVisibleTo (function: [[setElementVisibleTo]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addUpgrade (function: [[addVehicleUpgrade]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAdjustableProperty (function: [[getVehicleAdjustableProperty]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getComponentPosition (function: [[getVehicleComponentPosition]])
getComponentRotation (function: [[getVehicleComponentRotation]])
getComponents (function: [[getVehicleComponents]])
getComponentVisible (function: [[getVehicleComponentVisible]])
getController (function: [[getVehicleController]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getGear (function: [[getVehicleCurrentGear]])
getGravity (function: [[getVehicleGravity]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getHelicopterRotorSpeed (function: [[getHelicopterRotorSpeed]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassengers (function: [[getVehicleMaxPassengers]])
getName (function: [[getVehicleName]])
getNitroCount (function: [[getVehicleNitroCount]])
getNitroLevel (function: [[getVehicleNitroLevel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirens (function: [[getVehicleSirens]])
getSirensOn (function: [[getVehicleSirensOn]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTrainDirection (function: [[getTrainDirection]])
getTrainSpeed (function: [[getTrainSpeed]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isNitroActivated (function: [[isVehicleNitroActivated]])
isNitroRecharging (function: [[isVehicleNitroRecharging]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
isTrainDerailable (function: [[setTrainDerailable]])
isTrainDerailed (function: [[isTrainDerailed]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetComponentPosition (function: [[resetVehicleComponentPosition]])
resetComponentRotation (function: [[resetVehicleComponentRotation]])
setAdjustableProperty (function: [[setVehicleAdjustableProperty]])
setColor (function: [[setVehicleColor]])
setComponentPosition (function: [[setVehicleComponentPosition]])
setComponentRotation (function: [[setVehicleComponentRotation]])
setComponentVisible (function: [[setVehicleComponentVisible]])
setDamageProof (function: [[setVehicleDamageProof]])
setDirtLevel (function: [[setVehicleDirtLevel]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setGravity (function: [[setVehicleGravity]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setHelicopterRotorSpeed (function: [[setHelicopterRotorSpeed]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setNitroActivated (function: [[setVehicleNitroActivated]])
setNitroCount (function: [[setVehicleNitroCount]])
setNitroLevel (function: [[setVehicleNitroLevel]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintjob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTrainDerailable (function: [[setTrainDerailable]])
setTrainDerailed (function: [[setTrainDerailed]])
setTrainDirection (function: [[setTrainDirection]])
setTrainSpeed (function: [[setTrainSpeed]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
canBeKnockedOffBike (function: [[canPedBeKnockedOffBike]])
create (function: [[createPed]])
doesHaveJetPack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getAnimation (function: [[getPedAnimation]])
getAnimationData (function: [[getPedAnimationData]])
getArmor (function: [[getPedArmor]])
getBodyPartName (function: [[getBodyPartName]])
getBonePosition (function: [[getPedBonePosition]])
getCameraRotation (function: [[getPedCameraRotation]])
getClothes (function: [[getPedClothes]])
getClothesByTypeIndex (function: [[getClothesByTypeIndex]])
getClothesTypeName (function: [[getClothesTypeName]])
getContactElement (function: [[getPedContactElement]])
getControlState (function: [[getPedControlState]])
getMoveState (function: [[getPedMoveState]])
getOccupiedVehicle (function: [[GetPedOccupiedVehicle]])
getOxygenLevel (function: [[getPedOxygenLevel]])
getSimplestTask (function: [[getPedSimplestTask]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTargetCollision (function: [[getPedTargetCollision]])
getTargetEnd (function: [[getPedTargetEnd]])
getTargetStart (function: [[getPedTargetStart]])
getTask (function: [[getPedTask]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getTypeIndexFromClothes (function: [[getTypeIndexFromClothes]])
getValidModels (function: [[getValidPedModels]])
getVoice (function: [[getPedVoice]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponMuzzlePosition (function: [[getPedWeaponMuzzlePosition]])
isChocking (function: [[isPedChoking]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDoingTask (function: [[isPedDoingTask]])
isDucked (function: [[isPedDucked]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
isTargetingMarkerEnabled (function: [[isPedTargetingMarkerEnabled]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
setAimTarget (function: [[setPedAimTarget]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setCameraRotation (function: [[setPedCameraRotation]])
setCanBeKnockedOffBike (function: [[setPedCanBeKnockedOffBike]])
setControlState (function: [[setPedControlState]])
setDoingGangDriveby (function: [[setPedDoingGangDriveby]])
setFootBloodEnabled (function: [[setPedFootBloodEnabled]])
setHeadless (function: [[setPedHeadless]])
setLookAt (function: [[setPedLookAt]])
setOnFire (function: [[setPedOnFire]])
setOxygenLevel (function: [[setPedOxygenLevel]])
setTargetingMarkerEnabled (function: [[setPedTargetingMarkerEnabled]])
setVoice (function: [[setPedVoice]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Player==
''Inherited from [[#Ped|Ped]]''

create (function: [[getPlayerFromName]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getMapBoundingBox (function: [[getPlayerMapBoundingBox]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isHudComponentVisible (function: [[isPlayerHudComponentVisible]])
isMapForced (function: [[isPlayerMapForced]])
isMapVisible (function: [[isPlayerMapVisible]])
isNametagShowing (function: [[isPlayerNametagShowing]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setMoney (function: [[setPlayerMoney]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
showHudComponent (function: [[showPlayerHudComponent]])
takeMoney (function: [[takePlayerMoney]])

==Object==
''Inherited from [[#Element|Element]]''

break (function: [[breakObject]])
create (function: [[createObject]])
getMass (function: [[getObjectMass]])
getScale (function: [[getObjectScale]])
isBreakable (function: [[isObjectBreakable]])
move (function: [[moveObject]])
respawn (function: [[respawnObject]])
setBreakable (function: [[setObjectBreakable]])
setMass (function: [[setObjectMass]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])
toggleObjectRespawn (function: [[toggleObjectRespawn]])

==Marker==
''Inherited from [[#Marker|Marker]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setType (function: [[setPickupType]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==Projectile==
''Inherited from [[#Projectile|Projectile]]''

create (function: [[createProjectile]])
getCounter (function: [[getProjectileCounter]])
getCreator (function: [[getProjectileCreator]])
getForce (function: [[getProjectileForce]])
getTarget (function: [[getProjectileTarget]])
getType (function: [[getProjectileType]])
setCounter (function: [[setProjectileCounter]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[getTeamFromName]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getLevel (function: [[getWaterLevel]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
isDrawnLast (function: [[isWaterDrawnLast]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setDrawnLast (function: [[setWaterDrawnLast]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])
testLineAgainst (function: [[testLineAgainstWater]])

==Sound==
''Inherited from [[#Element|Element]]''

create (function: [[playSound]])
getBPM (function: [[getSoundBPM]])
getEffects (function: [[getSoundEffects]])
getFFTData (function: [[getSoundFFTData]])
getLength (function: [[getSoundLength]])
getLevelData (function: [[getSoundLevelData]])
getMetaTags (function: [[getSoundMetaTags]])
getPan (function: [[getSoundPan]])
getPlaybackPosition (function: [[getSoundPosition]])
getProperties (function: [[getSoundProperties]])
getSpeed (function: [[getSoundSpeed]])
getVolume (function: [[getSoundVolume]])
getWaveData (function: [[getSoundWaveData]])
isPaused (function: [[isSoundPaused]])
setEffectEnabled (function: [[setSoundEffectEnabled]])
setPan (function: [[setSoundPan]])
setPaused (function: [[setSoundPaused]])
setPlaybackPosition (function: [[setSoundPosition]])
setProperties (function: [[setSoundProperties]])
setSpeed (function: [[setSoundSpeed]])
setVolume (function: [[setSoundVolume]])
stop (function: [[stopSound]])

==Sound3D==
''Inherited from [[#Sound|Sound]]''

create (function: [[playSound3D]])
getMaxDistance (function: [[getSoundMaxDistance]])
getMinDistance (function: [[getSoundMinDistance]])
setMaxDistance (function: [[setSoundMaxDistance]])
setMinDistance (function: [[setSoundMinDistance]])

==Weapon==
''Inherited from [[#Element|Element]]''

create (function: [[createWeapon]])
fire (function: [[fireWeapon]])
getAmmo (function: [[getWeaponAmmo]])
getClipAmmo (function: [[getWeaponClipAmmo]])
getFiringRate (function: [[getWeaponFiringRate]])
getFlags (function: [[getWeaponFlags]])
getOwner (function: [[getWeaponOwner]])
getProperty (function: [[setWeaponProperty]])
getState (function: [[getWeaponState]])
getTarget (function: [[getWeaponTarget]])
resetFiringRate (function: [[resetWeaponFiringRate]])
setAmmo (function: [[setWeaponAmmo]])
setClipAmmo (function: [[setWeaponClipAmmo]])
setFiringRate (function: [[setWeaponFiringRate]])
setFlags (function: [[setWeaponFlags]])
setOwner (function: [[setWeaponOwner]])
setProperty (function: [[setWeaponProperty]])
setState (function: [[setWeaponState]])
setTarget (function: [[setWeaponTarget]])

==Effect==
''Inherited from [[#Element|Element]]''

addBlood (function: [[fxAddBlood]])
addBulletImpact (function: [[fxAddBulletImpact]])
addBulletSplash (function: [[fxAddBulletSplash]])
addDebris (function: [[fxAddDebris]])
addFootSplash (function: [[fxAddFootSplash]])
addGlass (function: [[fxAddGlass]])
addGunshot (function: [[fxAddGunshot]])
addPunchImpact (function: [[fxAddPunchImpact]])
addSparks (function: [[fxAddSparks]])
addTankFire (function: [[fxAddTankFire]])
addTyreBurst (function: [[fxAddTyreBurst]])
addWaterHydrant (function: [[fxAddWaterHydrant]])
addWaterSplash (function: [[fxAddWaterSplash]])
addWood (function: [[fxAddWood]])
create (function: [[createEffect]])
getDensity (function: [[getEffectDensity]])
getSpeed (function: [[getEffectSpeed]])
setDensity (function: [[setEffectDensity]])
setSpeed (function: [[setEffectSpeed]])

==GuiElement==
''Inherited from [[#Element|Element]]''

bringToFront (function: [[guiBringToFront]])
moveToBack (function: [[guiMoveToBack]])
isChatBoxInputActive (function: [[isChatBoxInputActive]])
isConsoleActive (function: [[isConsoleActive]])
isDebugViewActive (function: [[isDebugViewActive]])
isMainMenuActive (function: [[isMainMenuActive]])
isMTAWindowActive (function: [[isMTAWindowActive]])
isTransferBoxActive (function: [[isTransferBoxActive]])
isInputEnabled (function: [[guiGetInputEnabled]])
getInputMode (function: [[guiGetInputMode]])
getScreenSize (function: [[guiGetScreenSize]])
getProperties (function: [[guiGetProperties]])
getAlpha (function: [[guiGetAlpha]])
getFont (function: [[guiGetFont]])
getEnabled (function: [[guiGetEnabled]])
getVisible (function: [[guiGetVisible]])
getText (function: [[guiGetText]])
getPosition (function: [[guiGetPosition]])
getSize (function: [[guiGetSize]])
getProperty (function: [[guiGetProperty]])
setInputEnabled (function: [[guiSetInputEnabled]])
setAlpha (function: [[guiSetAlpha]])
setEnabled (function: [[guiSetEnabled]])
setFont (function: [[guiSetFont]])
setVisible (function: [[guiSetVisible]])
setText (function: [[guiSetText]])
setInputMode (function: [[guiSetInputMode]])
setProperty (function: [[guiSetProperty]])
setPosition (function: [[guiSetPosition]])
setSize (function: [[guiSetSize]])
==GuiWindow==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateWindow]])
setMovable (function: [[guiWindowSetMovable]])
setSizable (function: [[guiWindowSetSizable]])
==GuiButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateButton]])
==GuiEdit==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateEdit]])
getCaretIndex (function: [[guiEditGetCaretIndex]])
setCaretIndex (function: [[guiEditSetCaretIndex]])
setReadOnly (function: [[guiEditSetReadOnly]])
setMasked (function: [[guiEditSetMasked]])
setMaxLength (function: [[guiEditSetMaxLength]])
==GuiLabel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateLabel]])
getFontHeight (function: [[guiLabelGetFontHeight]])
getTextExtent (function: [[guiLabelGetTextExtent]])
getColor (function: [[guiLabelGetColor]])
setColor (function: [[guiLabelSetColor]])
setHorizontalAlign (function: [[guiLabelSetHorizontalAlign]])
setVerticalAlign (function: [[guiLabelSetVerticalAlign]])
==GuiMemo==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateMemo]])
getCaretIndex (function: [[guiMemoGetCaretIndex]])
setCaretIndex (function: [[guiMemoSetCaretIndex]])
setReadOnly (function: [[guiMemoSetReadOnly]])
==GuiStaticImage==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateStaticImage]])
loadImage (function: [[guiStaticImageLoadImage]])
==GuiComboBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateComboBox]])
addItem (function: [[guiComboBoxAddItem]])
clear (function: [[guiComboBoxClear]])
removeItem (function: [[guiComboBoxRemoveItem]])
getSelected (function: [[guiComboBoxGetSelected]])
getItemText (function: [[guiComboBoxGetItemText]])
setItemText (function: [[guiComboBoxSetItemText]])
setSelected (function: [[guiComboBoxSetSelected]])
==GuiCheckBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateCheckBox]])
getSelected (function: [[guiCheckBoxGetSelected]])
setSelected (function: [[guiCheckBoxSetSelected]])
==GuiRadioButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateRadioButton]])
getSelected (function: [[guiRadioButtonGetSelected]])
setSelected (function: [[guiRadioButtonSetSelected]])
==GuiScrollPane==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollPane]])
getHorizontalScrollPosition (function: [[guiScrollPaneGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiScrollPaneGetVerticalScrollPosition]])
setHorizontalScrollPosition (function: [[guiScrollPaneSetHorizontalScrollPosition]])
setScrollBars (function: [[guiScrollPaneSetScrollBars]])
setVerticalScrollPosition (function: [[guiScrollPaneSetVerticalScrollPosition]])
==GuiScrollBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollBar]])
getScrollPosition (function: [[guiScrollBarGetScrollPosition]])
setScrollPosition (function: [[guiScrollBarSetScrollPosition]])
==GuiProgressBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateProgressBar]])
getProgress (function: [[guiProgressBarGetProgress]])
setProgress (function: [[guiProgressBarSetProgress]])
==GuiGridlist==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateGridList]])
addColumn (function: [[guiGridListAddColumn]])
addRow (function: [[guiGridListAddRow]])
autoSizeColumn (function: [[guiGridListAutoSizeColumn]])
clear (function: [[guiGridListClear]])
insertRowAfter (function: [[guiGridListInsertRowAfter]])
removeColumn (function: [[guiGridListRemoveColumn]])
removeRow (function: [[guiGridListRemoveRow]])
getItemData (function: [[guiGridListGetItemData]])
getItemText (function: [[guiGridListGetItemText]])
getRowCount (function: [[guiGridListGetRowCount]])
getSelectedItem (function: [[guiGridListGetSelectedItem]])
getItemColor (function: [[guiGridListGetItemColor]])
getColumnTitle (function: [[guiGridListGetColumnTitle]])
getHorizontalScrollPosition (function: [[guiGridListGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiGridListGetVerticalScrollPosition]])
getSelectedCount (function: [[guiGridListGetSelectedCount]])
getSelectedItems (function: [[guiGridListGetSelectedItems]])
getColumnCount (function: [[guiGridListGetColumnCount]])
setItemData (function: [[guiGridListSetItemData]])
setItemText (function: [[guiGridListSetItemText]])
setScrollBars (function: [[guiGridListSetScrollBars]])
setSelectedItem (function: [[guiGridListSetSelectedItem]])
setSelectionMode (function: [[guiGridListSetSelectionMode]])
setSortingEnabled (function: [[guiGridListSetSortingEnabled]])
setColumnWidth (function: [[guiGridListSetColumnWidth]])
setItemColor (function: [[guiGridListSetItemColor]])
setColumnTitle (function: [[guiGridListSetColumnTitle]])
setHorizontalScrollPosition (function: [[guiGridListSetHorizontalScrollPosition]])
setVerticalScrollPosition (function: [[guiGridListSetVerticalScrollPosition]])
==GuiTabPanel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTabPanel]])
getSelectedTab (function: [[guiGetSelectedTab]])
setSelectedTab (function: [[guiSetSelectedTab]])
==GuiTab==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTab]])
delete (function: [[guiDeleteTab]])
==GuiFont==
''Inherited from [[#Element|Element]]''

create (function: [[guiCreateFont]])
==Resource==
create (function: [[getResourceFromName]])
fromName (function: [[getResourceFromName]])
getGuiElement (function: [[getResourceGUIElement]])
getRootElement (function: [[getResourceRootElement]])
getName (function: [[getResourceName]])
getThis (function: [[getThisResource]])
getConfig (function: [[getResourceConfig]])
getConfig (function: [[getResourceConfig]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getExportedFunctions (function: [[getResourceExportedFunctions]])
getState (function: [[getResourceState]])
==Timer==
create (function: [[setTimer]])
destroy (function: [[killTimer]])
reset (function: [[resetTimer]])
isValid (function: [[isTimer]])
getDetails (function: [[getTimerDetails]])
==File==
create (function: [[fileOpen]])
destroy (function: [[fileClose]])
close (function: [[fileClose]])
new (function: [[fileCreate]])
delete (function: [[fileDelete]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])
copy (function: [[fileCopy]])
==XML==
load (function: [[xmlLoadFile]])
unload (function: [[xmlUnloadFile]])
copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
destroy (function: [[xmlDestroyNode]])
setValue (function: [[xmlNodeGetValue]])
setAttribute (function: [[xmlNodeSetAttribute]])
setValue (function: [[xmlNodeSetValue]])
saveFile (function: [[xmlSaveFile]])
createChild (function: [[xmlCreateChild]])
findChild (function: [[xmlFindChild]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
getAttribute (function: [[xmlNodeGetAttribute]])
setName (function: [[xmlNodeSetName]])
==Camera==
fade (function: [[fadeCamera]])
getTarget (function: [[getCameraTarget]])
getInterior (function: [[getCameraInterior]])
getViewMode (function: [[getCameraViewMode]])
getGoggleEffect (function: [[getCameraGoggleEffect]])
setInterior (function: [[setCameraInterior]])
setTarget (function: [[setCameraTarget]])
setViewMode (function: [[setCameraViewMode]])
setGoggleEffect (function: [[setCameraGoggleEffect]])
setClip (function: [[setCameraClip]])
==Engine==
restoreCOL (function: [[engineRestoreCOL]])
restoreModel (function: [[engineRestoreModel]])
setAsynchronousLoading (function: [[engineSetAsynchronousLoading]])
setModelLODDistance (function: [[engineSetModelLODDistance]])
getVisibleTextureName (function: [[engineGetVisibleTextureNames]])
getModelLODDistance (function: [[engineGetModelLODDistance]])
getModelTextureNames (function: [[engineGetModelTextureNames]])
getModelIDFromName (function: [[engineGetModelIDFromName]])
getModelNameFromID (function: [[engineGetModelNameFromID]])
==EngineCOL==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadCOL]])
replace (function: [[engineReplaceCOL]])
==EngineTXD==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadTXD]])
import (function: [[engineImportTXD]])
==EngineDFF==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadDFF]])
replace (function: [[engineReplaceModel]])
==DxMaterial==
''Inherited from [[#Element|Element]]''

getSize (function: [[dxGetMaterialSize]])
==DxTexture==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateTexture]])
setEdge (function: [[dxSetTextureEdge]])
setPixels (function: [[dxSetTexturePixels]])
getPixels (function: [[dxGetTexturePixels]])
==DxFont==
create (function: [[dxCreateFont]])
getHeight (function: [[dxGetFontHeight]])
getTextWidth (function: [[dxGetTextWidth]])
==DxShader==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateShader]])
setValue (function: [[dxSetShaderValue]])
setTessellation (function: [[dxSetShaderTessellation]])
setTransform (function: [[dxSetShaderTransform]])
value (function: [[dxGetFontHeight]])
==DxScreenSource==
create (function: [[dxCreateScreenSource]])
update (function: [[dxUpdateScreenSource]])
==DxRenderTarget==
create (function: [[dxCreateRenderTarget]])
setAsTarget (function: [[dxSetRenderTarget]])

OOP client

2014-12-05T20:46:25Z

Banex: /* Projectile */

The new OOP in MTA allows for better code organization and readability. This is a list of [[Client_Scripting_Functions|client-side functions]].

''See also: [[OOP]]''

==Element==

areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibleTo (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getBoundingBox (function: [[getElementBoundingBox]])
getByID (function: [[getElementByID]])
getByType (function: [[getElementsByType]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getDistanceFromCentreOfMassToBaseOfModel (function: [[GetElementDistanceFromCentreOfMassToBaseOfModel]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getWithinColShape (function: [[getElementsWithinColShape]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setLowLOD (function: [[setLowLODElement]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setVelocity (function: [[setElementVelocity]])
setVisibleTo (function: [[setElementVisibleTo]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addUpgrade (function: [[addVehicleUpgrade]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAdjustableProperty (function: [[getVehicleAdjustableProperty]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getComponentPosition (function: [[getVehicleComponentPosition]])
getComponentRotation (function: [[getVehicleComponentRotation]])
getComponents (function: [[getVehicleComponents]])
getComponentVisible (function: [[getVehicleComponentVisible]])
getController (function: [[getVehicleController]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getGear (function: [[getVehicleCurrentGear]])
getGravity (function: [[getVehicleGravity]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getHelicopterRotorSpeed (function: [[getHelicopterRotorSpeed]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassengers (function: [[getVehicleMaxPassengers]])
getName (function: [[getVehicleName]])
getNitroCount (function: [[getVehicleNitroCount]])
getNitroLevel (function: [[getVehicleNitroLevel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirens (function: [[getVehicleSirens]])
getSirensOn (function: [[getVehicleSirensOn]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTrainDirection (function: [[getTrainDirection]])
getTrainSpeed (function: [[getTrainSpeed]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isNitroActivated (function: [[isVehicleNitroActivated]])
isNitroRecharging (function: [[isVehicleNitroRecharging]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
isTrainDerailable (function: [[setTrainDerailable]])
isTrainDerailed (function: [[isTrainDerailed]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetComponentPosition (function: [[resetVehicleComponentPosition]])
resetComponentRotation (function: [[resetVehicleComponentRotation]])
setAdjustableProperty (function: [[setVehicleAdjustableProperty]])
setColor (function: [[setVehicleColor]])
setComponentPosition (function: [[setVehicleComponentPosition]])
setComponentRotation (function: [[setVehicleComponentRotation]])
setComponentVisible (function: [[setVehicleComponentVisible]])
setDamageProof (function: [[setVehicleDamageProof]])
setDirtLevel (function: [[setVehicleDirtLevel]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setGravity (function: [[setVehicleGravity]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setHelicopterRotorSpeed (function: [[setHelicopterRotorSpeed]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setNitroActivated (function: [[setVehicleNitroActivated]])
setNitroCount (function: [[setVehicleNitroCount]])
setNitroLevel (function: [[setVehicleNitroLevel]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintjob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTrainDerailable (function: [[setTrainDerailable]])
setTrainDerailed (function: [[setTrainDerailed]])
setTrainDirection (function: [[setTrainDirection]])
setTrainSpeed (function: [[setTrainSpeed]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
canBeKnockedOffBike (function: [[canPedBeKnockedOffBike]])
create (function: [[createPed]])
doesHaveJetPack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getAnimation (function: [[getPedAnimation]])
getAnimationData (function: [[getPedAnimationData]])
getArmor (function: [[getPedArmor]])
getBodyPartName (function: [[getBodyPartName]])
getBonePosition (function: [[getPedBonePosition]])
getCameraRotation (function: [[getPedCameraRotation]])
getClothes (function: [[getPedClothes]])
getClothesByTypeIndex (function: [[getClothesByTypeIndex]])
getClothesTypeName (function: [[getClothesTypeName]])
getContactElement (function: [[getPedContactElement]])
getControlState (function: [[getPedControlState]])
getMoveState (function: [[getPedMoveState]])
getOccupiedVehicle (function: [[GetPedOccupiedVehicle]])
getOxygenLevel (function: [[getPedOxygenLevel]])
getSimplestTask (function: [[getPedSimplestTask]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTargetCollision (function: [[getPedTargetCollision]])
getTargetEnd (function: [[getPedTargetEnd]])
getTargetStart (function: [[getPedTargetStart]])
getTask (function: [[getPedTask]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getTypeIndexFromClothes (function: [[getTypeIndexFromClothes]])
getValidModels (function: [[getValidPedModels]])
getVoice (function: [[getPedVoice]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponMuzzlePosition (function: [[getPedWeaponMuzzlePosition]])
isChocking (function: [[isPedChoking]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDoingTask (function: [[isPedDoingTask]])
isDucked (function: [[isPedDucked]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
isTargetingMarkerEnabled (function: [[isPedTargetingMarkerEnabled]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
setAimTarget (function: [[setPedAimTarget]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setCameraRotation (function: [[setPedCameraRotation]])
setCanBeKnockedOffBike (function: [[setPedCanBeKnockedOffBike]])
setControlState (function: [[setPedControlState]])
setDoingGangDriveby (function: [[setPedDoingGangDriveby]])
setFootBloodEnabled (function: [[setPedFootBloodEnabled]])
setHeadless (function: [[setPedHeadless]])
setLookAt (function: [[setPedLookAt]])
setOnFire (function: [[setPedOnFire]])
setOxygenLevel (function: [[setPedOxygenLevel]])
setTargetingMarkerEnabled (function: [[setPedTargetingMarkerEnabled]])
setVoice (function: [[setPedVoice]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Player==
''Inherited from [[#Ped|Ped]]''

create (function: [[getPlayerFromName]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getMapBoundingBox (function: [[getPlayerMapBoundingBox]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isHudComponentVisible (function: [[isPlayerHudComponentVisible]])
isMapForced (function: [[isPlayerMapForced]])
isMapVisible (function: [[isPlayerMapVisible]])
isNametagShowing (function: [[isPlayerNametagShowing]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setMoney (function: [[setPlayerMoney]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
showHudComponent (function: [[showPlayerHudComponent]])
takeMoney (function: [[takePlayerMoney]])

==Object==
''Inherited from [[#Element|Element]]''

break (function: [[breakObject]])
create (function: [[createObject]])
getMass (function: [[getObjectMass]])
getScale (function: [[getObjectScale]])
isBreakable (function: [[isObjectBreakable]])
move (function: [[moveObject]])
respawn (function: [[respawnObject]])
setBreakable (function: [[setObjectBreakable]])
setMass (function: [[setObjectMass]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])
toggleObjectRespawn (function: [[toggleObjectRespawn]])

==Marker==
''Inherited from [[#Element|Element]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setType (function: [[setPickupType]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==Projectile==
''Inherited from [[#Projectile|Projectile]]''

create (function: [[createProjectile]])
getCounter (function: [[getProjectileCounter]])
getCreator (function: [[getProjectileCreator]])
getForce (function: [[getProjectileForce]])
getTarget (function: [[getProjectileTarget]])
getType (function: [[getProjectileType]])
setCounter (function: [[setProjectileCounter]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[getTeamFromName]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getLevel (function: [[getWaterLevel]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
isDrawnLast (function: [[isWaterDrawnLast]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setDrawnLast (function: [[setWaterDrawnLast]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])
testLineAgainst (function: [[testLineAgainstWater]])

==Sound==
''Inherited from [[#Element|Element]]''

create (function: [[playSound]])
getBPM (function: [[getSoundBPM]])
getEffects (function: [[getSoundEffects]])
getFFTData (function: [[getSoundFFTData]])
getLength (function: [[getSoundLength]])
getLevelData (function: [[getSoundLevelData]])
getMetaTags (function: [[getSoundMetaTags]])
getPan (function: [[getSoundPan]])
getPlaybackPosition (function: [[getSoundPosition]])
getProperties (function: [[getSoundProperties]])
getSpeed (function: [[getSoundSpeed]])
getVolume (function: [[getSoundVolume]])
getWaveData (function: [[getSoundWaveData]])
isPaused (function: [[isSoundPaused]])
setEffectEnabled (function: [[setSoundEffectEnabled]])
setPan (function: [[setSoundPan]])
setPaused (function: [[setSoundPaused]])
setPlaybackPosition (function: [[setSoundPosition]])
setProperties (function: [[setSoundProperties]])
setSpeed (function: [[setSoundSpeed]])
setVolume (function: [[setSoundVolume]])
stop (function: [[stopSound]])

==Sound3D==
''Inherited from [[#Sound|Sound]]''

create (function: [[playSound3D]])
getMaxDistance (function: [[getSoundMaxDistance]])
getMinDistance (function: [[getSoundMinDistance]])
setMaxDistance (function: [[setSoundMaxDistance]])
setMinDistance (function: [[setSoundMinDistance]])

==Weapon==
''Inherited from [[#Element|Element]]''

create (function: [[createWeapon]])
fire (function: [[fireWeapon]])
getAmmo (function: [[getWeaponAmmo]])
getClipAmmo (function: [[getWeaponClipAmmo]])
getFiringRate (function: [[getWeaponFiringRate]])
getFlags (function: [[getWeaponFlags]])
getOwner (function: [[getWeaponOwner]])
getProperty (function: [[setWeaponProperty]])
getState (function: [[getWeaponState]])
getTarget (function: [[getWeaponTarget]])
resetFiringRate (function: [[resetWeaponFiringRate]])
setAmmo (function: [[setWeaponAmmo]])
setClipAmmo (function: [[setWeaponClipAmmo]])
setFiringRate (function: [[setWeaponFiringRate]])
setFlags (function: [[setWeaponFlags]])
setOwner (function: [[setWeaponOwner]])
setProperty (function: [[setWeaponProperty]])
setState (function: [[setWeaponState]])
setTarget (function: [[setWeaponTarget]])

==Effect==
''Inherited from [[#Element|Element]]''

addBlood (function: [[fxAddBlood]])
addBulletImpact (function: [[fxAddBulletImpact]])
addBulletSplash (function: [[fxAddBulletSplash]])
addDebris (function: [[fxAddDebris]])
addFootSplash (function: [[fxAddFootSplash]])
addGlass (function: [[fxAddGlass]])
addGunshot (function: [[fxAddGunshot]])
addPunchImpact (function: [[fxAddPunchImpact]])
addSparks (function: [[fxAddSparks]])
addTankFire (function: [[fxAddTankFire]])
addTyreBurst (function: [[fxAddTyreBurst]])
addWaterHydrant (function: [[fxAddWaterHydrant]])
addWaterSplash (function: [[fxAddWaterSplash]])
addWood (function: [[fxAddWood]])
create (function: [[createEffect]])
getDensity (function: [[getEffectDensity]])
getSpeed (function: [[getEffectSpeed]])
setDensity (function: [[setEffectDensity]])
setSpeed (function: [[setEffectSpeed]])

==GuiElement==
''Inherited from [[#Element|Element]]''

bringToFront (function: [[guiBringToFront]])
moveToBack (function: [[guiMoveToBack]])
isChatBoxInputActive (function: [[isChatBoxInputActive]])
isConsoleActive (function: [[isConsoleActive]])
isDebugViewActive (function: [[isDebugViewActive]])
isMainMenuActive (function: [[isMainMenuActive]])
isMTAWindowActive (function: [[isMTAWindowActive]])
isTransferBoxActive (function: [[isTransferBoxActive]])
isInputEnabled (function: [[guiGetInputEnabled]])
getInputMode (function: [[guiGetInputMode]])
getScreenSize (function: [[guiGetScreenSize]])
getProperties (function: [[guiGetProperties]])
getAlpha (function: [[guiGetAlpha]])
getFont (function: [[guiGetFont]])
getEnabled (function: [[guiGetEnabled]])
getVisible (function: [[guiGetVisible]])
getText (function: [[guiGetText]])
getPosition (function: [[guiGetPosition]])
getSize (function: [[guiGetSize]])
getProperty (function: [[guiGetProperty]])
setInputEnabled (function: [[guiSetInputEnabled]])
setAlpha (function: [[guiSetAlpha]])
setEnabled (function: [[guiSetEnabled]])
setFont (function: [[guiSetFont]])
setVisible (function: [[guiSetVisible]])
setText (function: [[guiSetText]])
setInputMode (function: [[guiSetInputMode]])
setProperty (function: [[guiSetProperty]])
setPosition (function: [[guiSetPosition]])
setSize (function: [[guiSetSize]])
==GuiWindow==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateWindow]])
setMovable (function: [[guiWindowSetMovable]])
setSizable (function: [[guiWindowSetSizable]])
==GuiButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateButton]])
==GuiEdit==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateEdit]])
getCaretIndex (function: [[guiEditGetCaretIndex]])
setCaretIndex (function: [[guiEditSetCaretIndex]])
setReadOnly (function: [[guiEditSetReadOnly]])
setMasked (function: [[guiEditSetMasked]])
setMaxLength (function: [[guiEditSetMaxLength]])
==GuiLabel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateLabel]])
getFontHeight (function: [[guiLabelGetFontHeight]])
getTextExtent (function: [[guiLabelGetTextExtent]])
getColor (function: [[guiLabelGetColor]])
setColor (function: [[guiLabelSetColor]])
setHorizontalAlign (function: [[guiLabelSetHorizontalAlign]])
setVerticalAlign (function: [[guiLabelSetVerticalAlign]])
==GuiMemo==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateMemo]])
getCaretIndex (function: [[guiMemoGetCaretIndex]])
setCaretIndex (function: [[guiMemoSetCaretIndex]])
setReadOnly (function: [[guiMemoSetReadOnly]])
==GuiStaticImage==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateStaticImage]])
loadImage (function: [[guiStaticImageLoadImage]])
==GuiComboBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateComboBox]])
addItem (function: [[guiComboBoxAddItem]])
clear (function: [[guiComboBoxClear]])
removeItem (function: [[guiComboBoxRemoveItem]])
getSelected (function: [[guiComboBoxGetSelected]])
getItemText (function: [[guiComboBoxGetItemText]])
setItemText (function: [[guiComboBoxSetItemText]])
setSelected (function: [[guiComboBoxSetSelected]])
==GuiCheckBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateCheckBox]])
getSelected (function: [[guiCheckBoxGetSelected]])
setSelected (function: [[guiCheckBoxSetSelected]])
==GuiRadioButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateRadioButton]])
getSelected (function: [[guiRadioButtonGetSelected]])
setSelected (function: [[guiRadioButtonSetSelected]])
==GuiScrollPane==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollPane]])
getHorizontalScrollPosition (function: [[guiScrollPaneGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiScrollPaneGetVerticalScrollPosition]])
setHorizontalScrollPosition (function: [[guiScrollPaneSetHorizontalScrollPosition]])
setScrollBars (function: [[guiScrollPaneSetScrollBars]])
setVerticalScrollPosition (function: [[guiScrollPaneSetVerticalScrollPosition]])
==GuiScrollBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollBar]])
getScrollPosition (function: [[guiScrollBarGetScrollPosition]])
setScrollPosition (function: [[guiScrollBarSetScrollPosition]])
==GuiProgressBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateProgressBar]])
getProgress (function: [[guiProgressBarGetProgress]])
setProgress (function: [[guiProgressBarSetProgress]])
==GuiGridlist==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateGridList]])
addColumn (function: [[guiGridListAddColumn]])
addRow (function: [[guiGridListAddRow]])
autoSizeColumn (function: [[guiGridListAutoSizeColumn]])
clear (function: [[guiGridListClear]])
insertRowAfter (function: [[guiGridListInsertRowAfter]])
removeColumn (function: [[guiGridListRemoveColumn]])
removeRow (function: [[guiGridListRemoveRow]])
getItemData (function: [[guiGridListGetItemData]])
getItemText (function: [[guiGridListGetItemText]])
getRowCount (function: [[guiGridListGetRowCount]])
getSelectedItem (function: [[guiGridListGetSelectedItem]])
getItemColor (function: [[guiGridListGetItemColor]])
getColumnTitle (function: [[guiGridListGetColumnTitle]])
getHorizontalScrollPosition (function: [[guiGridListGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiGridListGetVerticalScrollPosition]])
getSelectedCount (function: [[guiGridListGetSelectedCount]])
getSelectedItems (function: [[guiGridListGetSelectedItems]])
getColumnCount (function: [[guiGridListGetColumnCount]])
setItemData (function: [[guiGridListSetItemData]])
setItemText (function: [[guiGridListSetItemText]])
setScrollBars (function: [[guiGridListSetScrollBars]])
setSelectedItem (function: [[guiGridListSetSelectedItem]])
setSelectionMode (function: [[guiGridListSetSelectionMode]])
setSortingEnabled (function: [[guiGridListSetSortingEnabled]])
setColumnWidth (function: [[guiGridListSetColumnWidth]])
setItemColor (function: [[guiGridListSetItemColor]])
setColumnTitle (function: [[guiGridListSetColumnTitle]])
setHorizontalScrollPosition (function: [[guiGridListSetHorizontalScrollPosition]])
setVerticalScrollPosition (function: [[guiGridListSetVerticalScrollPosition]])
==GuiTabPanel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTabPanel]])
getSelectedTab (function: [[guiGetSelectedTab]])
setSelectedTab (function: [[guiSetSelectedTab]])
==GuiTab==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTab]])
delete (function: [[guiDeleteTab]])
==GuiFont==
''Inherited from [[#Element|Element]]''

create (function: [[guiCreateFont]])
==Resource==
create (function: [[getResourceFromName]])
fromName (function: [[getResourceFromName]])
getGuiElement (function: [[getResourceGUIElement]])
getRootElement (function: [[getResourceRootElement]])
getName (function: [[getResourceName]])
getThis (function: [[getThisResource]])
getConfig (function: [[getResourceConfig]])
getConfig (function: [[getResourceConfig]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getExportedFunctions (function: [[getResourceExportedFunctions]])
getState (function: [[getResourceState]])
==Timer==
create (function: [[setTimer]])
destroy (function: [[killTimer]])
reset (function: [[resetTimer]])
isValid (function: [[isTimer]])
getDetails (function: [[getTimerDetails]])
==File==
create (function: [[fileOpen]])
destroy (function: [[fileClose]])
close (function: [[fileClose]])
new (function: [[fileCreate]])
delete (function: [[fileDelete]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])
copy (function: [[fileCopy]])
==XML==
load (function: [[xmlLoadFile]])
unload (function: [[xmlUnloadFile]])
copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
destroy (function: [[xmlDestroyNode]])
setValue (function: [[xmlNodeGetValue]])
setAttribute (function: [[xmlNodeSetAttribute]])
setValue (function: [[xmlNodeSetValue]])
saveFile (function: [[xmlSaveFile]])
createChild (function: [[xmlCreateChild]])
findChild (function: [[xmlFindChild]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
getAttribute (function: [[xmlNodeGetAttribute]])
setName (function: [[xmlNodeSetName]])
==Camera==
fade (function: [[fadeCamera]])
getTarget (function: [[getCameraTarget]])
getInterior (function: [[getCameraInterior]])
getViewMode (function: [[getCameraViewMode]])
getGoggleEffect (function: [[getCameraGoggleEffect]])
setInterior (function: [[setCameraInterior]])
setTarget (function: [[setCameraTarget]])
setViewMode (function: [[setCameraViewMode]])
setGoggleEffect (function: [[setCameraGoggleEffect]])
setClip (function: [[setCameraClip]])
==Engine==
restoreCOL (function: [[engineRestoreCOL]])
restoreModel (function: [[engineRestoreModel]])
setAsynchronousLoading (function: [[engineSetAsynchronousLoading]])
setModelLODDistance (function: [[engineSetModelLODDistance]])
getVisibleTextureName (function: [[engineGetVisibleTextureNames]])
getModelLODDistance (function: [[engineGetModelLODDistance]])
getModelTextureNames (function: [[engineGetModelTextureNames]])
getModelIDFromName (function: [[engineGetModelIDFromName]])
getModelNameFromID (function: [[engineGetModelNameFromID]])
==EngineCOL==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadCOL]])
replace (function: [[engineReplaceCOL]])
==EngineTXD==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadTXD]])
import (function: [[engineImportTXD]])
==EngineDFF==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadDFF]])
replace (function: [[engineReplaceModel]])
==DxMaterial==
''Inherited from [[#Element|Element]]''

getSize (function: [[dxGetMaterialSize]])
==DxTexture==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateTexture]])
setEdge (function: [[dxSetTextureEdge]])
setPixels (function: [[dxSetTexturePixels]])
getPixels (function: [[dxGetTexturePixels]])
==DxFont==
create (function: [[dxCreateFont]])
getHeight (function: [[dxGetFontHeight]])
getTextWidth (function: [[dxGetTextWidth]])
==DxShader==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateShader]])
setValue (function: [[dxSetShaderValue]])
setTessellation (function: [[dxSetShaderTessellation]])
setTransform (function: [[dxSetShaderTransform]])
value (function: [[dxGetFontHeight]])
==DxScreenSource==
create (function: [[dxCreateScreenSource]])
update (function: [[dxUpdateScreenSource]])
==DxRenderTarget==
create (function: [[dxCreateRenderTarget]])
setAsTarget (function: [[dxSetRenderTarget]])

OOP client

2014-12-05T20:45:58Z

Banex: /* Projectile */

The new OOP in MTA allows for better code organization and readability. This is a list of [[Client_Scripting_Functions|client-side functions]].

''See also: [[OOP]]''

==Element==

areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibleTo (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getBoundingBox (function: [[getElementBoundingBox]])
getByID (function: [[getElementByID]])
getByType (function: [[getElementsByType]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getDistanceFromCentreOfMassToBaseOfModel (function: [[GetElementDistanceFromCentreOfMassToBaseOfModel]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getWithinColShape (function: [[getElementsWithinColShape]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setLowLOD (function: [[setLowLODElement]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setVelocity (function: [[setElementVelocity]])
setVisibleTo (function: [[setElementVisibleTo]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addUpgrade (function: [[addVehicleUpgrade]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAdjustableProperty (function: [[getVehicleAdjustableProperty]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getComponentPosition (function: [[getVehicleComponentPosition]])
getComponentRotation (function: [[getVehicleComponentRotation]])
getComponents (function: [[getVehicleComponents]])
getComponentVisible (function: [[getVehicleComponentVisible]])
getController (function: [[getVehicleController]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getGear (function: [[getVehicleCurrentGear]])
getGravity (function: [[getVehicleGravity]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getHelicopterRotorSpeed (function: [[getHelicopterRotorSpeed]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassengers (function: [[getVehicleMaxPassengers]])
getName (function: [[getVehicleName]])
getNitroCount (function: [[getVehicleNitroCount]])
getNitroLevel (function: [[getVehicleNitroLevel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirens (function: [[getVehicleSirens]])
getSirensOn (function: [[getVehicleSirensOn]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTrainDirection (function: [[getTrainDirection]])
getTrainSpeed (function: [[getTrainSpeed]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isNitroActivated (function: [[isVehicleNitroActivated]])
isNitroRecharging (function: [[isVehicleNitroRecharging]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
isTrainDerailable (function: [[setTrainDerailable]])
isTrainDerailed (function: [[isTrainDerailed]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetComponentPosition (function: [[resetVehicleComponentPosition]])
resetComponentRotation (function: [[resetVehicleComponentRotation]])
setAdjustableProperty (function: [[setVehicleAdjustableProperty]])
setColor (function: [[setVehicleColor]])
setComponentPosition (function: [[setVehicleComponentPosition]])
setComponentRotation (function: [[setVehicleComponentRotation]])
setComponentVisible (function: [[setVehicleComponentVisible]])
setDamageProof (function: [[setVehicleDamageProof]])
setDirtLevel (function: [[setVehicleDirtLevel]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setGravity (function: [[setVehicleGravity]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setHelicopterRotorSpeed (function: [[setHelicopterRotorSpeed]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setNitroActivated (function: [[setVehicleNitroActivated]])
setNitroCount (function: [[setVehicleNitroCount]])
setNitroLevel (function: [[setVehicleNitroLevel]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintjob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTrainDerailable (function: [[setTrainDerailable]])
setTrainDerailed (function: [[setTrainDerailed]])
setTrainDirection (function: [[setTrainDirection]])
setTrainSpeed (function: [[setTrainSpeed]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
canBeKnockedOffBike (function: [[canPedBeKnockedOffBike]])
create (function: [[createPed]])
doesHaveJetPack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getAnimation (function: [[getPedAnimation]])
getAnimationData (function: [[getPedAnimationData]])
getArmor (function: [[getPedArmor]])
getBodyPartName (function: [[getBodyPartName]])
getBonePosition (function: [[getPedBonePosition]])
getCameraRotation (function: [[getPedCameraRotation]])
getClothes (function: [[getPedClothes]])
getClothesByTypeIndex (function: [[getClothesByTypeIndex]])
getClothesTypeName (function: [[getClothesTypeName]])
getContactElement (function: [[getPedContactElement]])
getControlState (function: [[getPedControlState]])
getMoveState (function: [[getPedMoveState]])
getOccupiedVehicle (function: [[GetPedOccupiedVehicle]])
getOxygenLevel (function: [[getPedOxygenLevel]])
getSimplestTask (function: [[getPedSimplestTask]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTargetCollision (function: [[getPedTargetCollision]])
getTargetEnd (function: [[getPedTargetEnd]])
getTargetStart (function: [[getPedTargetStart]])
getTask (function: [[getPedTask]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getTypeIndexFromClothes (function: [[getTypeIndexFromClothes]])
getValidModels (function: [[getValidPedModels]])
getVoice (function: [[getPedVoice]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponMuzzlePosition (function: [[getPedWeaponMuzzlePosition]])
isChocking (function: [[isPedChoking]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDoingTask (function: [[isPedDoingTask]])
isDucked (function: [[isPedDucked]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
isTargetingMarkerEnabled (function: [[isPedTargetingMarkerEnabled]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
setAimTarget (function: [[setPedAimTarget]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setCameraRotation (function: [[setPedCameraRotation]])
setCanBeKnockedOffBike (function: [[setPedCanBeKnockedOffBike]])
setControlState (function: [[setPedControlState]])
setDoingGangDriveby (function: [[setPedDoingGangDriveby]])
setFootBloodEnabled (function: [[setPedFootBloodEnabled]])
setHeadless (function: [[setPedHeadless]])
setLookAt (function: [[setPedLookAt]])
setOnFire (function: [[setPedOnFire]])
setOxygenLevel (function: [[setPedOxygenLevel]])
setTargetingMarkerEnabled (function: [[setPedTargetingMarkerEnabled]])
setVoice (function: [[setPedVoice]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Player==
''Inherited from [[#Ped|Ped]]''

create (function: [[getPlayerFromName]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getMapBoundingBox (function: [[getPlayerMapBoundingBox]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isHudComponentVisible (function: [[isPlayerHudComponentVisible]])
isMapForced (function: [[isPlayerMapForced]])
isMapVisible (function: [[isPlayerMapVisible]])
isNametagShowing (function: [[isPlayerNametagShowing]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setMoney (function: [[setPlayerMoney]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
showHudComponent (function: [[showPlayerHudComponent]])
takeMoney (function: [[takePlayerMoney]])

==Object==
''Inherited from [[#Element|Element]]''

break (function: [[breakObject]])
create (function: [[createObject]])
getMass (function: [[getObjectMass]])
getScale (function: [[getObjectScale]])
isBreakable (function: [[isObjectBreakable]])
move (function: [[moveObject]])
respawn (function: [[respawnObject]])
setBreakable (function: [[setObjectBreakable]])
setMass (function: [[setObjectMass]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])
toggleObjectRespawn (function: [[toggleObjectRespawn]])

==Marker==
''Inherited from [[#Element|Element]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setType (function: [[setPickupType]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==Projectile==
''Inherited from [[#Element|Projectile]]''

create (function: [[createProjectile]])
getCounter (function: [[getProjectileCounter]])
getCreator (function: [[getProjectileCreator]])
getForce (function: [[getProjectileForce]])
getTarget (function: [[getProjectileTarget]])
getType (function: [[getProjectileType]])
setCounter (function: [[setProjectileCounter]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[getTeamFromName]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getLevel (function: [[getWaterLevel]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
isDrawnLast (function: [[isWaterDrawnLast]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setDrawnLast (function: [[setWaterDrawnLast]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])
testLineAgainst (function: [[testLineAgainstWater]])

==Sound==
''Inherited from [[#Element|Element]]''

create (function: [[playSound]])
getBPM (function: [[getSoundBPM]])
getEffects (function: [[getSoundEffects]])
getFFTData (function: [[getSoundFFTData]])
getLength (function: [[getSoundLength]])
getLevelData (function: [[getSoundLevelData]])
getMetaTags (function: [[getSoundMetaTags]])
getPan (function: [[getSoundPan]])
getPlaybackPosition (function: [[getSoundPosition]])
getProperties (function: [[getSoundProperties]])
getSpeed (function: [[getSoundSpeed]])
getVolume (function: [[getSoundVolume]])
getWaveData (function: [[getSoundWaveData]])
isPaused (function: [[isSoundPaused]])
setEffectEnabled (function: [[setSoundEffectEnabled]])
setPan (function: [[setSoundPan]])
setPaused (function: [[setSoundPaused]])
setPlaybackPosition (function: [[setSoundPosition]])
setProperties (function: [[setSoundProperties]])
setSpeed (function: [[setSoundSpeed]])
setVolume (function: [[setSoundVolume]])
stop (function: [[stopSound]])

==Sound3D==
''Inherited from [[#Sound|Sound]]''

create (function: [[playSound3D]])
getMaxDistance (function: [[getSoundMaxDistance]])
getMinDistance (function: [[getSoundMinDistance]])
setMaxDistance (function: [[setSoundMaxDistance]])
setMinDistance (function: [[setSoundMinDistance]])

==Weapon==
''Inherited from [[#Element|Element]]''

create (function: [[createWeapon]])
fire (function: [[fireWeapon]])
getAmmo (function: [[getWeaponAmmo]])
getClipAmmo (function: [[getWeaponClipAmmo]])
getFiringRate (function: [[getWeaponFiringRate]])
getFlags (function: [[getWeaponFlags]])
getOwner (function: [[getWeaponOwner]])
getProperty (function: [[setWeaponProperty]])
getState (function: [[getWeaponState]])
getTarget (function: [[getWeaponTarget]])
resetFiringRate (function: [[resetWeaponFiringRate]])
setAmmo (function: [[setWeaponAmmo]])
setClipAmmo (function: [[setWeaponClipAmmo]])
setFiringRate (function: [[setWeaponFiringRate]])
setFlags (function: [[setWeaponFlags]])
setOwner (function: [[setWeaponOwner]])
setProperty (function: [[setWeaponProperty]])
setState (function: [[setWeaponState]])
setTarget (function: [[setWeaponTarget]])

==Effect==
''Inherited from [[#Element|Element]]''

addBlood (function: [[fxAddBlood]])
addBulletImpact (function: [[fxAddBulletImpact]])
addBulletSplash (function: [[fxAddBulletSplash]])
addDebris (function: [[fxAddDebris]])
addFootSplash (function: [[fxAddFootSplash]])
addGlass (function: [[fxAddGlass]])
addGunshot (function: [[fxAddGunshot]])
addPunchImpact (function: [[fxAddPunchImpact]])
addSparks (function: [[fxAddSparks]])
addTankFire (function: [[fxAddTankFire]])
addTyreBurst (function: [[fxAddTyreBurst]])
addWaterHydrant (function: [[fxAddWaterHydrant]])
addWaterSplash (function: [[fxAddWaterSplash]])
addWood (function: [[fxAddWood]])
create (function: [[createEffect]])
getDensity (function: [[getEffectDensity]])
getSpeed (function: [[getEffectSpeed]])
setDensity (function: [[setEffectDensity]])
setSpeed (function: [[setEffectSpeed]])

==GuiElement==
''Inherited from [[#Element|Element]]''

bringToFront (function: [[guiBringToFront]])
moveToBack (function: [[guiMoveToBack]])
isChatBoxInputActive (function: [[isChatBoxInputActive]])
isConsoleActive (function: [[isConsoleActive]])
isDebugViewActive (function: [[isDebugViewActive]])
isMainMenuActive (function: [[isMainMenuActive]])
isMTAWindowActive (function: [[isMTAWindowActive]])
isTransferBoxActive (function: [[isTransferBoxActive]])
isInputEnabled (function: [[guiGetInputEnabled]])
getInputMode (function: [[guiGetInputMode]])
getScreenSize (function: [[guiGetScreenSize]])
getProperties (function: [[guiGetProperties]])
getAlpha (function: [[guiGetAlpha]])
getFont (function: [[guiGetFont]])
getEnabled (function: [[guiGetEnabled]])
getVisible (function: [[guiGetVisible]])
getText (function: [[guiGetText]])
getPosition (function: [[guiGetPosition]])
getSize (function: [[guiGetSize]])
getProperty (function: [[guiGetProperty]])
setInputEnabled (function: [[guiSetInputEnabled]])
setAlpha (function: [[guiSetAlpha]])
setEnabled (function: [[guiSetEnabled]])
setFont (function: [[guiSetFont]])
setVisible (function: [[guiSetVisible]])
setText (function: [[guiSetText]])
setInputMode (function: [[guiSetInputMode]])
setProperty (function: [[guiSetProperty]])
setPosition (function: [[guiSetPosition]])
setSize (function: [[guiSetSize]])
==GuiWindow==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateWindow]])
setMovable (function: [[guiWindowSetMovable]])
setSizable (function: [[guiWindowSetSizable]])
==GuiButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateButton]])
==GuiEdit==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateEdit]])
getCaretIndex (function: [[guiEditGetCaretIndex]])
setCaretIndex (function: [[guiEditSetCaretIndex]])
setReadOnly (function: [[guiEditSetReadOnly]])
setMasked (function: [[guiEditSetMasked]])
setMaxLength (function: [[guiEditSetMaxLength]])
==GuiLabel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateLabel]])
getFontHeight (function: [[guiLabelGetFontHeight]])
getTextExtent (function: [[guiLabelGetTextExtent]])
getColor (function: [[guiLabelGetColor]])
setColor (function: [[guiLabelSetColor]])
setHorizontalAlign (function: [[guiLabelSetHorizontalAlign]])
setVerticalAlign (function: [[guiLabelSetVerticalAlign]])
==GuiMemo==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateMemo]])
getCaretIndex (function: [[guiMemoGetCaretIndex]])
setCaretIndex (function: [[guiMemoSetCaretIndex]])
setReadOnly (function: [[guiMemoSetReadOnly]])
==GuiStaticImage==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateStaticImage]])
loadImage (function: [[guiStaticImageLoadImage]])
==GuiComboBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateComboBox]])
addItem (function: [[guiComboBoxAddItem]])
clear (function: [[guiComboBoxClear]])
removeItem (function: [[guiComboBoxRemoveItem]])
getSelected (function: [[guiComboBoxGetSelected]])
getItemText (function: [[guiComboBoxGetItemText]])
setItemText (function: [[guiComboBoxSetItemText]])
setSelected (function: [[guiComboBoxSetSelected]])
==GuiCheckBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateCheckBox]])
getSelected (function: [[guiCheckBoxGetSelected]])
setSelected (function: [[guiCheckBoxSetSelected]])
==GuiRadioButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateRadioButton]])
getSelected (function: [[guiRadioButtonGetSelected]])
setSelected (function: [[guiRadioButtonSetSelected]])
==GuiScrollPane==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollPane]])
getHorizontalScrollPosition (function: [[guiScrollPaneGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiScrollPaneGetVerticalScrollPosition]])
setHorizontalScrollPosition (function: [[guiScrollPaneSetHorizontalScrollPosition]])
setScrollBars (function: [[guiScrollPaneSetScrollBars]])
setVerticalScrollPosition (function: [[guiScrollPaneSetVerticalScrollPosition]])
==GuiScrollBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollBar]])
getScrollPosition (function: [[guiScrollBarGetScrollPosition]])
setScrollPosition (function: [[guiScrollBarSetScrollPosition]])
==GuiProgressBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateProgressBar]])
getProgress (function: [[guiProgressBarGetProgress]])
setProgress (function: [[guiProgressBarSetProgress]])
==GuiGridlist==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateGridList]])
addColumn (function: [[guiGridListAddColumn]])
addRow (function: [[guiGridListAddRow]])
autoSizeColumn (function: [[guiGridListAutoSizeColumn]])
clear (function: [[guiGridListClear]])
insertRowAfter (function: [[guiGridListInsertRowAfter]])
removeColumn (function: [[guiGridListRemoveColumn]])
removeRow (function: [[guiGridListRemoveRow]])
getItemData (function: [[guiGridListGetItemData]])
getItemText (function: [[guiGridListGetItemText]])
getRowCount (function: [[guiGridListGetRowCount]])
getSelectedItem (function: [[guiGridListGetSelectedItem]])
getItemColor (function: [[guiGridListGetItemColor]])
getColumnTitle (function: [[guiGridListGetColumnTitle]])
getHorizontalScrollPosition (function: [[guiGridListGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiGridListGetVerticalScrollPosition]])
getSelectedCount (function: [[guiGridListGetSelectedCount]])
getSelectedItems (function: [[guiGridListGetSelectedItems]])
getColumnCount (function: [[guiGridListGetColumnCount]])
setItemData (function: [[guiGridListSetItemData]])
setItemText (function: [[guiGridListSetItemText]])
setScrollBars (function: [[guiGridListSetScrollBars]])
setSelectedItem (function: [[guiGridListSetSelectedItem]])
setSelectionMode (function: [[guiGridListSetSelectionMode]])
setSortingEnabled (function: [[guiGridListSetSortingEnabled]])
setColumnWidth (function: [[guiGridListSetColumnWidth]])
setItemColor (function: [[guiGridListSetItemColor]])
setColumnTitle (function: [[guiGridListSetColumnTitle]])
setHorizontalScrollPosition (function: [[guiGridListSetHorizontalScrollPosition]])
setVerticalScrollPosition (function: [[guiGridListSetVerticalScrollPosition]])
==GuiTabPanel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTabPanel]])
getSelectedTab (function: [[guiGetSelectedTab]])
setSelectedTab (function: [[guiSetSelectedTab]])
==GuiTab==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTab]])
delete (function: [[guiDeleteTab]])
==GuiFont==
''Inherited from [[#Element|Element]]''

create (function: [[guiCreateFont]])
==Resource==
create (function: [[getResourceFromName]])
fromName (function: [[getResourceFromName]])
getGuiElement (function: [[getResourceGUIElement]])
getRootElement (function: [[getResourceRootElement]])
getName (function: [[getResourceName]])
getThis (function: [[getThisResource]])
getConfig (function: [[getResourceConfig]])
getConfig (function: [[getResourceConfig]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getExportedFunctions (function: [[getResourceExportedFunctions]])
getState (function: [[getResourceState]])
==Timer==
create (function: [[setTimer]])
destroy (function: [[killTimer]])
reset (function: [[resetTimer]])
isValid (function: [[isTimer]])
getDetails (function: [[getTimerDetails]])
==File==
create (function: [[fileOpen]])
destroy (function: [[fileClose]])
close (function: [[fileClose]])
new (function: [[fileCreate]])
delete (function: [[fileDelete]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])
copy (function: [[fileCopy]])
==XML==
load (function: [[xmlLoadFile]])
unload (function: [[xmlUnloadFile]])
copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
destroy (function: [[xmlDestroyNode]])
setValue (function: [[xmlNodeGetValue]])
setAttribute (function: [[xmlNodeSetAttribute]])
setValue (function: [[xmlNodeSetValue]])
saveFile (function: [[xmlSaveFile]])
createChild (function: [[xmlCreateChild]])
findChild (function: [[xmlFindChild]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
getAttribute (function: [[xmlNodeGetAttribute]])
setName (function: [[xmlNodeSetName]])
==Camera==
fade (function: [[fadeCamera]])
getTarget (function: [[getCameraTarget]])
getInterior (function: [[getCameraInterior]])
getViewMode (function: [[getCameraViewMode]])
getGoggleEffect (function: [[getCameraGoggleEffect]])
setInterior (function: [[setCameraInterior]])
setTarget (function: [[setCameraTarget]])
setViewMode (function: [[setCameraViewMode]])
setGoggleEffect (function: [[setCameraGoggleEffect]])
setClip (function: [[setCameraClip]])
==Engine==
restoreCOL (function: [[engineRestoreCOL]])
restoreModel (function: [[engineRestoreModel]])
setAsynchronousLoading (function: [[engineSetAsynchronousLoading]])
setModelLODDistance (function: [[engineSetModelLODDistance]])
getVisibleTextureName (function: [[engineGetVisibleTextureNames]])
getModelLODDistance (function: [[engineGetModelLODDistance]])
getModelTextureNames (function: [[engineGetModelTextureNames]])
getModelIDFromName (function: [[engineGetModelIDFromName]])
getModelNameFromID (function: [[engineGetModelNameFromID]])
==EngineCOL==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadCOL]])
replace (function: [[engineReplaceCOL]])
==EngineTXD==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadTXD]])
import (function: [[engineImportTXD]])
==EngineDFF==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadDFF]])
replace (function: [[engineReplaceModel]])
==DxMaterial==
''Inherited from [[#Element|Element]]''

getSize (function: [[dxGetMaterialSize]])
==DxTexture==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateTexture]])
setEdge (function: [[dxSetTextureEdge]])
setPixels (function: [[dxSetTexturePixels]])
getPixels (function: [[dxGetTexturePixels]])
==DxFont==
create (function: [[dxCreateFont]])
getHeight (function: [[dxGetFontHeight]])
getTextWidth (function: [[dxGetTextWidth]])
==DxShader==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateShader]])
setValue (function: [[dxSetShaderValue]])
setTessellation (function: [[dxSetShaderTessellation]])
setTransform (function: [[dxSetShaderTransform]])
value (function: [[dxGetFontHeight]])
==DxScreenSource==
create (function: [[dxCreateScreenSource]])
update (function: [[dxUpdateScreenSource]])
==DxRenderTarget==
create (function: [[dxCreateRenderTarget]])
setAsTarget (function: [[dxSetRenderTarget]])

OOP client

2014-12-05T20:44:30Z

Banex: /* Projectile */

The new OOP in MTA allows for better code organization and readability. This is a list of [[Client_Scripting_Functions|client-side functions]].

''See also: [[OOP]]''

==Element==

areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibleTo (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getBoundingBox (function: [[getElementBoundingBox]])
getByID (function: [[getElementByID]])
getByType (function: [[getElementsByType]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getDistanceFromCentreOfMassToBaseOfModel (function: [[GetElementDistanceFromCentreOfMassToBaseOfModel]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getWithinColShape (function: [[getElementsWithinColShape]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setLowLOD (function: [[setLowLODElement]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setVelocity (function: [[setElementVelocity]])
setVisibleTo (function: [[setElementVisibleTo]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addUpgrade (function: [[addVehicleUpgrade]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAdjustableProperty (function: [[getVehicleAdjustableProperty]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getComponentPosition (function: [[getVehicleComponentPosition]])
getComponentRotation (function: [[getVehicleComponentRotation]])
getComponents (function: [[getVehicleComponents]])
getComponentVisible (function: [[getVehicleComponentVisible]])
getController (function: [[getVehicleController]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getGear (function: [[getVehicleCurrentGear]])
getGravity (function: [[getVehicleGravity]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getHelicopterRotorSpeed (function: [[getHelicopterRotorSpeed]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassengers (function: [[getVehicleMaxPassengers]])
getName (function: [[getVehicleName]])
getNitroCount (function: [[getVehicleNitroCount]])
getNitroLevel (function: [[getVehicleNitroLevel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirens (function: [[getVehicleSirens]])
getSirensOn (function: [[getVehicleSirensOn]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTrainDirection (function: [[getTrainDirection]])
getTrainSpeed (function: [[getTrainSpeed]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isNitroActivated (function: [[isVehicleNitroActivated]])
isNitroRecharging (function: [[isVehicleNitroRecharging]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
isTrainDerailable (function: [[setTrainDerailable]])
isTrainDerailed (function: [[isTrainDerailed]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetComponentPosition (function: [[resetVehicleComponentPosition]])
resetComponentRotation (function: [[resetVehicleComponentRotation]])
setAdjustableProperty (function: [[setVehicleAdjustableProperty]])
setColor (function: [[setVehicleColor]])
setComponentPosition (function: [[setVehicleComponentPosition]])
setComponentRotation (function: [[setVehicleComponentRotation]])
setComponentVisible (function: [[setVehicleComponentVisible]])
setDamageProof (function: [[setVehicleDamageProof]])
setDirtLevel (function: [[setVehicleDirtLevel]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setGravity (function: [[setVehicleGravity]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setHelicopterRotorSpeed (function: [[setHelicopterRotorSpeed]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setNitroActivated (function: [[setVehicleNitroActivated]])
setNitroCount (function: [[setVehicleNitroCount]])
setNitroLevel (function: [[setVehicleNitroLevel]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintjob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTrainDerailable (function: [[setTrainDerailable]])
setTrainDerailed (function: [[setTrainDerailed]])
setTrainDirection (function: [[setTrainDirection]])
setTrainSpeed (function: [[setTrainSpeed]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
canBeKnockedOffBike (function: [[canPedBeKnockedOffBike]])
create (function: [[createPed]])
doesHaveJetPack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getAnimation (function: [[getPedAnimation]])
getAnimationData (function: [[getPedAnimationData]])
getArmor (function: [[getPedArmor]])
getBodyPartName (function: [[getBodyPartName]])
getBonePosition (function: [[getPedBonePosition]])
getCameraRotation (function: [[getPedCameraRotation]])
getClothes (function: [[getPedClothes]])
getClothesByTypeIndex (function: [[getClothesByTypeIndex]])
getClothesTypeName (function: [[getClothesTypeName]])
getContactElement (function: [[getPedContactElement]])
getControlState (function: [[getPedControlState]])
getMoveState (function: [[getPedMoveState]])
getOccupiedVehicle (function: [[GetPedOccupiedVehicle]])
getOxygenLevel (function: [[getPedOxygenLevel]])
getSimplestTask (function: [[getPedSimplestTask]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTargetCollision (function: [[getPedTargetCollision]])
getTargetEnd (function: [[getPedTargetEnd]])
getTargetStart (function: [[getPedTargetStart]])
getTask (function: [[getPedTask]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getTypeIndexFromClothes (function: [[getTypeIndexFromClothes]])
getValidModels (function: [[getValidPedModels]])
getVoice (function: [[getPedVoice]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponMuzzlePosition (function: [[getPedWeaponMuzzlePosition]])
isChocking (function: [[isPedChoking]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDoingTask (function: [[isPedDoingTask]])
isDucked (function: [[isPedDucked]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
isTargetingMarkerEnabled (function: [[isPedTargetingMarkerEnabled]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
setAimTarget (function: [[setPedAimTarget]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setCameraRotation (function: [[setPedCameraRotation]])
setCanBeKnockedOffBike (function: [[setPedCanBeKnockedOffBike]])
setControlState (function: [[setPedControlState]])
setDoingGangDriveby (function: [[setPedDoingGangDriveby]])
setFootBloodEnabled (function: [[setPedFootBloodEnabled]])
setHeadless (function: [[setPedHeadless]])
setLookAt (function: [[setPedLookAt]])
setOnFire (function: [[setPedOnFire]])
setOxygenLevel (function: [[setPedOxygenLevel]])
setTargetingMarkerEnabled (function: [[setPedTargetingMarkerEnabled]])
setVoice (function: [[setPedVoice]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Player==
''Inherited from [[#Ped|Ped]]''

create (function: [[getPlayerFromName]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getMapBoundingBox (function: [[getPlayerMapBoundingBox]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isHudComponentVisible (function: [[isPlayerHudComponentVisible]])
isMapForced (function: [[isPlayerMapForced]])
isMapVisible (function: [[isPlayerMapVisible]])
isNametagShowing (function: [[isPlayerNametagShowing]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setMoney (function: [[setPlayerMoney]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
showHudComponent (function: [[showPlayerHudComponent]])
takeMoney (function: [[takePlayerMoney]])

==Object==
''Inherited from [[#Element|Element]]''

break (function: [[breakObject]])
create (function: [[createObject]])
getMass (function: [[getObjectMass]])
getScale (function: [[getObjectScale]])
isBreakable (function: [[isObjectBreakable]])
move (function: [[moveObject]])
respawn (function: [[respawnObject]])
setBreakable (function: [[setObjectBreakable]])
setMass (function: [[setObjectMass]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])
toggleObjectRespawn (function: [[toggleObjectRespawn]])

==Marker==
''Inherited from [[#Element|Element]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setType (function: [[setPickupType]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==Projectile==
''Inherited from [[#Element|projectile]]''

create (function: [[createProjectile]])
getCounter (function: [[getProjectileCounter]])
getCreator (function: [[getProjectileCreator]])
getForce (function: [[getProjectileForce]])
getTarget (function: [[getProjectileTarget]])
getType (function: [[getProjectileType]])
setCounter (function: [[setProjectileCounter]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[getTeamFromName]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getLevel (function: [[getWaterLevel]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
isDrawnLast (function: [[isWaterDrawnLast]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setDrawnLast (function: [[setWaterDrawnLast]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])
testLineAgainst (function: [[testLineAgainstWater]])

==Sound==
''Inherited from [[#Element|Element]]''

create (function: [[playSound]])
getBPM (function: [[getSoundBPM]])
getEffects (function: [[getSoundEffects]])
getFFTData (function: [[getSoundFFTData]])
getLength (function: [[getSoundLength]])
getLevelData (function: [[getSoundLevelData]])
getMetaTags (function: [[getSoundMetaTags]])
getPan (function: [[getSoundPan]])
getPlaybackPosition (function: [[getSoundPosition]])
getProperties (function: [[getSoundProperties]])
getSpeed (function: [[getSoundSpeed]])
getVolume (function: [[getSoundVolume]])
getWaveData (function: [[getSoundWaveData]])
isPaused (function: [[isSoundPaused]])
setEffectEnabled (function: [[setSoundEffectEnabled]])
setPan (function: [[setSoundPan]])
setPaused (function: [[setSoundPaused]])
setPlaybackPosition (function: [[setSoundPosition]])
setProperties (function: [[setSoundProperties]])
setSpeed (function: [[setSoundSpeed]])
setVolume (function: [[setSoundVolume]])
stop (function: [[stopSound]])

==Sound3D==
''Inherited from [[#Sound|Sound]]''

create (function: [[playSound3D]])
getMaxDistance (function: [[getSoundMaxDistance]])
getMinDistance (function: [[getSoundMinDistance]])
setMaxDistance (function: [[setSoundMaxDistance]])
setMinDistance (function: [[setSoundMinDistance]])

==Weapon==
''Inherited from [[#Element|Element]]''

create (function: [[createWeapon]])
fire (function: [[fireWeapon]])
getAmmo (function: [[getWeaponAmmo]])
getClipAmmo (function: [[getWeaponClipAmmo]])
getFiringRate (function: [[getWeaponFiringRate]])
getFlags (function: [[getWeaponFlags]])
getOwner (function: [[getWeaponOwner]])
getProperty (function: [[setWeaponProperty]])
getState (function: [[getWeaponState]])
getTarget (function: [[getWeaponTarget]])
resetFiringRate (function: [[resetWeaponFiringRate]])
setAmmo (function: [[setWeaponAmmo]])
setClipAmmo (function: [[setWeaponClipAmmo]])
setFiringRate (function: [[setWeaponFiringRate]])
setFlags (function: [[setWeaponFlags]])
setOwner (function: [[setWeaponOwner]])
setProperty (function: [[setWeaponProperty]])
setState (function: [[setWeaponState]])
setTarget (function: [[setWeaponTarget]])

==Effect==
''Inherited from [[#Element|Element]]''

addBlood (function: [[fxAddBlood]])
addBulletImpact (function: [[fxAddBulletImpact]])
addBulletSplash (function: [[fxAddBulletSplash]])
addDebris (function: [[fxAddDebris]])
addFootSplash (function: [[fxAddFootSplash]])
addGlass (function: [[fxAddGlass]])
addGunshot (function: [[fxAddGunshot]])
addPunchImpact (function: [[fxAddPunchImpact]])
addSparks (function: [[fxAddSparks]])
addTankFire (function: [[fxAddTankFire]])
addTyreBurst (function: [[fxAddTyreBurst]])
addWaterHydrant (function: [[fxAddWaterHydrant]])
addWaterSplash (function: [[fxAddWaterSplash]])
addWood (function: [[fxAddWood]])
create (function: [[createEffect]])
getDensity (function: [[getEffectDensity]])
getSpeed (function: [[getEffectSpeed]])
setDensity (function: [[setEffectDensity]])
setSpeed (function: [[setEffectSpeed]])

==GuiElement==
''Inherited from [[#Element|Element]]''

bringToFront (function: [[guiBringToFront]])
moveToBack (function: [[guiMoveToBack]])
isChatBoxInputActive (function: [[isChatBoxInputActive]])
isConsoleActive (function: [[isConsoleActive]])
isDebugViewActive (function: [[isDebugViewActive]])
isMainMenuActive (function: [[isMainMenuActive]])
isMTAWindowActive (function: [[isMTAWindowActive]])
isTransferBoxActive (function: [[isTransferBoxActive]])
isInputEnabled (function: [[guiGetInputEnabled]])
getInputMode (function: [[guiGetInputMode]])
getScreenSize (function: [[guiGetScreenSize]])
getProperties (function: [[guiGetProperties]])
getAlpha (function: [[guiGetAlpha]])
getFont (function: [[guiGetFont]])
getEnabled (function: [[guiGetEnabled]])
getVisible (function: [[guiGetVisible]])
getText (function: [[guiGetText]])
getPosition (function: [[guiGetPosition]])
getSize (function: [[guiGetSize]])
getProperty (function: [[guiGetProperty]])
setInputEnabled (function: [[guiSetInputEnabled]])
setAlpha (function: [[guiSetAlpha]])
setEnabled (function: [[guiSetEnabled]])
setFont (function: [[guiSetFont]])
setVisible (function: [[guiSetVisible]])
setText (function: [[guiSetText]])
setInputMode (function: [[guiSetInputMode]])
setProperty (function: [[guiSetProperty]])
setPosition (function: [[guiSetPosition]])
setSize (function: [[guiSetSize]])
==GuiWindow==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateWindow]])
setMovable (function: [[guiWindowSetMovable]])
setSizable (function: [[guiWindowSetSizable]])
==GuiButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateButton]])
==GuiEdit==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateEdit]])
getCaretIndex (function: [[guiEditGetCaretIndex]])
setCaretIndex (function: [[guiEditSetCaretIndex]])
setReadOnly (function: [[guiEditSetReadOnly]])
setMasked (function: [[guiEditSetMasked]])
setMaxLength (function: [[guiEditSetMaxLength]])
==GuiLabel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateLabel]])
getFontHeight (function: [[guiLabelGetFontHeight]])
getTextExtent (function: [[guiLabelGetTextExtent]])
getColor (function: [[guiLabelGetColor]])
setColor (function: [[guiLabelSetColor]])
setHorizontalAlign (function: [[guiLabelSetHorizontalAlign]])
setVerticalAlign (function: [[guiLabelSetVerticalAlign]])
==GuiMemo==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateMemo]])
getCaretIndex (function: [[guiMemoGetCaretIndex]])
setCaretIndex (function: [[guiMemoSetCaretIndex]])
setReadOnly (function: [[guiMemoSetReadOnly]])
==GuiStaticImage==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateStaticImage]])
loadImage (function: [[guiStaticImageLoadImage]])
==GuiComboBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateComboBox]])
addItem (function: [[guiComboBoxAddItem]])
clear (function: [[guiComboBoxClear]])
removeItem (function: [[guiComboBoxRemoveItem]])
getSelected (function: [[guiComboBoxGetSelected]])
getItemText (function: [[guiComboBoxGetItemText]])
setItemText (function: [[guiComboBoxSetItemText]])
setSelected (function: [[guiComboBoxSetSelected]])
==GuiCheckBox==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateCheckBox]])
getSelected (function: [[guiCheckBoxGetSelected]])
setSelected (function: [[guiCheckBoxSetSelected]])
==GuiRadioButton==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateRadioButton]])
getSelected (function: [[guiRadioButtonGetSelected]])
setSelected (function: [[guiRadioButtonSetSelected]])
==GuiScrollPane==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollPane]])
getHorizontalScrollPosition (function: [[guiScrollPaneGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiScrollPaneGetVerticalScrollPosition]])
setHorizontalScrollPosition (function: [[guiScrollPaneSetHorizontalScrollPosition]])
setScrollBars (function: [[guiScrollPaneSetScrollBars]])
setVerticalScrollPosition (function: [[guiScrollPaneSetVerticalScrollPosition]])
==GuiScrollBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateScrollBar]])
getScrollPosition (function: [[guiScrollBarGetScrollPosition]])
setScrollPosition (function: [[guiScrollBarSetScrollPosition]])
==GuiProgressBar==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateProgressBar]])
getProgress (function: [[guiProgressBarGetProgress]])
setProgress (function: [[guiProgressBarSetProgress]])
==GuiGridlist==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateGridList]])
addColumn (function: [[guiGridListAddColumn]])
addRow (function: [[guiGridListAddRow]])
autoSizeColumn (function: [[guiGridListAutoSizeColumn]])
clear (function: [[guiGridListClear]])
insertRowAfter (function: [[guiGridListInsertRowAfter]])
removeColumn (function: [[guiGridListRemoveColumn]])
removeRow (function: [[guiGridListRemoveRow]])
getItemData (function: [[guiGridListGetItemData]])
getItemText (function: [[guiGridListGetItemText]])
getRowCount (function: [[guiGridListGetRowCount]])
getSelectedItem (function: [[guiGridListGetSelectedItem]])
getItemColor (function: [[guiGridListGetItemColor]])
getColumnTitle (function: [[guiGridListGetColumnTitle]])
getHorizontalScrollPosition (function: [[guiGridListGetHorizontalScrollPosition]])
getVerticalScrollPosition (function: [[guiGridListGetVerticalScrollPosition]])
getSelectedCount (function: [[guiGridListGetSelectedCount]])
getSelectedItems (function: [[guiGridListGetSelectedItems]])
getColumnCount (function: [[guiGridListGetColumnCount]])
setItemData (function: [[guiGridListSetItemData]])
setItemText (function: [[guiGridListSetItemText]])
setScrollBars (function: [[guiGridListSetScrollBars]])
setSelectedItem (function: [[guiGridListSetSelectedItem]])
setSelectionMode (function: [[guiGridListSetSelectionMode]])
setSortingEnabled (function: [[guiGridListSetSortingEnabled]])
setColumnWidth (function: [[guiGridListSetColumnWidth]])
setItemColor (function: [[guiGridListSetItemColor]])
setColumnTitle (function: [[guiGridListSetColumnTitle]])
setHorizontalScrollPosition (function: [[guiGridListSetHorizontalScrollPosition]])
setVerticalScrollPosition (function: [[guiGridListSetVerticalScrollPosition]])
==GuiTabPanel==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTabPanel]])
getSelectedTab (function: [[guiGetSelectedTab]])
setSelectedTab (function: [[guiSetSelectedTab]])
==GuiTab==
''Inherited from [[#GuiElement|GuiElement]]''

create (function: [[guiCreateTab]])
delete (function: [[guiDeleteTab]])
==GuiFont==
''Inherited from [[#Element|Element]]''

create (function: [[guiCreateFont]])
==Resource==
create (function: [[getResourceFromName]])
fromName (function: [[getResourceFromName]])
getGuiElement (function: [[getResourceGUIElement]])
getRootElement (function: [[getResourceRootElement]])
getName (function: [[getResourceName]])
getThis (function: [[getThisResource]])
getConfig (function: [[getResourceConfig]])
getConfig (function: [[getResourceConfig]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getExportedFunctions (function: [[getResourceExportedFunctions]])
getState (function: [[getResourceState]])
==Timer==
create (function: [[setTimer]])
destroy (function: [[killTimer]])
reset (function: [[resetTimer]])
isValid (function: [[isTimer]])
getDetails (function: [[getTimerDetails]])
==File==
create (function: [[fileOpen]])
destroy (function: [[fileClose]])
close (function: [[fileClose]])
new (function: [[fileCreate]])
delete (function: [[fileDelete]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])
copy (function: [[fileCopy]])
==XML==
load (function: [[xmlLoadFile]])
unload (function: [[xmlUnloadFile]])
copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
destroy (function: [[xmlDestroyNode]])
setValue (function: [[xmlNodeGetValue]])
setAttribute (function: [[xmlNodeSetAttribute]])
setValue (function: [[xmlNodeSetValue]])
saveFile (function: [[xmlSaveFile]])
createChild (function: [[xmlCreateChild]])
findChild (function: [[xmlFindChild]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
getAttribute (function: [[xmlNodeGetAttribute]])
setName (function: [[xmlNodeSetName]])
==Camera==
fade (function: [[fadeCamera]])
getTarget (function: [[getCameraTarget]])
getInterior (function: [[getCameraInterior]])
getViewMode (function: [[getCameraViewMode]])
getGoggleEffect (function: [[getCameraGoggleEffect]])
setInterior (function: [[setCameraInterior]])
setTarget (function: [[setCameraTarget]])
setViewMode (function: [[setCameraViewMode]])
setGoggleEffect (function: [[setCameraGoggleEffect]])
setClip (function: [[setCameraClip]])
==Engine==
restoreCOL (function: [[engineRestoreCOL]])
restoreModel (function: [[engineRestoreModel]])
setAsynchronousLoading (function: [[engineSetAsynchronousLoading]])
setModelLODDistance (function: [[engineSetModelLODDistance]])
getVisibleTextureName (function: [[engineGetVisibleTextureNames]])
getModelLODDistance (function: [[engineGetModelLODDistance]])
getModelTextureNames (function: [[engineGetModelTextureNames]])
getModelIDFromName (function: [[engineGetModelIDFromName]])
getModelNameFromID (function: [[engineGetModelNameFromID]])
==EngineCOL==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadCOL]])
replace (function: [[engineReplaceCOL]])
==EngineTXD==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadTXD]])
import (function: [[engineImportTXD]])
==EngineDFF==
''Inherited from [[#Element|Element]]''

create (function: [[engineLoadDFF]])
replace (function: [[engineReplaceModel]])
==DxMaterial==
''Inherited from [[#Element|Element]]''

getSize (function: [[dxGetMaterialSize]])
==DxTexture==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateTexture]])
setEdge (function: [[dxSetTextureEdge]])
setPixels (function: [[dxSetTexturePixels]])
getPixels (function: [[dxGetTexturePixels]])
==DxFont==
create (function: [[dxCreateFont]])
getHeight (function: [[dxGetFontHeight]])
getTextWidth (function: [[dxGetTextWidth]])
==DxShader==
''Inherited from [[#DxMaterial|DxMaterial]]''

create (function: [[dxCreateShader]])
setValue (function: [[dxSetShaderValue]])
setTessellation (function: [[dxSetShaderTessellation]])
setTransform (function: [[dxSetShaderTransform]])
value (function: [[dxGetFontHeight]])
==DxScreenSource==
create (function: [[dxCreateScreenSource]])
update (function: [[dxUpdateScreenSource]])
==DxRenderTarget==
create (function: [[dxCreateRenderTarget]])
setAsTarget (function: [[dxSetRenderTarget]])

GetElementDistanceFromCentreOfMassToBaseOfModel

2014-12-05T20:40:28Z

Banex: /* Syntax */

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

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

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

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

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

SetElementVisibleTo

2014-12-05T20:38:30Z

Banex: /* Syntax */

__NOTOC__
{{Server function}}
{{Needs_Checking|Can an element only be visible to one element (and its children) at a time? If so, do we need clearElementVisibleTo? If not, surely we need to remove the root element before using this function?|[[User:EAi|EAi]]
}}

This function can change an [[element]]'s [[visibility]]. This does not work with all entities - [[vehicle]]s, [[player]]s and [[object]]s are exempt. This is because these objects are required for accurate sync (they're physical objects that contribute to the physics engine). This function is particularly useful for changing the visibility of markers, radar blips and radar areas.

Visibility settings of lower elements in the element tree override higher ones - if visibility for root is set to false and for a player is set to true, it will be visible to the player.

If you want to clear all visibility settings of an object, try [[clearElementVisibleTo]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:setVisibleTo}}

===Required Arguments===
*'''theElement:''' The element you want to control the visibility of.
*'''visibleTo:''' The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See [[visibility]].
*'''visible:''' Whether you are making it visible or invisible to the player.

===Returns===
Returns ''true'' if the element's visibility was changed successfully, ''false'' otherwise, for example if you are trying to change the visibility of a vehicle, player or object.

==Example==
This example creates a marker and makes it only visibile to the player called 'someguy'.
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
-- Set marker visibility to true for someguy
setElementVisibleTo ( myMarker, someguy, true )
-- Then make the marker invisible to the whole dimension
setElementVisibleTo ( myMarker, root, false )

-- The order in which you do the visibility changes does not matter, but ideally trues should be set before falses in order to prevent a momentary flicker.
end
</syntaxhighlight>

The following example shows how to make the marker visible to everyone except anotherguy
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
local anotherguy = getPlayerFromName ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
attachElements(myMarker, someguy)

-- First make sure everyone is able to see the marker, this line is unnecessary in this case as root visibility is set to true by default behaviour
setElementVisibleTo ( myMarker, root, true )

-- Then hide it from anotherguy
setElementVisibleTo ( myMarker, anotherguy, false )
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

GetElementBoundingBox

2014-12-05T20:37:13Z

Banex: /* Syntax */

{{Client function}}
__NOTOC__
This function returns the minimum and maximum coordinates of an element's bounding box.

It should be noted that the values returned are relative to the position of the element, and as such if you wish to get world coordinates for drawing, et etcetera, you should retrieve the position of the element and add the returned values onto that.

'''Note:''' The element must be streamed in for this function to work.

==Syntax==
<syntaxhighlight lang="lua">
float float float float float float getElementBoundingBox ( element theElement )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getBoundingBox}}

===Required Arguments===
'''theElement:''' the element whose bounding box we want to get.

===Returns===
*Returns ''min x, min y, min z, max x, max y, max z'' if the passed element is valid and streamed in, ''false'' otherwise.

==Example==
This example outputs to chatbox the minimum and the maximum coordinates of an element.
<syntaxhighlight lang="lua">
function minMaxOutput ( theElement )
local x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( theElement )
if ( x0 ) then
outputChatBox ( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
else
outputChatBox ( "Failed to retrieve bounding box" )
end
end
</syntaxhighlight>

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

SetLowLODElement

2014-12-05T20:30:37Z

Banex: /* Syntax */

__NOTOC__
{{Server client function}}
This function assigns a low LOD element to an element. The low LOD element is displayed when its associated element is not fully visible. If a low LOD element is assigned to several elements, it will be displayed when any of these elements are not fully visible.

==Syntax==
<syntaxhighlight lang="lua">
bool setLowLODElement ( element theElement, element lowLODElement )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:setLowLOD}}
===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD version we want to change.
*'''lowLODElement :''' A low LOD element to display when the first element is not fully visible.

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

==Example==
===Example 1===
<section name="Clientside" class="client" show="true">
This example shows how to create and link a normal and low LOD object:
<syntaxhighlight lang="lua">
-- Create an normal object
objNormal = createObject ( 3620, x,y,z,0,0,0 )

-- Create a low LOD object
objLowLOD = createObject ( 5154, x,y,z,0,0,0,true )

-- Set the normal object low LOD version
setLowLODElement ( objNormal, objLowLOD )

-- Set the draw distance for the model we are using for low LOD to maximum
engineSetModelLODDistance ( 5154, 300 )
</syntaxhighlight>
</section>
===Example 2===
<section name="Serverside" class="server" show="true">
This example shows how to create and link a composite object
<syntaxhighlight lang="lua">
-- Create composite object
objMainBit = createObject ( 3620, x,y,z )
objLeftBit = createObject ( 5158, x,y,z )
objRightBit = createObject ( 5158, x,y,z )
objDetailBit1 = createObject ( 1337, x,y,z )
objDetailBit2 = createObject ( 1337, x,y,z )
objInternalBit = createObject ( 1337, x,y,z )
attachElements ( objLeftBit, objMainBit, -10, 0, 0 )
attachElements ( objRightBit, objMainBit, 10, 0, 0 )
attachElements ( objDetailBit1, objMainBit, 5, 0, 0 )
attachElements ( objDetailBit2, objLeftBit, 5, 5, 0 )
attachElements ( objInternalBit, objRightBit, 5, 7, 0 )

-- Create low LOD object (which represents the whole composite model)
objlowLOD = createObject ( 5154, x,y,z, 0, 0, 0, true )

-- Attach low LOD object so it moves with the main model
attachElements ( objlowLOD, objMainBit, 0, 0, 0 )

-- Set associations so the low LOD model is displayed when the main parts are not full visible
setLowLODElement ( objMainBit, objlowLOD )
setLowLODElement ( objLeftBit, objlowLOD )
setLowLODElement ( objRightBit, objlowLOD )

-- Note that the detail and internal parts have not been associated to the low LOD object

-- Set the draw distance for the model we are using for low LOD to maximum
triggerClientEvent("onClientChangeModelLODDistance", resourceRoot, 5154, 300 )
</syntaxhighlight>
</section>
<section name="Clientside" class="client" show="true">
Changing the draw distance for a model has to done on the client:
<syntaxhighlight lang="lua">
addEvent("onClientChangeModelLODDistance",true)
addEventHandler("onClientChangeModelLODDistance", resourceRoot,
function(model,distance)
engineSetModelLODDistance ( model, distance )
end
)
</syntaxhighlight>
</section>
==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

PT-BR/Novidades na versão 1.4.0

2014-12-05T20:27:40Z

Banex: /* Correções de bugs e mudanças */

{{PT-BR/Changelogs}}

== Principais Mudanças ==
* Tradução para os menus do MTA
* Classes [[OOP]]
* [[Matrix|Matrizes]] e [[Vector|Vetores]]
* Melhorou muito a sincronização de trens
* As funções relacionadas a áudio agora são compatíveis com os elementos do tipo jogador

== Scripting ==

=== Novas Funções ===

====Cliente====
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]
* [[getLocalization]]
* [[isChatVisible]]
* [[downloadFile]]
* [[isTrainChainEngine]]

==== Servidor ====
* [[isBan]]
* [[setBanAdmin]]
* [[setBanReason]]
* [[setUnbanTime]]
* [[getAccountsBySerial]]
* [[getAccountSerial]]

==== Compartilhados (Cliente e Servidor) ====
* Adicionado um parâmetro bInstant para setPlayerMoney a fim de definir o montante de dinheiro instantaneamente, sem aparecer a contagem/descontagem no HUD
* toJSON/fromJSON agora lida melhor com dados binários

=== Novos Eventos ===

==== Cliente ====
* [[onClientFileDownloadComplete]]

==== Servidor ====
* [[onWeaponFire]]

=== Mudanças, correções de bugs ===
* getResourceConfig() funciona para recursos adicionados posteriormente a inicialização do servidor
* Corrigido o bug do veiculo (ID: 570)
* attachTrailerToVehicle agora suporta trens

== Cliente ==

=== Novidades ===
* Distinção entre Shift, Ctrl e Alt esquerdo/direito
* Adicionados os parâmetros SettingHUDMatchAspectRatio, SettingAspectRatio para [[dxGetStatus]]
* Suporte de arquivos de áudio usando o [https://en.wikipedia.org/wiki/Opus_codec Opus Codec] nas funções playSound e playSound3D

=== Correções de bugs e mudanças ===
* Foram corrigidos as ocasiões:
** Corrigido o efeito do dinheiro "contagem regressiva" quando você muda de servidor.
** Os pedestres ficam invencíveis a tiros quando estão no banco de passageiro.
** O evento onClientPlayerDamage não ativar para a lata de spray.
** Satchels não são removidas com [[resetMapInfo]].
** getPedMoveState retornar falso quando o jogador estiver se movendo agachado
** guiScrollPaneGetVerticalScrollPosition retornar valores estranhos
** setPedCameraRotation não funcionar as vezes.
** Pedestres continuarem atirando depois de sua munição ter acabado.
** Títulos de rádio não aparecerem as vezes.
** As músicas da rádio serem puladas quando se estiver passando entre as estações.
** A função para pular uma faixa de áudio (F5) não funcionar.
** Veículos caírem de repente pelo mapa.

== Servidor ==

=== Novidades ===
* [[setElementDimension]] deve agora fazer efeito para elementos subordinados
* Erros de módulo estão mais explicados nas mensagens
* Novos comandos: unloadmodule e reloadmodule
* Adicionadas armas customizadas para o lado do servidor.

=== Correções de bugs e mudanças ===
* Agora há um limite de 128 caracteres para a função [[setAccountData]].
* Jogadores com nomes contendo caracteres especiais são verificados de forma correta ao conectar.
* Corrigidos os membros de times não serem enviados ao cliente se forem definidos pela função [[onResourceStart]].

== Resources ==
* Nada até agora

== Editor ==
* Nada até agora

== Informações Extras ==
''Informações mais detalhadas estão disponíveis em nosso Changelog do [https://bugs.multitheftauto.com/changelog_page.php Bug tracker] e no Google Code:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[en:Changes_in_1.4.0]]
[[pl:Changes_in_1.4]]
[[ru:Changes_in_1.4.0]]

[[Category:Changes_in_1.4]]
[[Category:Incomplete]]

PT-BR/Novidades na versão 1.4.0

2014-12-05T20:20:08Z

Banex: /* Mudanças, correções de bugs */

{{PT-BR/Changelogs}}

== Principais Mudanças ==
* Tradução para os menus do MTA
* Classes [[OOP]]
* [[Matrix|Matrizes]] e [[Vector|Vetores]]
* Melhorou muito a sincronização de trens
* As funções relacionadas a áudio agora são compatíveis com os elementos do tipo jogador

== Scripting ==

=== Novas Funções ===

====Cliente====
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]
* [[getLocalization]]
* [[isChatVisible]]
* [[downloadFile]]
* [[isTrainChainEngine]]

==== Servidor ====
* [[isBan]]
* [[setBanAdmin]]
* [[setBanReason]]
* [[setUnbanTime]]
* [[getAccountsBySerial]]
* [[getAccountSerial]]

==== Compartilhados (Cliente e Servidor) ====
* Adicionado um parâmetro bInstant para setPlayerMoney a fim de definir o montante de dinheiro instantaneamente, sem aparecer a contagem/descontagem no HUD
* toJSON/fromJSON agora lida melhor com dados binários

=== Novos Eventos ===

==== Cliente ====
* [[onClientFileDownloadComplete]]

==== Servidor ====
* [[onWeaponFire]]

=== Mudanças, correções de bugs ===
* getResourceConfig() funciona para recursos adicionados posteriormente a inicialização do servidor
* Corrigido o bug do veiculo (ID: 570)
* attachTrailerToVehicle agora suporta trens

== Cliente ==

=== Novidades ===
* Distinção entre Shift, Ctrl e Alt esquerdo/direito
* Adicionados os parâmetros SettingHUDMatchAspectRatio, SettingAspectRatio para [[dxGetStatus]]
* Suporte de arquivos de áudio usando o [https://en.wikipedia.org/wiki/Opus_codec Opus Codec] nas funções playSound e playSound3D

=== Correções de bugs e mudanças ===
* Foram corrigidos as ocasiões:
** O dinheiro é "drenado" no GTA quando se muda de servidor.
** Os pedestres ficam invencíveis a tiros quando estão no banco de passageiro.
** O evento onClientPlayerDamage não ativar para a lata de spray.
** Satchels não são removidas com [[resetMapInfo]].
** getPedMoveState retornar falso quando o jogador estiver se movendo agachado
** guiScrollPaneGetVerticalScrollPosition retornar valores estranhos
** setPedCameraRotation não funcionar as vezes.
** Pedestres continuarem atirando depois de sua munição ter acabado.
** Títulos de rádio não aparecerem as vezes.
** As músicas da rádio serem puladas quando se estiver passando entre as estações.
** A função para pular uma faixa de áudio (F5) não funcionar.
** Veículos caírem de repente pelo mapa.

== Servidor ==

=== Novidades ===
* [[setElementDimension]] deve agora fazer efeito para elementos subordinados
* Erros de módulo estão mais explicados nas mensagens
* Novos comandos: unloadmodule e reloadmodule
* Adicionadas armas customizadas para o lado do servidor.

=== Correções de bugs e mudanças ===
* Agora há um limite de 128 caracteres para a função [[setAccountData]].
* Jogadores com nomes contendo caracteres especiais são verificados de forma correta ao conectar.
* Corrigidos os membros de times não serem enviados ao cliente se forem definidos pela função [[onResourceStart]].

== Resources ==
* Nada até agora

== Editor ==
* Nada até agora

== Informações Extras ==
''Informações mais detalhadas estão disponíveis em nosso Changelog do [https://bugs.multitheftauto.com/changelog_page.php Bug tracker] e no Google Code:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[en:Changes_in_1.4.0]]
[[pl:Changes_in_1.4]]
[[ru:Changes_in_1.4.0]]

[[Category:Changes_in_1.4]]
[[Category:Incomplete]]

GetPedTargetEnd

2014-12-05T18:30:49Z

Banex: /* Syntax */

__NOTOC__
{{Client function}}
This function allows retrieval of the position where a ped's target range ends, when he is aiming with a weapon.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetEnd ( ped targetingPed )
</syntaxhighlight>
{{OOP||[[ped]]:getTargetEnd}}

===Required Arguments===
*'''targetingPed:''' the ped who is targeting whose target end you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target ends according to his range, or ''false'' if it was unsuccessful.

==Example==
This Example draws a line from where the Ped´s Target Starts to the Point where the Target Ends
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender", root, -- Adds the Handler
function ()
if getPedTargetStart(localPlayer) then --Checks if there is a Point to start From.

local x, y, z = getPedTargetStart(localPlayer) -- Gets the Point to start From
local sx, sy, sz = getPedTargetEnd(localPlayer) -- Gets the Point where the Target Ends

dxDrawLine3D(x, y, z, sx, sy, sz) -- Draws the Line
end
end
)
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

GetPedTargetEnd

2014-12-05T18:29:51Z

Banex: /* Syntax */

__NOTOC__
{{Client function}}
This function allows retrieval of the position where a ped's target range ends, when he is aiming with a weapon.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetEnd ( ped targetingPed )
</syntaxhighlight>
{{OOP||[[ped]]:getTargetEnd|XeoNFeio}}

===Required Arguments===
*'''targetingPed:''' the ped who is targeting whose target end you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target ends according to his range, or ''false'' if it was unsuccessful.

==Example==
This Example draws a line from where the Ped´s Target Starts to the Point where the Target Ends
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender", root, -- Adds the Handler
function ()
if getPedTargetStart(localPlayer) then --Checks if there is a Point to start From.

local x, y, z = getPedTargetStart(localPlayer) -- Gets the Point to start From
local sx, sy, sz = getPedTargetEnd(localPlayer) -- Gets the Point where the Target Ends

dxDrawLine3D(x, y, z, sx, sy, sz) -- Draws the Line
end
end
)
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

GetPedTargetEnd

2014-12-05T18:13:32Z

Banex: /* Syntax */

PT-BR/Novidades na versão 1.4.0

2014-12-05T17:15:14Z

Banex: /* Correções de bugs e mudanças */

{{PT-BR/Changelogs}}

== Principais Mudanças ==
* Tradução para os menus do MTA
* Classes [[OOP]]
* [[Matrix|Matrizes]] e [[Vector|Vetores]]
* Melhorou muito a sincronização de trens
* As funções relacionadas a áudio agora são compatíveis com os elementos do tipo jogador

== Scripting ==

=== Novas Funções ===

====Cliente====
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]
* [[getLocalization]]
* [[isChatVisible]]
* [[downloadFile]]
* [[isTrainChainEngine]]

==== Servidor ====
* [[isBan]]
* [[setBanAdmin]]
* [[setBanReason]]
* [[setUnbanTime]]
* [[getAccountsBySerial]]
* [[getAccountSerial]]

==== Compartilhados (Cliente e Servidor) ====
* Adicionado um parâmetro bInstant para setPlayerMoney a fim de definir o montante de dinheiro instantaneamente, sem aparecer a contagem/descontagem no HUD
* toJSON/fromJSON agora lida melhor com dados binários

=== Novos Eventos ===

==== Cliente ====
* [[onClientFileDownloadComplete]]

==== Servidor ====
* [[onWeaponFire]]

=== Mudanças, correções de bugs ===
* getResourceConfig() funciona para recursos adicionados posteriormente a inicialização do servidor
* Consertado o veículo de ID 570
* attachTrailerToVehicle agora suporta trens

== Cliente ==

=== Novidades ===
* Distinção entre Shift, Ctrl e Alt esquerdo/direito
* Adicionados os parâmetros SettingHUDMatchAspectRatio, SettingAspectRatio para [[dxGetStatus]]
* Suporte de arquivos de áudio usando o [https://en.wikipedia.org/wiki/Opus_codec Opus Codec] nas funções playSound e playSound3D

=== Correções de bugs e mudanças ===
* Foram corrigidos as ocasiões:
** O dinheiro é "drenado" no GTA quando se muda de servidor.
** Os pedestres ficam invencíveis a tiros quando estão no banco de passageiro.
** O evento onClientPlayerDamage não ativar para a lata de spray.
** Satchels não são removidas com [[resetMapInfo]].
** getPedMoveState retornar falso quando o jogador estiver se movendo agachado
** guiScrollPaneGetVerticalScrollPosition retornar valores estranhos
** setPedCameraRotation não funcionar as vezes.
** Pedestres continuarem atirando depois de sua munição ter acabado.
** Títulos de rádio não aparecerem as vezes.
** As músicas da rádio serem puladas quando se estiver passando entre as estações.
** A função para pular uma faixa de áudio (F5) não funcionar.
** Veículos caírem de repente pelo mapa.

== Servidor ==

=== Novidades ===
* [[setElementDimension]] deve agora fazer efeito para elementos subordinados
* Erros de módulo estão mais explicados nas mensagens
* Novos comandos: unloadmodule e reloadmodule
* Adicionadas armas customizadas para o lado do servidor.

=== Correções de bugs e mudanças ===
* Agora há um limite de 128 caracteres para a função [[setAccountData]].
* Jogadores com nomes contendo caracteres especiais são verificados de forma correta ao conectar.
* Corrigidos os membros de times não serem enviados ao cliente se forem definidos pela função [[onResourceStart]].

== Resources ==
* Nada até agora

== Editor ==
* Nada até agora

== Informações Extras ==
''Informações mais detalhadas estão disponíveis em nosso Changelog do [https://bugs.multitheftauto.com/changelog_page.php Bug tracker] e no Google Code:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

[[en:Changes_in_1.4.0]]
[[pl:Changes_in_1.4]]
[[ru:Changes_in_1.4.0]]

[[Category:Changes_in_1.4]]
[[Category:Incomplete]]