Multi Theft Auto: Wiki - User contributions [en]

SetVehicleHandling

2020-06-17T05:59:22Z

X86dev: /* Example */

{{Server client function}}
__NOTOC__
This function is used to change the handling data of a vehicle.

{{New feature/item|3.0156|1.5.5|12009|Implemented also for client-sided vehicles.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, var value )
</syntaxhighlight>

Syntaxes for reset configurations:
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, nil, false ) -- Reset one property to model handling value
bool setVehicleHandling ( element theVehicle, string property, nil, true ) -- Reset one property to GTA default value
bool setVehicleHandling ( element theVehicle, false ) -- Reset all properties to model handling value
bool setVehicleHandling ( element theVehicle, true ) -- Reset all properties to GTA default value
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to set the handling of.
*'''property:''' The property you wish to set the handling of the vehicle to.

{{Note|For functionality reasons suspension modification is disabled on monster trucks, trains, boats and trailers.}}
{{Handling Properties}}
*'''value:''' The value of the property you wish to set the handling of the vehicle to.

===Returns===
Returns ''true'' if the handling was set successfully, ''false'' otherwise. See below a list of valid properties and their required values:

==Example==
This example will make Infernus handling very fast and also make it damage proof from collision (handling by Mr.unpredictable).
this example will help you in creating your own vehicle Handling.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function vhandling ( theVehicle )
if getElementModel(theVehicle) == 411 then -------------- vehicle Id
setVehicleHandling(theVehicle, "mass", 300.0)
setVehicleHandling(theVehicle, "turnMass", 200)
setVehicleHandling(theVehicle, "dragCoeff", 4.0 )
setVehicleHandling(theVehicle, "centerOfMass", { 0.0,0.08,-0.09 } )
setVehicleHandling(theVehicle, "percentSubmerged", 103)
setVehicleHandling(theVehicle, "tractionMultiplier", 1.8)
setVehicleHandling(theVehicle, "tractionLoss", 1.0)
setVehicleHandling(theVehicle, "tractionBias", 0.48)
setVehicleHandling(theVehicle, "numberOfGears", 5)
setVehicleHandling(theVehicle, "maxVelocity", 300.0)
setVehicleHandling(theVehicle, "engineAcceleration", 90.0 )
setVehicleHandling(theVehicle, "engineInertia", 5.0)
setVehicleHandling(theVehicle, "driveType", "rwd")
setVehicleHandling(theVehicle, "engineType", "petrol")
setVehicleHandling(theVehicle, "brakeDeceleration", 20.0)
setVehicleHandling(theVehicle, "brakeBias", 0.60)
-----abs----
setVehicleHandling(theVehicle, "steeringLock", 35.0 )
setVehicleHandling(theVehicle, "suspensionForceLevel", 0.85)
setVehicleHandling(theVehicle, "suspensionDamping", 0.15 )
setVehicleHandling(theVehicle, "suspensionHighSpeedDamping", 0.0)
setVehicleHandling(theVehicle, "suspensionUpperLimit", 0.15 )
setVehicleHandling(theVehicle, "suspensionLowerLimit", -0.16)
setVehicleHandling(theVehicle, "suspensionFrontRearBias", 0.5 )
setVehicleHandling(theVehicle, "suspensionAntiDiveMultiplier", 0.0)
setVehicleHandling(theVehicle, "seatOffsetDistance", 0.0)
setVehicleHandling(theVehicle, "collisionDamageMultiplier", 0.00)
--setVehicleHandling(theVehicle, "monetary", 10000) This one is disabled for now
setVehicleHandling(theVehicle, "modelFlags", 1002000)
setVehicleHandling(theVehicle, "handlingFlags", 1000002)
--setVehicleHandling(theVehicle, "headLight", 3) This one is disabled for now
--setVehicleHandling(theVehicle, "tailLight", 2) This one is disabled for now
--setVehicleHandling(theVehicle, "animGroup", 4) This one is disabled for now
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), vhandling )
</syntaxhighlight></section>

This example will add a command for players with which they can change the mass of the vehicle.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function massChange ( me, command, mass )
local mass = tonumber ( mass ) -- Convert mass to a number
local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

if mass and veh then -- If valid mass and in a vehicle
local success = setVehicleHandling ( veh, "mass", mass) -- Set the vehicle's mass, and check if successful

if success then -- If successful
outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
else -- Too bad failure is still an option
outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
end
elseif not veh then -- If not in a vehicle
outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
elseif not mass then -- If not a valid mass
outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
end
end
addCommandHandler ( "changemass", massChange )
</syntaxhighlight></section>

This example will apply custom handling as defined for each specific vehicle (ID) in below table
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local predefinedHandling = {
[411] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[415] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[562] = { -- Universal drift handling
["driveType"] = "rwd",
["engineAcceleration"] = 200,
["dragCoeff"] = 1.5,
["maxVelocity"] = 300,
["tractionMultiplier"] = 0.7,
["tractionLoss"] = 0.8,
["collisionDamageMultiplier"] = 0.4,
["engineInertia"] = -175,
["steeringLock"] = 75,
["numberOfGears"] = 4,
["suspensionForceLevel"] = 0.8,
["suspensionDamping"] = 0.8,
["suspensionUpperLimit"] = 0.33,
["suspensionFrontRearBias"] = 0.3,
["mass"] = 1800,
["turnMass"] = 3000,
["centerOfMass"] = { [1]=0, [2]=-0.2, [3]=-0.5 }, -- Good example to understand centerOfMass parameter usage
},

--next model below etc (copy rows)
}

for i,v in pairs (predefinedHandling) do
if i then
for handling, value in pairs (v) do
if not setModelHandling (i, handling, value) then
outputDebugString ("* Predefined handling '"..tostring(handling).."' for vehicle model '"..tostring(i).."' could not be set to '"..tostring(value).."'")
end
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v and predefinedHandling[getElementModel(v)] then
for k,vl in pairs (predefinedHandling[getElementModel(v)]) do
setVehicleHandling (v, k, vl)
end
end
end

function resetHandling()
for model in pairs (predefinedHandling) do
if model then
for k in pairs(getOriginalHandling(model)) do
setModelHandling(model, k, nil)
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v then
local model = getElementModel(v)
if predefinedHandling[model] then
for k,h in pairs(getOriginalHandling(model)) do
setVehicleHandling(v, k, h)
end
end
end
end
end
addEventHandler("onResourceStop", resourceRoot, resetHandling)
</syntaxhighlight></section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12009|Added for vehicles created on client-side.}}

==See other vehicle functions==
{{Vehicle functions}}

SetGarageOpen

2014-04-24T11:31:28Z

X86dev:

__NOTOC__
{{Server client function}}
This function opens or closes the specified garage door in the world.
{{Note|setGarageOpen does not work with ID 32 (Pay 'n' Spray near Royal Casino). This garage doesn't work in SP too. You can remove this gate by [[removeWorldModel]] and recreate them for later using with moveObject.}}
==Syntax==
<syntaxhighlight lang="lua">
bool setGarageOpen ( int garageID, bool open )
</syntaxhighlight>

===Required Arguments===
*'''garageID:''' The [[Garage|garage ID]] that represents the garage door being opened or closed.
*'''isOpen:''' A boolean indicating whether or not to open the door.

===Returns===
Returns ''true'' if successful, ''false'' if an invalid garage id was given.

==Example==
<section name="Server" class="server" show="true">
This example opens a garage door when a player enters a collision shape near it, and closes it when they leave:
<syntaxhighlight lang="lua">
GARAGE_ID = 25

-- create a collision shape and attach event handlers to it when the resource starts
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()),
function (resource)
local garageCube = createColCuboid(1337, 194, 28, 6, 10, 4)
addEventHandler("onColShapeHit", garageCube, onGarageCubeHit)
addEventHandler("onColShapeLeave", garageCube, onGarageCubeLeave)
end)

-- open the door when someone enters the garage's collision shape
function onGarageCubeHit(hitElement, matchingDimension)
if (getElementType(hitElement) == "player") then
-- check to make sure the door is closed
if (not isGarageOpen(GARAGE_ID)) then
-- open the door
setGarageOpen(GARAGE_ID, true)
end
end
end

-- close the door when someone leaves the garage's collision shape
function onGarageCubeLeave(leaveElement, matchingDimension)
if (getElementType(leaveElement) == "player") then
-- check to make sure the door is open
if (isGarageOpen(GARAGE_ID)) then
-- close the door
setGarageOpen(GARAGE_ID, false)
end
end
end
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setGarageOpen]]

DestroyElement

2014-01-29T08:24:37Z

X86dev: Undo revision 38671 by Thecoolser (talk)

__NOTOC__
{{Server client function}}
This function destroys an [[element]] and all elements within it in the hierarchy (its children, the children of those children etc). [[player|Player]] elements cannot be destroyed using this function. A player can only be removed from the hierarchy when they quit or are kicked. The root element also cannot be destroyed, however, passing the root as an argument will wipe all elements from the server, except for the players and clients, which will become direct descendants of the root node, and other elements that cannot be destroyed, such as resource root elements.

Players are not the only elements that cannot be deleted. This list also includes remote clients and console elements.
{{Note|As element ids are eventually recycled, always make sure you nil variables containing the element after calling this function}}

==Syntax==
<syntaxhighlight lang="lua">
bool destroyElement ( element elementToDestroy )
</syntaxhighlight>

===Required Arguments===
*'''elementToDestroy:''' The element you wish to destroy.

===Returns===
Returns ''true'' if the element was destroyed successfully, ''false'' if either the element passed to it was invalid or it could not be destroyed for some other reason (for example, clientside destroyElement can't destroy serverside elements).

==Example==
'''Example 1:''' This example would destroy every element in the map, with the exception of players and the root element itself.
<syntaxhighlight lang="lua">
-- Find the root element (the element that contains all others)
root = getRootElement ()
-- Destroy all its children, except players.
destroyElement ( root )
</syntaxhighlight>

'''Example 2:''' This example destroys all vehicles of the specified model:
<syntaxhighlight lang="lua">
function destroyVehiclesOfModel(modelID)
-- get a table of all the vehicles that exist and loop through it
local vehicles = getElementsByType("vehicle")
for i,v in ipairs(vehicles) do
-- if the vehicle's ID is the one provided, destroy it
if (getElementModel(v) == modelID) then
destroyElement(v)
end
end
end

destroyVehiclesOfModel(445)
</syntaxhighlight>

'''Example 3:''' This example allows creation of claymores, which trigger and explode. When they explode, the colshape and object for the claymore are destroyed.
<syntaxhighlight lang="lua">function createClaymore ( x,y,z, creator )
local claymoreObject = createObject ( 1945, x, y, z - 1, 0, 0, 90 ) -- create an object which looks like a claymore
local claymoreCol = createColSphere ( x, y, z, 1 ) -- create a col sphere with radius 1
setElementData ( claymoreCol, "object", claymoreObject ) -- store the object of the claymore
setElementData ( claymoreCol, "creatorPlayer", creator ) -- store the person who created it
addEventHandler ( "onColShapeHit", claymoreCol, claymoreHit ) -- add an event handler to the colshape
end

function claymoreHit ( thePlayer, matchingDimension )
-- retrieve the object associated to the claymore, and who created it
local claymoreObject = getElementData ( source, "object" )
local claymoreCreator = getElementData ( source, "creatorPlayer" )
-- get the position of the claymore
local x,y,z = getElementPosition ( source )
createExplosion ( x,y,z, 12, claymoreCreator ) -- create an explosion, associated to the creator, of a small size at the col's position
-- remove the event handler for the colshape
removeEventHandler ( "onColShapeHit", source, claymoreHit )
-- destroy the claymore object, and the col shape so it doesn't trigger again.
destroyElement ( claymoreObject )
destroyElement ( source )
end
</syntaxhighlight>
'''Example 4:''' This example destroys all vehicles, regardless of ID, name, etc:
<syntaxhighlight lang="lua">
function allvehiclesaredoomed()
-- get a table of all the vehicles that exist and loop through it
vehicles = getElementsByType("vehicle")
for i,v in ipairs(vehicles) do
-- destroy every vehicle.
destroyElement(v)
end
end
--The command handler below will destroy all vehicles once
--you enter /vdoom in the chat box or vdoom in the game console.
addCommandHandler("vdoom", allvehiclesaredoomed)
--This is very useful if you use the freeroam resource and some
--heartless players start spawn spamming.
--You can also set it on a timer to have your server clear all
--vehicles ever 60 minutes, (1 hour). Timer below:
setTimer(allvehiclesaredoomed, 3600000, 0)
</syntaxhighlight>

==See Also==
{{Element functions}}

File talk:Res loader sys.png

2013-11-28T12:39:49Z

X86dev:

Can you re-make this in Microsoft Visio ? Thanks.

-- Sure, when I come back home (in the evening). [[User:The GTA|The GTA]]

Nice! Keep up the good work! --[[User:X86dev|X86dev]] 12:39, 28 November 2013 (UTC)

File talk:Res loader sys.png

2013-11-28T08:04:06Z

X86dev: Created page with "Can you re-make this in Microsoft Visio ? Thanks."

Can you re-make this in Microsoft Visio ? Thanks.

SetCameraClip

2013-11-27T07:36:04Z

X86dev:

{{Client function}}
__NOTOC__
This function sets if the camera will "collide" with any objects or vehicles in its way. This means that if object clip is enabled an object is in the way of where the camera actually wants to be, the camera will try to be in front of it. This function can disable that.

'''Note:''' This function doesn't fix the issue of camera clip not working on objects out of world bounds.

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraClip ( [ bool objects = true, bool vehicles = true ] )
</syntaxhighlight>

===Optional Arguments===
*'''objects:''' Sets if you want the camera to clip on objects.
*'''vehicles:''' Sets if you want the camera to clip on vehicles.

===Returns===
Always returns ''true''.

==Example==
<section name="Client" class="client" show="true">
This function enables it to look though cars
<syntaxhighlight lang="lua">
function enableCameraThoughCars ()
setCameraClip (true,false)
outputChatBox ("Your camera can see the vehicle interior now!",255,0,0,false)
end
addEventHandler ("onClientResourceStart",getResourceRootElement(getThisResource()),enableCameraThoughCars)
</syntaxhighlight>
</section>

==See Also==
{{Client camera functions}}

SetElementData

2013-11-06T08:28:42Z

X86dev:

{{Server client function}}
__NOTOC__
This function stores [[element data]] under a certain key, attached to an element. Element data set using this is then synced with all clients or the server. As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.

{{Tip|A simple and efficient way to make a variable known to the server and clients is to use setElementData on the [[root]] element.}}
{{Note|See [[Script security]] for tips on preventing cheaters when using events and element data}}

==Syntax==

<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you wish to attach the data to.
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.)
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server (client-side variation) and remote clients (both variations).

===Returns===
Returns ''true'' if the data was set succesfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example allows a player to add a custom tag onto their nickname, and also reverts it back to normal if they wish.
<syntaxhighlight lang="lua">
function addPlayerCustomTag ( thePlayer, command, newTag )
--Let's make sure the newTag param has been entered...
if ( newTag ) then
--Grab their current playername for saving.
local sPlayerNickname = getPlayerName ( thePlayer )
--Create their new nickname with their tag
local sNewPlayerNickname = newTag .. " " .. sPlayerNickname

--Let's first load the element data, see if it's there already
--The reason for this is that if a player were to do /addtag twice,
--the tag would be prepended a second time
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick == false ) then
--Save their orignal nickname in their element data
setElementData ( thePlayer, "tempdata.originalnick", sPlayerNickname )
end

--Set their new nickname globally
setPlayerName ( thePlayer, sNewPlayerNickname )

--Tell them it's done
outputChatBox ( "Your new nickname has been set, to put it back to its original state you can use /deltag", thePlayer )
else
--The newTag param was not entered, give an error message
outputChatBox ( "/addtag - Incorrect syntax, Correct: /addtag <newtag>", thePlayer )
end
end
addCommandHandler ( "addtag", addPlayerCustomTag )

function removePlayerCustomTag ( thePlayer, command )
--We first need to check that they have already used /addtag, let's do that now
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick ) then
--Great, they have a tag added, let's reset them

--First we will want to reset the element data back to its default (that being false)
setElementData ( thePlayer, "tempdata.originalnick", false )

--Now set the client name back
setPlayerName( thePlayer, sOldNick )

--Notify them
outputChatBox ( "Your old nickname has been set", thePlayer )
end
end
addCommandHandler ( "deltag", removePlayerCustomTag )
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}

User talk:Qaisjp

2013-11-04T12:48:19Z

X86dev: Created page with "Please use the wiki guidelines defined here: https://wiki.multitheftauto.com/wiki/Category:MTA_Wiki:Editing --~~~~"

Please use the wiki guidelines defined here: https://wiki.multitheftauto.com/wiki/Category:MTA_Wiki:Editing --[[User:X86dev|X86dev]] 12:48, 4 November 2013 (UTC)

Client Scripting Functions

2013-10-10T06:33:42Z

X86dev: Undo revision 37285 by آحمد آلعلَي (talk)

<pageclass class="client"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''client-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

For more functions, check the [[Useful_Functions|useful functions page]].
__TOC__

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Camera functions==
{{Client_camera_functions}}

==Clothes and body functions==
{{Client_Clothes and body functions}}

==Collision shape functions==
{{Client_collision_shape_functions}}

==Cursor functions==
{{Client_cursor_functions}}

==Drawing functions==
{{Drawing_functions}}

==Effects functions==
{{Client_Effects_functions}}

==Element functions==
{{Client_element_functions}}

==Engine functions==
{{Engine_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==File functions==
{{Client file functions}}

==Fire functions==
{{Client fire functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Client_input_functions}}

==Marker functions==
{{Client_marker_functions}}

==Object functions==
{{Client_object_functions}}

==Output functions==
{{Client_output_functions}}

==Ped functions==
{{Client_ped_functions}}

==Pickup functions==
{{Client_pickup_functions}}

==Player functions==
{{Client_player_functions}}

==Projectile functions==
{{Client_projectile_functions}}

==Radar-area functions==
{{Client_radar-area_functions}}

==Resource functions==
{{Client_resource_functions}}

==Serial functions==
{{Client_serial_functions}}

==Team functions==
{{Client_team_functions}}

==Utility functions==
{{Client_utility_functions}}

==Vehicle functions==
{{Client_vehicle_functions}}

==Water functions==
{{Client_water_functions}}

==Weapon functions==
{{Client_weapon_functions}}

==Weapon Creation functions==
Documentation can be found [http://code.google.com/p/mtasa-blue/source/detail?r=4555 here] and [http://code.google.com/p/mtasa-blue/source/detail?r=4557 here]
{{Client_weapon_creation_functions}}

==World functions==
{{Client_world_functions}}

==XML functions==
{{Client XML functions}}

[[pl:Funkcje po stronie klienta]]
[[it:Funzioni Client-side]]
[[ru:Client Scripting Functions]]
[[de:Clientseitige_Funktionen]]
[[tr:Client Taraflı Fonksiyonlar]]

Meta.xml

2013-10-01T08:20:15Z

X86dev:

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".

**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data (default).
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop/>''' todo.
**'''false:''' todo.
**'''true:''' todo.
}}

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#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"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>

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

<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:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

User talk:Quit key

2013-09-26T13:36:41Z

X86dev: Blanked the page

User talk:Ahmet Yılmaz

2013-09-15T18:07:14Z

X86dev: Blanked the page

SetHeliBladeCollisionsEnabled

2013-09-13T09:07:34Z

X86dev: /* Oops ... */

__NOTOC__
{{Server client function}}
This function changes the state of the helicopter blades collisions on the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setHeliBladeCollisionsEnabled ( vehicle theVehicle, bool collisions )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that will have the sirens set.
*'''collisions:''' The state of the helicopter blades collisions.

===Returns===
Returns ''true'' if the collisions are set for the specified vehicle, ''false'' if the collisions can't be set for the specified vehicle, if the vehicle is not a helicopter or if invalid arguments are specified.

==Example==
<section name="Server" class="server" show="true">
This example disables blades collisions when a player enters a helicopter as a driver.
<syntaxhighlight lang="lua">
function onVehicleEnter ( thePlayer, seat, jacked )
--If the player entered a helicopter
if ( getVehicleType ( source ) == "Helicopter" ) then
--If the player entered as a driver
if ( seat == 0 ) then
-- Turn off collisions
setHeliBladeCollisionsEnabled ( source, false )
end
end
end
addEventHandler ( "onVehicleEnter", root, onVehicleEnter )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

SetHeliBladeCollisionsEnabled

2013-09-13T09:07:14Z

X86dev: /* Fixed example as it should be */

__NOTOC__
{{Server client function}}
This function changes the state of the helicopter blades collisions on the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setHeliBladeCollisionsEnabled ( vehicle theVehicle, bool collisions )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that will have the sirens set.
*'''collisions:''' The state of the helicopter blades collisions.

===Returns===
Returns ''true'' if the collisions are set for the specified vehicle, ''false'' if the collisions can't be set for the specified vehicle, if the vehicle is not a helicopter or if invalid arguments are specified.

==Example==
<section name="Server" class="server" show="true">
This example disables blades collisions when a player enters a helicopter as a driver.
<syntaxhighlight lang="lua">
function onVehicleEnter ( thePlayer, seat, jacked )
--If the player entered a helicopter
if ( getVehicleType ( source ) == "Helicopter" ) then
--If the player entered as a driver
if ( seat == 0 ) then
-- Turn off collisions
setHeliBladeCollisionsEnabled( source, true )
end
end
end
addEventHandler ( "onVehicleEnter", root, onVehicleEnter )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

SetHeliBladeCollisionsEnabled

2013-09-13T09:04:14Z

X86dev:

__NOTOC__
{{Server client function}}
This function changes the state of the helicopter blades collisions on the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setHeliBladeCollisionsEnabled ( vehicle theVehicle , bool collisions )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that will have the sirens set.
*'''collisions:''' The state of the helicopter blades collisions.

===Returns===
Returns ''true'' if the collisions are set for the specified vehicle, ''false'' if the collisions can't be set for the specified vehicle, if the vehicle is not a helicopter or if invalid arguments are specified.

==Example==
<section name="Server" class="server" show="true">
This example disables blades collisions when a player enters a helicopter as a driver.
<syntaxhighlight lang="lua">
function onVehicleEnter ( thePlayer, seat, jacked )
--If the player entered a helicopter
if ( table.find({425,487,488,497,563,447,469},getElementModel(source)) ) then
--If the player entered as a driver
if ( seat == 0 ) then
--If blade collisions were off
if not getHeliBladeCollisionsEnabled( source ) then
setHeliBladeCollisionsEnabled( source, true )
else
setHeliBladeCollisionsEnabled( source, false )
end
end
end
end
addEventHandler ( "onVehicleEnter", root, onVehicleEnter )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

GetPedAnimation

2013-09-12T07:01:02Z

X86dev:

__NOTOC__
{{Client function}}

Gets the animation of a player or ped that was set using [[setPedAnimation]].

''Note: Use [[getPedTask]] to monitor what movements the player is currently doing.''

==Syntax==
<syntaxhighlight lang="lua">
string string getPedAnimation ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to get the animation of.

===Returns===
Returns two ''strings'': the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.

==Example==
This example adds a command that allows you to copy the animation being used by another player using /copyanim theirName
<syntaxhighlight lang="lua">
function CopyAnimation(theCommand, thePlayer) -- The Command Function
if thePlayer then -- If a player name entered then
thePlayerToCopyFrom = getPlayerFromName(thePlayer) -- get player from his name
Block, Anim = getPedAnimation(thePlayerToCopyFrom) -- get the player animation
if Block then -- if got the animation successfully then
setPedAnimation(localPlayer, Block, Anim) -- set my animation the same
outputChatBox("* Copied Successfully !") -- output chat message
end
else
outputChatBox("* Please Enter a Player Name To Copy From !") -- if you didnt entered a player name , then output a chat box message
end
end
addCommandHandler("copyanim", CopyAnimation) -- adding the Command Handler
</syntaxhighlight>

==Example 2==

This example shows what block and animation your player is currently performing. Note this will return "N/A" if you did not set an animation with [[setPedAnimation]]. If you want to see what the player ped is doing as you control them that is [[getPedTask]].
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender",root,
function ()
local block, animation = getPedAnimation(localPlayer)
dxDrawText ( "CURRENT ANIMATION INFO...", 100, 300 )
if not block then block = "N/A" end
if not animation then animation = "N/A" end
dxDrawText ( "Block = "..block.." Animation = "..animation, 100, 315 )
end )
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

Changes in 1.3.4

2013-09-12T06:59:24Z

X86dev:

{{Changelogs}}

== Main Additions / Changes ==
* Added "shared" export type in meta.xml
* Added Lua source encryption option
* Added the ability to cancel onClientKey
* Added escape to onClientKey (can't be cancelled twice in a row)
* Added SettingHUDMatchAspectRatio, SettingAspectRatio to dxGetStatus

=== Client ===

----

==== New Functions ====
* Added [[playSFX]]
* Added [[playSFX3D]]
* Added [[getSFXStatus]]
* Added [[setHeliBladeCollisionsEnabled]]
* Added [[getHeliBladeCollisionsEnabled]]
* Added [[getEventHandlers]]

==== New Events ====

==== Changes / Bug Fixes ====
* Fixed vehicle upgrades
* Fixed warpPedIntoVehicle causing desync when two players try to enter at the same time via vehicle_enter and warpPedIntoVehicle
* Fixed map editor crash
* Fixed debug filename for compiled scripts
* Fixed applying weapon mods may remove your weapon
* Fixed crash when streaming in tec-9 with a replaced weapon model
* Fixed console(F8) input focus begin lost sometimes
* Fixed building removal crashing after loading/unloading a model 16 times
* Fixed projectile-type weapons messing up ammo count
* Fixed guiCreateFont fails each second time resource is started
* Fixed client ammo desync when using giveWeapon sometimes
* Fixed guiLabelGetTextExtent not working with unicode
* Fixed onColShapeHit isn't triggered for towed vehicles server side
* Fixed GUI scrollpanes and scrollbars don't trigger onClientMouseEnter/Leave
* Fixed warpPedIntoVehicle after cancelEvent() of onVehicleStartEnter causes network trouble
* Fixed onPedWasted not triggered, when ped died because the vehicle he was in, exploded
* Fixed server createColPolygon
* Fixed a crash when destroying an object in onClientColShapeHit / onClientElementColShapeHit
* Fixed lightweight sync packet being misread on the client sometimes
* Fixed getLatentEventHandles sometimes returning false instead of an empty table
* Fixed setAccountData clips the digits after the decimal point
* Fixed peds/players being removed from vehicles that fall through the ground

=== Server ===

----

==== New Functions ====

==== New Events ====

==== Changes / Bug Fixes ====

=== Resources ===
* Added sfxbrowser resource
* Fixed instant reload exploits for the reload resource
* Fixed 'Use LODs' option in the map editor resource
* Fixed various things in admin, acpanel, freeroam, parachute and race resources

=== Editor ===

==Extra information==
''More detailed information available on [https://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* MTA:SA: from [https://code.google.com/p/mtasa-blue/source/list?num=25&start=5609 r5593] to [https://code.google.com/p/mtasa-blue/source/list?num=25&start=5800 r5800]
:* Resources: [https://code.google.com/p/mtasa-resources/source/list?num=25&start=955 from r938 to r955]
:* [https://forum.mtasa.com/viewtopic.php?f=31&t=64990 MTASA 1.3.4 released]

[[Category:Changelog]]
[[Category:Incomplete]]

Talk:AddAccount

2013-09-04T06:58:02Z

X86dev:

=== Password length limit ===
Password's maxlength is 30 characters. If you try more, function will return ''false'' (while '''addaccount''' command returns ''syntax error'').

PS: I just tried to store md5 hash, but everytime it failed (hash length - 32 chars). -- [[User:Leonardo|Leonardo]] 06:08, 4 September 2013 (UTC)

You shouldn't use a md5 hash, passwords should be sent plaintext. They are being encrypted automaticly. --[[User:X86dev|X86dev]] 06:58, 4 September 2013 (UTC)

Template:Client audio functions

2013-08-27T11:47:51Z

X86dev:

*[[playSoundFrontEnd]]
*[[getRadioChannel]]
*[[getRadioChannelName]]
*[[getSoundEffects]]
*[[getSoundLength]]
*[[getSoundMaxDistance]]
*[[getSoundMetaTags]]
*[[getSoundMinDistance]]
*[[getSoundPosition]]
*[[getSoundSpeed]]
*[[getSoundVolume]]
*[[setSoundEffectEnabled]]
*[[isSoundPaused]]
*[[playSound]]
*[[playSound3D]]
{{New feature/item|3.0134|1.3.4|5731|
*[[playSFX]]
*[[playSFX3D]]
}}
*[[setRadioChannel]]
*[[setSoundMaxDistance]]
*[[setSoundMinDistance]]
*[[setSoundPaused]]
*[[setSoundPosition]]
*[[setSoundSpeed]]
*[[setSoundVolume]]
*[[stopSound]]
*[[getSoundBPM]]
*[[getSoundProperties]]
*[[setSoundProperties]]
*[[getSoundFFTData]]
*[[getSoundWaveData]]
*[[getSoundLevelData]]
*[[setSoundPan]]
*[[getSoundPan]]
<noinclude>[[Category:Functions templates]]</noinclude>

XmlSaveFile

2013-08-26T10:41:46Z

X86dev:

__NOTOC__
{{Server client function}}
This function saves a loaded XML file.

==Syntax==
<syntaxhighlight lang="lua">bool xmlSaveFile ( xmlnode rootNode ) </syntaxhighlight>

===Required Arguments===
*'''rootNode:''' the root [[xmlnode]] of the loaded XML file.

===Returns===
Returns ''true'' if save was successful, ''false'' if the XML file does not exist.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to use the command 'createfile' to create an .xml file.
<syntaxhighlight lang="lua">
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild".
function createFileHandler()
local RootNode = xmlCreateFile("new.xml"," newroot")
local NewNode = xmlCreateChild(RootNode, "newchild")
xmlSaveFile(RootNode)
end

addCommandHandler("createfile", createFileHandler)
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}

SetElementVisibleTo

2013-08-26T07:56:12Z

X86dev:

__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). 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>

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

PlaySFX

2013-08-22T07:05:25Z

X86dev:

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound from GTA's big sound containers.
}}

{{Note|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]}}
{{Warning|Many players use versions of GTA:SA (especially WareZ versions) which haven't any audio files in their ''AUDIO\SFX\'' folder. In case of missing audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX ( string containerName, int bankId, int soundId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
*'''bankId:''' The audio bank Id
*'''soundId:''' The sound Id within the audio bank

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped

==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
The following example plays a firealarm sound (looped).
<syntaxhighlight lang="lua">
if not playSFX("script", 7, 1, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

PlaySFX

2013-08-22T07:05:08Z

X86dev:

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound from GTA's big sound containers.
}}

{{Note|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]}}
{{Warning|Many players use versions of GTA:SA (especially WareZ versions) which haven't any audio files in their ''AUDIO\SFX\'' folder. In case of missing audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX ( string containerName, int bankId, int soundId [, looped = false] )
</syntaxhighlight>

===Required Arguments===
*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
*'''bankId:''' The audio bank Id
*'''soundId:''' The sound Id within the audio bank

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped

==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
The following example plays a firealarm sound (looped).
<syntaxhighlight lang="lua">
if not playSFX("script", 7, 1, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

PlaySFX

2013-08-22T07:04:52Z

X86dev:

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound from GTA's big sound containers.
}}

{{Note|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]}}
{{Warning|Many players use versions of GTA:SA (especially WareZ versions) which haven't any audio files in their ''AUDIO\SFX\'' folder. In case of missing audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
sound playSFX ( string containerName, int bankId, int soundId [, looped = false] )
</syntaxhighlight>

===Required Arguments===
*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
*'''bankId:''' The audio bank Id
*'''soundId:''' The sound Id within the audio bank

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped

==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
The following example plays a firealarm sound (looped).
<syntaxhighlight lang="lua">
if not playSFX("script", 7, 1, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

Meta.xml

2013-08-21T08:43:00Z

X86dev:

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".

**'''validate:''' If set to "false", compatibility checks are skipped.
{{New items|3.0134|1.3.4 r5731|
**'''shared:''' hey, todo!.
}}
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data (default).
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop/>''' todo.
**'''false:''' todo.
**'''true:''' todo.
}}

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#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"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>

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

<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:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

Template:Client audio functions

2013-08-21T08:27:57Z

X86dev:

*[[playSoundFrontEnd]]
*[[getRadioChannel]]
*[[getRadioChannelName]]
*[[getSoundEffects]]
*[[getSoundLength]]
*[[getSoundMaxDistance]]
*[[getSoundMetaTags]]
*[[getSoundMinDistance]]
*[[getSoundPosition]]
*[[getSoundSpeed]]
*[[getSoundVolume]]
*[[setSoundEffectEnabled]]
*[[isSoundPaused]]
*[[playSound]]
*[[playSound3D]]
{{New items|3.0134|1.3.4 r5731|
*[[playSFX]]
*[[playSFX3D]]
}}
*[[setRadioChannel]]
*[[setSoundMaxDistance]]
*[[setSoundMinDistance]]
*[[setSoundPaused]]
*[[setSoundPosition]]
*[[setSoundSpeed]]
*[[setSoundVolume]]
*[[stopSound]]
*[[getSoundBPM]]
*[[getSoundProperties]]
*[[setSoundProperties]]
*[[getSoundFFTData]]
*[[getSoundWaveData]]
*[[getSoundLevelData]]
*[[setSoundPan]]
*[[getSoundPan]]
<noinclude>[[Category:Functions templates]]</noinclude>

Meta.xml

2013-08-21T08:26:01Z

X86dev:

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".

**'''validate:''' If set to "false", compatibility checks are skipped.
**'''shared:''' hey, todo!.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data (default).
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop/>''' todo.
**'''false:''' todo.
**'''true:''' todo.
}}

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#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"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>

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

<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:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

SetCameraMatrix

2013-08-14T08:39:41Z

X86dev:

__NOTOC__
{{Server client function}}
This function sets the camera's position and direction. The first three arguments are the point at which the camera lies, the last three are the point the camera faces (or the point it "looks at").

'''Note:''' Calling this function takes the camera's focus away from the player and sets the camera in a fixed position and rotation. The camera's focus can be brought back to the player using the [[setCameraTarget]] function.
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setCameraMatrix ( player thePlayer, float positionX, float positionY, float positionZ [, float lookAtX, float lookAtY, float lookAtZ, float roll = 0, float fov = 70 ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera is to be changed.
*'''positionX:''' The x coordinate of the camera's position.
*'''positionY:''' The y coordinate of the camera's position.
*'''positionZ:''' The z coordinate of the camera's position.

===Optional Arguments===
*'''lookAtX:''' The x coordinate of the point the camera faces.
*'''lookAtY:''' The y coordinate of the point the camera faces.
*'''lookAtZ:''' The z coordinate of the point the camera faces.
*'''roll:''' The camera roll angle, -180 to 180. A value of 0 means the camera sits straight, positive values will turn it counter-clockwise and negative values will turn it clockwise. -180 or 180 means the camera is upside down.
*'''fov:''' the field of view angle, 0 to 180. The higher this value is, the more you will be able to see what is to your sides.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setCameraMatrix ( float positionX, float positionY, float positionZ [, float lookAtX, float lookAtY, float lookAtZ, float roll = 0, float fov = 70 ] )
</syntaxhighlight>

===Required Arguments===
*'''positionX:''' The x coordinate of the camera's position.
*'''positionY:''' The y coordinate of the camera's position.
*'''positionZ:''' The z coordinate of the camera's position.

===Optional Arguments===
*'''lookAtX:''' The x coordinate of the point the camera faces.
*'''lookAtY:''' The y coordinate of the point the camera faces.
*'''lookAtZ:''' The z coordinate of the point the camera faces.
*'''roll:''' The camera roll angle, -180 to 180. A value of 0 means the camera sits straight, positive values will turn it counter-clockwise and negative values will turn it clockwise. -180 or 180 means the camera is upside down.
*'''fov:''' the field of view angle, 0 to 180. The higher this value is, the more you will be able to see what is to your sides.
</section>

===Returns===
Returns ''true'' if the arguments are valid, ''false'' otherwise.

==Example==
This code fixates the camera onto the Vinewood sign in Los Santos for any player that joins the server:
<section class="server" name="Server script" show="true">
<syntaxhighlight lang="lua">
function setCameraOnPlayerJoin()
-- slowly fade the camera in to make the screen visible
fadeCamera(source, true, 5)
-- set the player's camera to a fixed position, looking at a fixed point
setCameraMatrix(source, 1468.8785400391, -919.25317382813, 100.153465271, 1468.388671875, -918.42474365234, 99.881813049316)
end
addEventHandler("onPlayerJoin", getRootElement(), setCameraOnPlayerJoin)</syntaxhighlight>
</section>

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

SetCameraViewMode

2013-08-14T08:38:32Z

X86dev:

__NOTOC__
{{Client function}}
This function allows you to set the camera's view mode if you are inside a [[vehicle]]. This indicates at what distance the camera will follow the player.

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraViewMode ( int viewMode )
</syntaxhighlight>

===Required Arguments===
*'''viewMode''': The view mode you wish to use
{{Camera view modes}}

===Returns===
Returns ''true'' if the view was set correctly, ''false'' otherwise.

==Example==
This example sets the camera to bumper view when the local player enters any vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerVehicleEnter", getLocalPlayer(), function()
setCameraViewMode(0)
end)
</syntaxhighlight>

==See Also==
{{Client camera functions}}

SetWeaponProperty

2013-08-08T06:51:47Z

X86dev:

{{Server client function}}
__NOTOC__
<section name="setWeaponProperty" class="server" show="true">
This function sets the weapon property of the specified weapons specified weapon type. See lower down the page for documentation related to weapon creation.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponProperty ( int weaponID/string weaponName, string weaponSkill, string property, int/float theValue )</syntaxhighlight>

==Required Arguments==
*'''weaponID:''' The ID or name of the [[Weapons|weapon]] you want to set a property of. Names can be:
{{Some Weapon Types}}
*'''weaponSkill:''' Either: "pro", "std" or "poor". The player must have this skill level set to have the effect.
*'''property:''' The property you want to set the value of:
** "weapon_range" - float
** "target_range" - float
** "accuracy" - float
** "damage" - int
** "maximum_clip_ammo" - int
** "move_speed" - float
** "flags" - int (specify a flag to toggle it on/off) See [[Weapon Flags]]
** "anim_loop_start" - float
** "anim_loop_stop" - float
** "anim_loop_bullet_fire" - float
** "anim2_loop_start" - float
** "anim2_loop_stop" - float
** "anim2_loop_bullet_fire" - float
** "anim_breakout_time" - float
*'''theValue:''' The value to set the property to.

==Returns==
On success:

'''bool:''' Returns true if the weapon property was successfully set

On failure:

'''bool:''' Returns false if the weapon property was unable to be set

==Example==
This example sets the weapon range of the M4 at poor skill level to 75
<syntaxhighlight lang="lua">
local rangeSet = setWeaponProperty(31, "poor", "weapon_range", 75)
if (rangeSet) then
outputChatBox("M4 range at poor skill is set now 75!")
end
</syntaxhighlight>

This example makes the silenced pistol dual wielded at pro skill level
<syntaxhighlight lang="lua">
setWeaponProperty(23, "pro", "flags", 0x000800)
setWeaponProperty(23, "pro", "flags", 0x000002)
setWeaponProperty(23, "pro", "maximum_clip_ammo", 34)
</syntaxhighlight>

This examples doubles the range of the colt 45 hand gun
<syntaxhighlight lang="lua">
setWeaponProperty(22, "poor", "weapon_range", 70)
setWeaponProperty(22, "std", "weapon_range", 70)
setWeaponProperty(22, "pro", "weapon_range", 70)
</syntaxhighlight>

This example makes the minigun able to fire all its ammo without the short reload time
<syntaxhighlight lang="lua">
setWeaponProperty("minigun", "pro", "maximum_clip_ammo", 1000)
</syntaxhighlight>

==Requirements==
{{Requirements|1.3|n/a|}}
</section>

<section name="setWeaponProperty" class="client" show="true">
==Syntax (weapon creation)==

<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>

==Required Arguments==

* '''theWeapon:''' the weapon to change the property of.
* '''strProperty:''' the property to edit such as damage per hit ( "damage" ):
** "weapon_range" - float
** "target_range" - float
** "accuracy" - float
** "damage" - int
** "maximum_clip_ammo" - int
** "move_speed" - float
** "flags" - int (specify a flag to toggle it on/off) See [[Weapon Flags]]
** "anim_loop_start" - float
** "anim_loop_stop" - float
** "anim_loop_bullet_fire" - float
** "anim2_loop_start" - float
** "anim2_loop_stop" - float
** "anim2_loop_bullet_fire" - float
** "anim_breakout_time" - float
* '''theValue:''' whatever you wish to set it to ( different properties use different data types so damage could be an int where as accuracy is a float ).

Sets an individual weapons property. Only a handful of useful properties are supported now and it uses the same property names as setWeaponProperty server side.

Returns true if the property was set.

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

</section>

==See Also==
{{Weapon functions}}

Template:Useful Functions

2013-07-27T22:15:14Z

X86dev: Undo revision 36781 by Emiliano Castro (talk)

*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside 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>
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span>
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span>
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)</span>
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span>
*[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</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.</span>
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span>
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span>
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculate a font size from given height for dxDraw.</span>
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Accurately measures the pixel height of a font.</span>
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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;">» Formats a date on the basis of a format string and returns it.</span>
*[[GenerateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can generate a random string with any characters.</span>
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span>
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.</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>
*[[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>
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span>
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the elements that are in a markers colshape.</span>
*[[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>
*[[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>
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span>
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all online staff, names separated by two spaces.</span>
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets players who have data name you passed to it.</span>
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span>
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span>
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets an online player from their serial.</span>
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span>
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a team from it's color. (Related to: [[getTeamFromName]])</span>
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the UNIX timestamp.</span>
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all children of a node</span>
*[[getVehicleRespawnPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get the spawn position of a vehicle.</span>
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Adjusts the combobox to have a correct height.</span>
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span>
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture.</span>
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check is the element's range to the main point is smaller than (or as big as) 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 the [[element]] is in a [[colshape]].</span>
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a ped is aiming.</span>
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check if the player in the team.</span>
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span>
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span>
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span>
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the clientside floating-point precision of 24-bits</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>
*[[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>
*[[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 vehicles weapon.</span>
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span>
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span>
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span>
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function allows you to create a cinematic camera flight.
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</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 allow the value of a variable or expression to control the flow of program execution via a multiway branch.</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 check if both tables is equal. </span>
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check is empty table or not.</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.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random variable from a table.</span>
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</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 clientside.</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 phisical wavelength of light to a RGBA color.</span>
[[Category:Useful Functions]]

GetElementsWithinMarker

2013-07-24T16:13:38Z

X86dev:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function can be used to get the elements within a markers collision area.

==Syntax==
<syntaxhighlight lang="lua">
table getElementsWithinMarker ( marker theMarker )
</syntaxhighlight>

===Required Arguments===
* '''theMarker:''' The marker element that you want to see what's inside.

===Returns===
Returns a ''table'' containing each element that's inside the marker just like [[getElementsWithinColShape]] or ''false'' if a marker wasn't passed to the function.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getElementsWithinMarker(marker)
if (not isElement(marker) or getElementType(marker) ~= "marker") then
return false
end
local markerColShape = getElementColShape(marker)
local elements = getElementsWithinColShape(markerColShape)
return elements
end
</syntaxhighlight>
</section>

Author: Arran

==See Also==
{{Useful_Functions}}

SetControlState

2013-07-24T06:49:00Z

X86dev:

{{Server client function}}
__NOTOC__
Sets a state of a specified player's control, as if they pressed or released it.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool setControlState ( player thePlayer, string control, bool state ) </syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player you wish to set the control state of.
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
*'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool setControlState ( string control, bool state ) </syntaxhighlight>
===Required Arguments===
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
*'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
</section>

===Returns===
Returns 'true' if the control state was successfully set, 'false' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
toggleControl ( source, "accelerate", false ) -- disable the accelerate key
toggleControl ( source, "brake_reverse", false ) -- disable the brake_reverse key
toggleControl ( source, "handbrake", false ) -- disable the handbrake key
setControlState ( source, "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), onPlayerEnterVehicle )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
<syntaxhighlight lang="lua">

function onClientPlayerEnterVehicle ( theVehicle, seat, jacked )
toggleControl ( "accelerate", false ) -- disable the accelerate key
toggleControl ( "brake_reverse", false ) -- disable the brake_reverse key
toggleControl ( "handbrake", false ) -- disable the handbrake key
setControlState ( "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onClientPlayerVehicleEnter", getRootElement(), onClientPlayerEnterVehicle )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

DxCreateShader

2013-07-23T08:53:49Z

X86dev:

{{Client function}}
__NOTOC__
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.

=====It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.=====

==Syntax==
<syntaxhighlight lang="lua">
element, string dxCreateShader ( string filepath [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )
</syntaxhighlight>

===Required Arguments===
*'''filepath:''' The filepath of the [[shader|shader Effect File]](.fx) file

===Optional Arguments===
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass)
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:
** world - Textures in the GTA world
** ped - Player and ped textures
** vehicle - Vehicles textures
** object - Objects textures
** other - Element textures which are not peds, vehicles or objects
** all - Everything

===Returns===
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''
*'''string:''' The name of the technique that will be used.

==Example==
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender", root,
function()
if myShader then
dxDrawImage( 100, 350, 300, 350, myShader )
end
end
)

-- Use 'toggle' command to switch shader on and off
addCommandHandler( "toggle",
function()
if not myShader then
myShader = dxCreateShader( "fancything.fx" ) -- Create shader
else
destroyElement( myShader ) -- Destroy shader
myShader = nil
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}

==See Also==
{{Drawing_functions}}

DxGetMaterialSize

2013-07-15T07:05:39Z

X86dev:

{{Client function}}
__NOTOC__
This gets the dimensions of the supplied [[material]] element.

==Syntax==
<syntaxhighlight lang="lua">
int, int [, int] dxGetMaterialSize ( element material )
</syntaxhighlight>

===Required Arguments===
*'''material :''' The material element whose size is to be gotten

===Returns===
Returns two ''ints'' representing the width and height in pixels of the material, or false if an invalid parameter was passed to the function.
If the material is a volume texture, this function will return three ''ints'' representing the width, height and depth.

==Example==
<syntaxhighlight lang="lua">
myTexture = dxCreateTexture( "man.png" )
local width, height = dxGetMaterialSize( myTexture )
outputChatBox( "man.png is " .. tostring(width) .. " pixels wide and " .. tostring(height) .. " pixels high" )
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added third return value for volume textures}}

==See Also==
{{Drawing_functions}}

EngineImportTXD

2013-07-07T10:34:12Z

X86dev:

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause textures, collisions or the DFF not to load due to technical limitations}}

This function imports (adds) a loaded RenderWare Texture Dictionary into a specific model. This is necessary in order for the DFF loader to find any new textures. Please '''call this function before loading the DFF model file''', in order to allow the DFF loading process to find the new textures. This function can also replace default GTA textures, so that it becomes possible to e.g. put custom images on existing billboards. Ped and weapon textures are also supported.

See here for [https://wiki.multitheftauto.com/wiki/Optimize_Custom_TXD tips on reducing the size of TXD files].

{{New feature/item|3.0132|1.3.1|5254|
* CJ clothing component textures can be replaced by using the ids listed on [[Clothing Component IDs|this page]]
}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineImportTXD ( txd texture, int model_id )
</syntaxhighlight>

===Required Arguments===
*'''texture:''' The [[TXD]] that was loaded with [[engineLoadTXD]]
*'''model_id:''' The model id to import the TXD into

===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 3781 )
engineReplaceCOL ( col_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>
</section>

{{New feature|3|1.0|
<section name="Client" class="client" show="true">
'''Example 3:''' This example replaces the victim billboards in last venturas (when replacing default models you do not need to replace a dff or col)
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing billboards" )
txd_floors = engineLoadTXD ( "models/vgsn_billboard.txd" )
engineImportTXD ( txd_floors, 7300 )
</syntaxhighlight>
</section>
}}

==See Also==
{{Engine_functions}}

Changes in 1.3.3

2013-07-03T08:11:26Z

X86dev:

{{Changelogs}}
{{Note|TODO, still not done --[[User:X86dev|X86dev]] 08:11, 3 July 2013 (UTC)}}
== Main Additions / Changes ==
* Anti-cheat updates
* Optimized streamer to work better with complex maps
* Smoothed fonts when scaling chat box
* Added option to scale HUD elements correctly for widescreen
* Added option to disable OS and graphic driver 'tweaks', as they can interfere with MTA
* Better compatibility with NVidia Optimus laptops
* Improved server performance

=== Client ===

----

==== New Functions ====
* [[setVehiclePlateText]]
* [[dxSetAspectRatioAdjustmentEnabled]]

==== New Events ====
* [[onClientSoundStarted]]
* [[onClientSoundStopped]]

==== Changes / Bug Fixes ====
* Optimized streamer to work better with complex maps
* Smoothed fonts when scaling chat box
* Added option to scale HUD elements correctly for widescreen
* Added option to disable OS and graphic driver 'tweaks', as they can interfere with MTA
* Better compatibility with NVidia Optimus laptops
* Fixed GUI window remaining when you disconnect while starting local server
* Fixed GUI labels sometimes blocking input
* Fixed a crash on disconnect

=== Server ===

----

==== New Functions ====
* [[setVehiclePlateText]]
* [[getPlayerACInfo]]

==== New Events ====
* ''None yet''

==== Changes / Bug Fixes ====
* Fixed incorrect server side vehicle engine state when driver warped in
* Fixed onPlayerQuit event not being triggered on shutdown
* Fixed serverside toggleAllControls()

* Improved server performance
** by caching player weapon range
** by reducing the amount of redundant data sent to the network thread
* Added CSimPedTaskPacket for better hit anim sync
* Fixed an issue with weapon ammo getting out of sync
* Speed up server scripts by optimizing ACL checks
* Added reassuring animation during periods of no input response
* Fixed some desyncs in unoccupied vehicle sync (engine, derailed, in-water state)
* Fixed Get/SetMatrix rotation order for streamed out objects
* Fixed Linux compile issues

* Fixed stability errors (random texture swapping/assertions) after alt+tab
* Fixed crash in ReApplyMoveAnims
* Fixed setElementPosition for players vehicle causes freeze for few seconds
* Fixed getPedTotalAmmo sometimes returns 0 while player is aiming on Slot 8
* Fixed onPlayerDamage has wrong parameters if source on vehicle
* Fixed getVehicleSirens on a sandking (495) crashes the server immediately

=== Resources ===
* ['''voice'''] fixed voice icon doesn't disappear for other players after the speaking have been stopped (ccw)

=== Editor ===
* ''None yet''

==Extra information==
''More detailed information available on [http://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* MTA:SA: from [http://code.google.com/p/mtasa-blue/source/list?num=25&start=4605 r4600] and [http://code.google.com/p/mtasa-blue/source/list above]
:* Resources: from [http://code.google.com/p/mtasa-resources/source/list?num=25&start=883 r875] and [http://code.google.com/p/mtasa-resources/source/list above]

[[Category:Changelog]]

Changes in 1.3.3

2013-07-03T08:10:54Z

X86dev:

{{Changelogs}}
{{Note|TODO}}
== Main Additions / Changes ==
* Anti-cheat updates
* Optimized streamer to work better with complex maps
* Smoothed fonts when scaling chat box
* Added option to scale HUD elements correctly for widescreen
* Added option to disable OS and graphic driver 'tweaks', as they can interfere with MTA
* Better compatibility with NVidia Optimus laptops
* Improved server performance

=== Client ===

----

==== New Functions ====
* [[setVehiclePlateText]]
* [[dxSetAspectRatioAdjustmentEnabled]]

==== New Events ====
* [[onClientSoundStarted]]
* [[onClientSoundStopped]]

==== Changes / Bug Fixes ====
* Optimized streamer to work better with complex maps
* Smoothed fonts when scaling chat box
* Added option to scale HUD elements correctly for widescreen
* Added option to disable OS and graphic driver 'tweaks', as they can interfere with MTA
* Better compatibility with NVidia Optimus laptops
* Fixed GUI window remaining when you disconnect while starting local server
* Fixed GUI labels sometimes blocking input
* Fixed a crash on disconnect

=== Server ===

----

==== New Functions ====
* [[setVehiclePlateText]]
* [[getPlayerACInfo]]

==== New Events ====
* ''None yet''

==== Changes / Bug Fixes ====
* Fixed incorrect server side vehicle engine state when driver warped in
* Fixed onPlayerQuit event not being triggered on shutdown
* Fixed serverside toggleAllControls()

* Improved server performance
** by caching player weapon range
** by reducing the amount of redundant data sent to the network thread
* Added CSimPedTaskPacket for better hit anim sync
* Fixed an issue with weapon ammo getting out of sync
* Speed up server scripts by optimizing ACL checks
* Added reassuring animation during periods of no input response
* Fixed some desyncs in unoccupied vehicle sync (engine, derailed, in-water state)
* Fixed Get/SetMatrix rotation order for streamed out objects
* Fixed Linux compile issues

* Fixed stability errors (random texture swapping/assertions) after alt+tab
* Fixed crash in ReApplyMoveAnims
* Fixed setElementPosition for players vehicle causes freeze for few seconds
* Fixed getPedTotalAmmo sometimes returns 0 while player is aiming on Slot 8
* Fixed onPlayerDamage has wrong parameters if source on vehicle
* Fixed getVehicleSirens on a sandking (495) crashes the server immediately

=== Resources ===
* ['''voice'''] fixed voice icon doesn't disappear for other players after the speaking have been stopped (ccw)

=== Editor ===
* ''None yet''

==Extra information==
''More detailed information available on [http://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* MTA:SA: from [http://code.google.com/p/mtasa-blue/source/list?num=25&start=4605 r4600] and [http://code.google.com/p/mtasa-blue/source/list above]
:* Resources: from [http://code.google.com/p/mtasa-resources/source/list?num=25&start=883 r875] and [http://code.google.com/p/mtasa-resources/source/list above]

[[Category:Changelog]]

DxGetStatus

2013-07-01T11:20:19Z

X86dev:

{{Client function}}
__NOTOC__
This function gets information about various internal datum

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

===Returns===
Returns a table with the following entries:
* '''TestMode :''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName :''' The name of the graphics card.
*'''VideoCardRAM :''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion :''' The maximum pixel shader version of the graphics card.
*'''VideoMemoryFreeForMTA :''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByFonts :''' The amount of graphic memory in MB used by custom fonts.
*'''VideoMemoryUsedByTextures :''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryUsedByRenderTargets :''' The amount of graphic memory in MB used by render targets.
*'''SettingWindowed :''' The windowed setting. (true/false)
*'''SettingFXQuality :''' The FX Quality. (0-3)
*'''SettingDrawDistance :''' The draw distance setting. (0-100)
*'''SettingVolumetricShadows :''' The volumetric shadows setting. (true/false)
*'''SettingStreamingVideoMemoryForGTA :''' The usable graphics memory setting. (64-256)
*'''AllowScreenUpload :''' The allows screen uploads setting. (true/false)
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off,1x,2x,3x)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getinfo",function()
local info=dxGetStatus()
for k,v in pairs(info) do
outputChatBox(k.." : "..tostring(v),root,255,0,0,true)
end
end)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04715|Added DepthBufferFormat argument}}
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}

==See Also==
{{Drawing_functions}}

ProcessLineOfSight

2013-07-01T07:44:23Z

X86dev:

{{Client function}}
__NOTOC__
This function casts a ray between two points in the world, and tells you information about the point that was hit, if any. The two positions '''must''' be within the local player's draw distance as the collision data is not loaded outside this area, and the call will just fail as if the ray didn't hit.

This function is relatively expensive to call, so over use of this in scripts may have a detrimental effect on performance.

This function is useful for checking for collisions and for editor-style scripts. If you wish to find what element is positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]]. If you wish to just know if something is hit, and don't care about what or where was hit, use [[isLineOfSightClear]].

==Syntax==
Return values labelled for ease of reference.
<syntaxhighlight lang="lua">
bool -- hit
float float float -- hitX, hitY, hitZ
element -- hitElement
float float float -- normalX, normalY, normalZ
int -- material
float -- lighting
int -- piece
int -- worldModelID
float float float -- worldModelPositionX,Y,Z
float float float -- worldModelRotationX,Y,Z
int -- worldLODModelID
processLineOfSight ( float startX, float startY, float startZ,
float endX, float endY, float endZ,
[ bool checkBuildings = true,
bool checkVehicles = true,
bool checkPlayers = true,
bool checkObjects = true,
bool checkDummies = true,
bool seeThroughStuff = false,
bool ignoreSomeObjectsForCamera = false,
bool shootThroughStuff = false,
element ignoredElement = nil,
bool includeWorldModelInformation = false,
bool bIncludeCarTyres ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''endX:''' The end ''x'' position
*'''endY:''' The end ''y'' position
*'''endZ:''' The end ''z'' position

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPlayers:''' Allow the line of sight to be blocked by [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
*'''shootThroughStuff:''' Allow the line of sight to be blocked by things that can be shot through
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
*'''includeWorldModelInformation :''' Include the results of hitting a world model.
*'''bIncludeCarTyres :''' Includes car tyre hits.

===Returns===
*'''hit:''' ''true'' if there is a collision, ''false'' otherwise
The other values are only filled if there is a collision, they contain ''nil'' otherwise
*'''hitX, hitY, hitZ:''' collision position
*'''hitElement:''' the MTA element hit if any, ''nil'' otherwise
*'''normalX, normalY, normalZ:''' the normal of the surface hit
*'''material:''' an integer representing the [[Material IDs|GTASA material ID]] of the surface hit when applicable (world, objects)
*'''lighting:''' a float between 0 (fully dark) and 1 (bright) representing the amount of light that the hit building surface will transfer to peds or vehicles that are in contact with it. The value can be affected by the game time of day, usually with a lower (darker) value being returned during the night.
*'''piece:''' an integer representing the part of the element hit if hitElement is a vehicle or a ped/player, ''0'' otherwise.
**For a ped/player, piece represents the body part hit:
{{BodyParts}}
**For vehicles, piece represents the vehicle part hit:
{{VehicleParts}}
*'''worldModelID:''' If includeWorldModelInformation was set to ''true'' and a world model was hit, this will contain the model ID.
*'''worldModelPositionX,Y,Z:''' If worldModelID is set, this will contain the world model position.
*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.
*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.

==Example==
This example shows how you can tell what position and element the camera is looking at, up to 50 units away.
<syntaxhighlight lang="lua">
local w, h = guiGetScreenSize ()
local tx, ty, tz = getWorldFromScreenPosition ( w/2, h/2, 50 )
local px, py, pz = getCameraMatrix()
hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, tx, ty, tz )
if hit then
outputChatBox ( "Looking at " .. x .. ", " .. y .. ", " .. z )
if elementHit then
outputChatBox ( "Hit element " .. getElementType(elementHit) )
end
end
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04273|''bIncludeCarTyres'' argument added}}
{{ChangelogItem|1.3.0-9.04273|''worldModelID'' return value fixed}}
{{ChangelogItem|1.3.0-9.04405|''lighting'' return value fixed}}

==See Also==
{{Client world functions}}

Template:VehicleParts

2013-07-01T07:44:21Z

X86dev:

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
*'''0:''' Frame
*'''2:''' Trunk
*'''3:''' Hood
*'''4:''' Rear
*'''5:''' Front left door
*'''6:''' Front right door
*'''7:''' Rear left door
*'''8:''' Rear right door
*'''13:''' Front Left tyre
*'''14:''' Front Right tyre
*'''15:''' Back Left tyre
*'''16:''' Back Right tyre
(Other potential IDs haven't been documented yet and might depend on vehicle model)
</div>

Category:Changes in 1.3

2013-07-01T07:41:33Z

X86dev:

''See also [[Changes in 1.3]]''

[[Category:Changelog]]

Changes in 1.3.3

2013-07-01T07:40:18Z

X86dev: Created page with "{{Changelogs}} {{Note|TODO}} == Main Additions / Changes == === Client === ---- ==== New Functions ==== * ''None yet'' ==== New Events ==== * ''None yet'' ==== Changes / Bug..."

{{Changelogs}}
{{Note|TODO}}
== Main Additions / Changes ==

=== Client ===

----

==== New Functions ====
* ''None yet''

==== New Events ====
* ''None yet''

==== Changes / Bug Fixes ====
* ''None yet''

=== Server ===

----

==== New Functions ====
* ''None yet''

==== New Events ====
* ''None yet''

==== Changes / Bug Fixes ====
* ''None yet''

=== Resources ===
* ''None yet''

=== Editor ===
* ''None yet''

==Extra information==
''More detailed information available on [http://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* MTA:SA: from [http://code.google.com/p/mtasa-blue/source/list?num=25&start=4605 r4600] and [http://code.google.com/p/mtasa-blue/source/list above]
:* Resources: from [http://code.google.com/p/mtasa-resources/source/list?num=25&start=883 r875] and [http://code.google.com/p/mtasa-resources/source/list above]

[[Category:Changelog]]

Template:Changelogs

2013-07-01T07:40:16Z

X86dev:

{| cellpadding="4" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #FFF; float:right;"
|-
!width=140 style="background-color: #D6DCFF; border-style: solid; border-width: 1px; border-color: #FFF; color:#00000;"| MTA:SA Version
!width=400 style="white-space: nowrap; background-color: #D6DCFF; border-style: solid; border-width: 1px; border-color: #FFF;"| Changelogs
{{Changelogsrow|1.0|[[Changes in 1.0|1.0.0]] • 1.0.1 • 1.0.2 • 1.0.3 • 1.0.4}}
{{Changelogsrow|1.1|[[Changes in 1.1|1.1.0]] • 1.1.1}}
{{Changelogsrow|1.2|[[Changes in 1.2|1.2.0]]}}
{{Changelogsrow|1.3|[[Changes in 1.3|1.3.0]] • [[Changes in 1.3.1|1.3.1]] • [[Changes in 1.3.2|1.3.2]] • [[Changes in 1.3.3|1.3.3]]}}
|}

DxSetBlendMode

2013-06-28T10:54:48Z

X86dev:

{{Client function}}
__NOTOC__
This function sets the current blend mode for the dxDraw functions. Changing the blend mode can increase the quality when drawing text or certain other images to a render target. As a general guide use '''modulate_add''' when drawing text to a render target, and '''add''' when drawing the render target to the screen. Don't forget to restore the default '''blend''' at the end - See the example below.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetBlendMode ( string blendMode )
</syntaxhighlight>

===Required Arguments===
*'''blendMode :''' The blend mode to use which can be one of:
**'''blend:''' The source textures are alpha blended to the screen/render target. The is the default mode for drawing and gives the results we all know and love.
**'''add:''' The source textures are added to the screen/render target.
**'''modulate_add:''' The source textures are multiplied by the alpha and then added to the screen/render target.
**'''overwrite :''' The source textures are overwritten. This can be useful for clearing render targets.

==Returns==
Returns true if successful, or ''false'' if invalid arguments were passed to the function.

==Example==
This example shows how to use '''modulate_add''' and '''add''' to avoid quality problems when using a render target:
<syntaxhighlight lang="lua">
local myRenderTarget = dxCreateRenderTarget(500, 500, true)

--
-- Function to draw text to our render target texture when the 'r' key is pressed
--
function updateRenderTarget()
dxSetRenderTarget(myRenderTarget, true)
dxSetBlendMode("modulate_add") -- Set 'modulate_add' when drawing stuff on the render target

dxDrawText("Testing "..getTickCount(), 0, 0, 0, 0, tocolor(255, 255, 255, 255), 2, "Verdana")

dxSetBlendMode("blend") -- Restore default blending
dxSetRenderTarget() -- Restore default render target
end
bindKey("r", "down", updateRenderTarget )

--
-- Display render target contents
--
addEventHandler("onClientRender", root,
function()
dxSetBlendMode("add") -- Set 'add' when drawing the render target on the screen
dxDrawImage(100, 200, 500, 500, myRenderTarget, -10)
dxSetBlendMode("blend") -- Restore default blending
end
)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.03782|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04425|Added overwrite }}

==See Also==
{{Drawing_functions}}

[[Category:Needs Example]]

DxGetTexturePixels

2013-06-28T10:54:06Z

X86dev:

{{Client function}}
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.

----
''Performance note:
*''This function is slow and not something you want to be doing once a frame.''
*''It is slower when reading pixels from a render target or screen source.''
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
----

==Syntax==
<syntaxhighlight lang="lua">
string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''texture :''' The texture element to get the pixels from

===Optional Arguments===
*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns a ''''plain'''' format pixels string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxSetTexturePixels

2013-06-28T10:53:53Z

X86dev:

{{Client function}}
__NOTOC__
This function sets the [[Texture_pixels|pixels]] of a [[texture]] element. It can be used with a standard texture, render target or screen source. Only ''''plain'''' format pixels please.

----
''Performance note:
*''This function is slow and not something you want to be doing once a frame.''
*''It is very slow when setting pixels to a render target or screen source.''
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
----

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetTexturePixels ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''texture :''' The texture element to set the pixels of
*'''pixels :''' The ''''plain'''' format pixels to use

===Optional Arguments===
*'''surfaceIndex:''' Desired slice to set if the texture is a volume texture, or desired face to set if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
By default the pixels are set starting at the top left corner of the texture. To set a different region, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns a string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetStatus

2013-06-28T10:18:13Z

X86dev:

{{Client function}}
__NOTOC__
This function gets information about various internal datum

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

===Returns===
Returns a table with the following entries:
* '''TestMode :''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName :''' The name of the graphics card.
*'''VideoCardRAM :''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion :''' The maximum pixel shader version of the graphics card.
*'''VideoMemoryFreeForMTA :''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByFonts :''' The amount of graphic memory in MB used by custom fonts.
*'''VideoMemoryUsedByTextures :''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryUsedByRenderTargets :''' The amount of graphic memory in MB used by render targets.
*'''SettingWindowed :''' The windowed setting. (true/false)
*'''SettingFXQuality :''' The FX Quality. (0-3)
*'''SettingDrawDistance :''' The draw distance setting. (0-100)
*'''SettingVolumetricShadows :''' The volumetric shadows setting. (true/false)
*'''SettingStreamingVideoMemoryForGTA :''' The usable graphics memory setting. (64-256)
*'''AllowScreenUpload :''' The allows screen uploads setting. (true/false)
{{New feature/item|3.0133|1.3.2|4715|
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available
}}
{{New feature/item|3.0133|1.3.2|4811|
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off,1x,2x,3x)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)
}}
==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getinfo",function()
local info=dxGetStatus()
for k,v in pairs(info) do
outputChatBox(k.." : "..tostring(v),root,255,0,0,true)
end
end)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04715|Added DepthBufferFormat argument}}
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}

==See Also==
{{Drawing_functions}}

Template:Client resource functions

2013-06-27T10:50:41Z

X86dev:

*[[call]]
{{New feature/item|3.0133|1.3.2|5340|
*[[fetchRemote]]
}}
*[[getResourceConfig]]
*[[getResourceDynamicElementRoot]]
*[[getResourceExportedFunctions]]
*[[getResourceFromName]]
*[[getResourceGUIElement]]
*[[getResourceName]]
*[[getResourceRootElement]]
*[[getThisResource]]
<noinclude>[[Category:Functions templates]]</noinclude>

DxSetAspectRatioAdjustmentEnabled

2013-06-26T19:26:57Z

X86dev:

__NOTOC__
{{Client function}}
{{Needs Example}}

{{New feature/item|3.0140|1.3.3|5547|
Todo. This function is default enabled for the ''customblips'' resource and does only works during these events: onClientRender, onClientPreRender and onClientHUDRender
}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetAspectRatioAdjustmentEnabled ( bool bEnabled [, float fSourceRatio = 4/3 ] )
</syntaxhighlight>

===Required Arguments===
*'''bEnabled''': Should the adjustment be enabled or disabled.

===Optional Arguments===
{{OptionalArg}}
* '''fSourceRatio :''' Todo.

===Returns===
Returns ''true'' when the it was changed successfully, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.3-5547}}

==Example==
<syntaxhighlight lang="lua">
-- Todo
</syntaxhighlight>

==See Also==
{{Drawing_functions}}