Multi Theft Auto: Wiki - User contributions [en]

CreateVehicle/PT-BR

2020-08-06T17:07:44Z

Sbx320: Sbx320 moved page CreateVehicle/PT-BR to PT-BR/CreateVehicle

#REDIRECT [[PT-BR/CreateVehicle]]

PT-BR/CreateVehicle

2020-08-06T17:07:44Z

Sbx320: Sbx320 moved page CreateVehicle/PT-BR to PT-BR/CreateVehicle

__NOTOC__
{{BR/Funcao compartilhada}}{{BR/Nota|Os veículos (e outros elementos) criados em client-side são vistos somente pelo cliente que os criaram, não são sincronizados e os jogadores não podem entrar neles. Eles são essencialmente apenas para exibição.}}
Esta função cria um veículo em uma localização especificada.

Vale notar que a posição do veículo é relativa ao ponto central do veículo, não sua base. Sendo assim, você precisa garantir que o valor z (eixo vertical) esteja a alguma altura acima do solo. Você pode achar a altura exata com a seguinte função client-side [[getElementDistanceFromCentreOfMassToBaseOfModel]], ou você mesmo pode fazer uma estimativa e gerar o veículo para que ele caia no chão.

==Sintaxe==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int modelo, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
</syntaxhighlight>
{{PT-BR/POO||[[Vehicle]]||}}

===Argumentos necessários===
* '''modelo''': O [[IDs_de_veiculos|ID]] do veículo que está sendo criado
* '''x''': Um número [[float]] representando a coordenada X do mapa
* '''y''': Um número [[float]] representando a coordenada Y do mapa
* '''z''': Um número [[float]] representando a coordenada Z do mapa

===Argumentos Opcionais===
{{BR/ArgOpcional}}
* '''rx''': Um número [[float]] representando a rotação em torno do eixo X em graus.
* '''ry''': Um número [[float]] representando a rotação em torno do eixo Y em graus.
* '''rz''': Um número [[float]] representando a rotação em torno do eixo Z em graus.
* '''numberplate''': Uma string que aparecerá na placa do veículo (máximo de 8 caracteres).
* '''bDirection''' ''(serverside only)'': Placeholder [[boolean]] que fornece compatibilidade com alguns scripts. Isso nunca teve nenhum efeito, mas é lido pelo código. Recomenda-se ignorar esse argumento, passando o argumento '' false '' ou '' variant1 '' em seu lugar.
{{New feature/item|3.0120|1.2||
* '''variant1''': Um [[int]] para o primeiro variante do veículo. Veja [[vehicle variants]].
* '''variant2''': Um [[int]] para o segundo variante do veículo. Veja [[vehicle variants]].
}}

===Retorna===
Retorna o elemento [[Elemento/Vehicle]] que foi criado. Retorna ''false'' se os argumentos estão incorretos, ou se o limite de 65535 veículos spawnados no mundo for excedido

==Usando trens==
Trens são criados usando a função desta página. Eles são colocados no ponto mais próximo do percurso do trem do GTA:SA (geralmente são trilhos de trem) a partir do ponto em que ele foi spawnado.

==Exemplo==

<section name="Example 1: Server" class="server" show="true">
Este exemplo cria um marker 'vehicle spawner' que dá ao jogador um veículo assim que ele atinge o marker.
<syntaxhighlight lang="lua">
local vehMark = createMarker(-2426.34106, -639.12714, 132.93631,"cylinder")

function vehicleSpawner(hitElement,matchingDimension)
if getElementType(hitElement) == "player" then
if getPedOccupiedVehicle(hitElement) == false then
local x,y,z = getElementPosition(hitElement)
local veh = createVehicle(551, x,y,z)
warpPedIntoVehicle(hitElement,veh)
end
end
end
addEventHandler("onMarkerHit",vehMark,vehicleSpawner)
</syntaxhighlight>
</section>

<section name="Example 2: Server" class="server" show="true">
Este exemplo cria um veículo a 5 unidades de distância do jogador quando ele digita ''createvehicle'' e seu nome no console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getElementRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="false">
Esse script gera um Rhino em cima de um indivíduo sortudo.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 4: Server" class="server" show="false">
Este exemplo adiciona o comando ''/spveh'' para spawnar um modelo de um carro nas coordenadas fornceidas. Se qualquer um dos carros criados por este comando explodir, ele será respawnado no lugar onde foi criado.
<syntaxhighlight lang="lua">
-- Do not allow the following IDs to be spawned
local forbiddenCars = { [435] = true, [441] = true, [449] = true, [450] = true, [464] = true, [465] = true, [501] = true,
[537] = true, [538] = true, [564] = true, [569] = true, [570] = true, [584] = true, [590] = true,
[591] = true, [594] = true, [606] = true, [607] = true, [608] = true, [610] = true, [611] = true }

local cmdVehRoot = createElement("commandVehicles") -- Dummy element containing the cars that this command has created
addCommandHandler("spveh",
function(player, cmd, modelID, x, y, z, platetext)
-- Check whether arguments are correct
local modelID, x, y, z = tonumber(modelID), tonumber(x), tonumber(y), tonumber(z)
if modelID and x and y and z then
-- Do not continue if we shouldn't
if forbiddenCars[modelID] then
outputChatBox("The car model you provided is not allowed.", player, 255, 0, 0)
return
end
local platetext = type(platetext) == "string" and platetext or "PRIVATE"
-- Create the actual vehicle and set it as a children of our dummy element
setElementParent(createVehicle(modelID, x, y, z, 0, 0, 0, platetext), cmdVehRoot)
-- Inform the player about what we did
outputChatBox("You have created a " .. getVehicleNameFromModel(modelID) .. " (model ID: " .. modelID .. ") at " .. table.concat({ x, y, z }, ", ") .. " with numberplate " .. platetext .. " successfully.", player, 0, 255, 0)
else
outputChatBox("Syntax: /" .. cmd .. " (modelID) (x) (y) (z) [numberplate]", player, 255, 255, 255)
end
end
)

-- If a vehicle that has been created using the command blows up, respawn it where it was created
addEventHandler("onVehicleExplode", cmdVehRoot,
function()
respawnVehicle(source)
end
)
</syntaxhighlight>
</section>

<section name="Example 5: Client" class="client" show="true">
Este script spawna um tanque em cima do jogador local.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

{{New items|4.0132|1.4|
Este é um exemplo de como essa função é usada em OOP(POO - Programação Orientada a Objeto)
<section name="OOP server" class="server" show="true">
This script will create an Infernus at the center (0, 0, 3) of San Andreas upon execution.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function()
infernus = Vehicle(411, Vector3(0, 0, 3)); -- Create an Infernus and spawn it at the middle of SA.
infernus:setColor(0, 0, 0); -- Set its color to black.
infernus.damageProof = true; -- Make it damage proof
end
)

addCommandHandler( "blowinfernus",
function(p)
if not infernus.blown then -- Check if the Infernus is blown up or not.
infernus:blow();
else -- Ouch, it's blown up, let's output an error to the player.
outputChatBox( "The Infernus has already been blown up by you.", p, 255, 0, 0, false );
end
end)
</syntaxhighlight>
</section>
}}

==Veja também==

{{Vehicle functions}}

Template:Object Properties

2020-05-10T14:42:14Z

Sbx320: Remove accuracy as it does not exist

<div style="padding-left:20px">
* "mass" - ''float''
* "turn_mass" - ''float''
* "air_resistance" - ''float''
* "elasticity" - ''float''
* "center_of_mass" - ''Vector3D'' - '''(x, y, z)'''
* "buoyancy" - ''float''
</div>

SetGravity

2020-05-08T10:37:12Z

Sbx320:

__NOTOC__
{{Server client function}}
This function sets the server's gravity level.
{{Note|
*This will override [[setPedGravity]] applied to peds/players.
*Setting the gravity level to different values on clients can cause animation bugs (players floating across ground because players see different fall animation.)}}

==Syntax==
<syntaxhighlight lang="lua">bool setGravity ( float level )</syntaxhighlight>

===Required Arguments===
*'''level''': The level of gravity (default is '''0.008''').

===Returns===
Returns ''true'' if gravity was changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function grav ( sourcePlayer, command, level )
local level = tonumber(level)
if (not level) then return end
setGravity ( tonumber(level) )
end
addCommandHandler ( "setgravity", grav )
</syntaxhighlight>

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

[[ru:setGravity]]

Git Branching Models

2016-08-09T18:33:43Z

Sbx320:

__NOTOC__
Our current branching model is not optimal and makes keeping track of versions hard.
This page discusses various branching models.

== Models ==
=== Current SVN-like Model ===
* ''master'' is the development branch which contains incompatible code as well
* A version branch e.g. ''1.5.2'' is created when releasing a new stable version
* 'Stable commits' are merged from ''master'' frequently (==> rolling release like)

===== Pros =====
* Easy management of incompatible code (==> rolling-release works well)

===== Cons =====
* Prone to losing track of differences between master and version branches
* Doesn't integrate well with popular Git models implemented on e.g. GitHub

=== Feature Branches ===
* New, maybe incompatible features are implemented in separate branches and merged as soon as they are stable
* ''master'' is mostly stable
* When releasing a new version, a tag is created from master
* Release intervals are smaller

=== Feature Branches Example ===

* Current version is 1.5
* Someone wants to implement complicated things which are netcode-incompatible with 1.5
* Someone creates feature/complicated-things branched from master
* Work is now done on feature/complicated-things
* Once feature/complicated-things is ready it needs to wait for 1.6
* (time passes)
* (1.6 is ready for release)
* master is tagged as 1.5.x-final marking the end of 1.5 compatibility
* master version number is increased to 1.6
* feature/complicated-things is merged into master
* master build gets released to the public

==== Pros ====
* "Git"-way (==> integrates well with GitHub)
* No weird cherry-picking is necessary

==== Cons ====
* We have to modify our nightly system and build server settings to support feature branches somehow (required for properly distributing tests)
** We could probably use Travis CI and AppVeyor to easily maintain public builds for feature branches [[User:Sbx320|Sbx320]] ([[User talk:Sbx320|talk]]) 18:33, 9 August 2016 (UTC)

== Comments ==
* My concerns over Feature Branches are largely based upon any added bureaucracy or complexity to making contributions. --[[User:Talidan|Talidan]] ([[User talk:Talidan|talk]]) 18:04, 9 August 2016 (UTC)

Git Branching Models

2016-08-09T18:30:10Z

Sbx320:

__NOTOC__
Our current branching model is not optimal and makes keeping track of versions hard.
This page discusses various branching models.

== Models ==
=== Current SVN-like Model ===
* ''master'' is the development branch which contains incompatible code as well
* A version branch e.g. ''1.5.2'' is created when releasing a new stable version
* 'Stable commits' are merged from ''master'' frequently (==> rolling release like)

===== Pros =====
* Easy management of incompatible code (==> rolling-release works well)

===== Cons =====
* Prone to losing track of differences between master and version branches
* Doesn't integrate well with popular Git models implemented on e.g. GitHub

=== Feature Branches ===
* New, maybe incompatible features are implemented in separate branches and merged as soon as they are stable
* ''master'' is mostly stable
* When releasing a new version, a tag is created from master
* Release intervals are smaller

=== Example (adding a big feature) ===

* Current version is 1.5
* Someone wants to implement complicated things which are netcode-incompatible with 1.5
* Someone creates feature/complicated-things branched from master
* Work is now done on feature/complicated-things
* Once feature/complicated-things is ready it needs to wait for 1.6
* (time passes)
* (1.6 is ready for release)
* master is tagged as 1.5.x-final marking the end of 1.5 compatibility
* master version number is increased to 1.6
* feature/complicated-things is merged into master
* master build gets released to the public

==== Pros ====
* "Git"-way (==> integrates well with GitHub)
* No weird cherry-picking is necessary

==== Cons ====
* We have to modify our nightly system and build server settings to support feature branches somehow (required for properly distributing tests)

== Comments ==
* My concerns over Feature Branches are largely based upon any added bureaucracy or complexity to making contributions. --[[User:Talidan|Talidan]] ([[User talk:Talidan|talk]]) 18:04, 9 August 2016 (UTC)

Server Scripting Events

2016-06-22T11:29:17Z

Sbx320: Reverted edits by Ahmed Ly

<pageclass class="server"></pageclass>
This page lists all '''server-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Client-side scripting events can be found here: [[Client Scripting Events]]

==Client events==
{{Client_events}}

==Colshape events==
{{Colshape_events}}

==Element events==
{{Element_events}}

==Marker events==
{{Marker_events}}

==Pickup events==
{{Pickup_events}}

==Player events==
{{Player_events}}

==Ped events==
{{Ped_events}}

== Resource events==
{{Resource_events}}

==Server events==
{{Server_events}}

== Vehicle events ==
{{Vehicle_events}}

== Weapon events ==
{{Weapon_events}}

[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]

CountPlayersInTeam

2016-02-10T02:08:24Z

Sbx320: Undo revision 46586 by DABL (talk)

__NOTOC__
{{Server client function}}
This function is for returning the number of players in the specified team.

==Syntax==
<syntaxhighlight lang="lua">
int countPlayersInTeam ( team theTeam )
</syntaxhighlight>
{{OOP||[[team]]:countPlayers|playerCount|}}
===Optional Arguments===
*'''theTeam:''' The team you wish to retrieve the player count of.

===Returns===
Returns an integer containing the number of players in the team, ''false'' if it could not be retrieved.

==Example==
<section name="Example 1" class="server" show="true">
This example adds a command in the console to find out how many players are on your team.
<syntaxhighlight lang="lua">
function outputTeamSize ( source, commandName )
-- Get player's team
local theTeam = getPlayerTeam ( source )
-- If the player is in any team
if theTeam then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players.", source )
else
outputChatBox ( "You're not in a team.", source )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example adds a command in the console to find out how many players are on your team, clientside
<syntaxhighlight lang="lua">
function outputTeamSize ( commandName )
-- Get player's team
local theTeam = getPlayerTeam ( getLocalPlayer() )
-- If the player is in any team
if team then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players." )
else
outputChatBox ( "You're not in a team." )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="true">
This example balances a gamemode, to ensure equal number of players between the "grove" and "ballas" teams. This could be triggered when a player joins the server, or for all players currently in the server when the gamemode starts.
<syntaxhighlight lang="lua">
function balanceTeams ( thePlayer )
--get the team pointers from their names
local groveTeam = getTeamFromName ( "grove" )
local ballasTeam = getTeamFromName ( "ballas" )
--count the number of players in each team, and store them
local groveCount = countPlayersInTeam ( groveTeam )
local ballasCount = countPlayersInTeam ( ballasTeam )
if groveCount == ballasCount then --if the teams are equal
setPlayerTeam ( thePlayer , groveTeam ) --place the player in grove
elseif groveCount > ballasCount then --if there are more in grove
setPlayerTeam ( thePlayer , ballasTeam ) --place him in ballas
elseif groveCount < ballasCount then --if there are more in ballas
setPlayerTeam ( thePlayer , groveTeam ) --place him in grove.
end
end</syntaxhighlight>
</section>

==See Also==
{{Team functions}}

Server Scripting Events

2016-02-10T02:07:56Z

Sbx320: Reverted edits by DABL

SetBrowserAjaxHandler

2015-08-16T12:03:38Z

Sbx320: POST was fixed

__NOTOC__
{{Client_function}}
{{New feature/item|3.0160|1.6||
This function provides a requestable ajax resource for Lua/Javascript communication for a [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserAjaxHandler ( browser webBrowser, string url[, function handler] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:setAjaxHandler||setBrowserAjaxHandler }}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''url:''' The URL endpoint to handle
{{Warning|Do not use the same path as an existing file as url parameter. Ajax handlers have a higher priority than regular files, which will lead to inaccesibility of the original file if an ajax handler is attached to the same path. }}

===Optional Arguments===
*'''handler:''' The function to call if the webBrowser attempts to open the ajax endpoint. If this parameter is nil or omitted, the ajax handler for the url will be deleted.

===Additional Information===
The handling function (if given), will be called with two tables, representing GET and POST parameters. The handling function may return a string which will be provided to the browser as file content.

==Example==
This example will output all GET Parameters as well the number of requests made to the ajax endpoint.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

--This is the function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

local counter = 0
setBrowserAjaxHandler(webBrowser, "ajax.html",
function(get, post)
counter = counter+1
local output = string.format("<pre>You have requested this page %d times.\n", counter)
-- List Parameters
local getParameters = "Get Parameters: \n"
for k, v in pairs(get) do
getParameters = getParameters..string.format("[%s] = %s\n", k, v)
end

output = output..getParameters.."</pre>"
return output
end
);

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load our file.
loadBrowserURL(webBrowser, "ajax.html?hello=world")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>
===Returns===
Returns ''true'' if the ajax handler could be created/removed.

==See Also==
{{CEF_functions}}

SetBrowserAjaxHandler

2015-08-15T23:15:32Z

Sbx320: Added Warning about reusing paths

__NOTOC__
{{Client_function}}
{{New feature/item|3.0160|1.6||
This function provides a requestable ajax resource for Lua/Javascript communication for a [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserAjaxHandler ( browser webBrowser, string url[, function handler] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:setAjaxHandler||setBrowserAjaxHandler }}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''url:''' The URL endpoint to handle
{{Warning|Do not use the same path as an existing file as url parameter. Ajax handlers have a higher priority than regular files, which will lead to inaccesibility of the original file if an ajax handler is attached to the same path. }}

===Optional Arguments===
*'''handler:''' The function to call if the webBrowser attempts to open the ajax endpoint. If this parameter is nil or omitted, the ajax handler for the url will be deleted.

===Additional Information===
The handling function (if given), will be called with two tables, representing GET and POST parameters. The handling function may return a string which will be provided to the browser as file content.
{{Warning|Due to CEF Limitations POST parameters do not work and will (until fixed) always be empty.}}

==Example==
This example will output all GET Parameters as well the number of requests made to the ajax endpoint.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

--This is the function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

local counter = 0
setBrowserAjaxHandler(webBrowser, "ajax.html",
function(get, post)
counter = counter+1
local output = string.format("<pre>You have requested this page %d times.\n", counter)
-- List Parameters
local getParameters = "Get Parameters: \n"
for k, v in pairs(get) do
getParameters = getParameters..string.format("[%s] = %s\n", k, v)
end

output = output..getParameters.."</pre>"
return output
end
);

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load our file.
loadBrowserURL(webBrowser, "ajax.html?hello=world")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>
===Returns===
Returns ''true'' if the ajax handler could be created/removed.

==See Also==
{{CEF_functions}}

SetElementStreamable

2015-08-13T15:57:17Z

Sbx320: Fixed documentation

{{Client function}}
__NOTOC__
This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. This function only works in elements with a physical representation in the world (entities), such as [[player|players]], [[ped|peds]], [[vehicle|vehicles]] and [[object|objects]].
{{Tip|'''Always use this function with caution'''. Not doing so can cause the following problems:
* There is a limit of elements that can be streamed in safely for every GTA entity type. If you bypass said limit by using this function, the client can experience problems of disappearing objects and unstability when trying to stream in new elements of that type.
* In general, if you disable too many elements (of the same type or not) to stream out, GTA will always try to render them, so it can cause a noticeable FPS drop.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementStreamable ( element theElement, bool streamable )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[element]]:setStreamable|streamable|isElementStreamable}}}}

===Required Arguments===
*'''theElement:''' The element you wish to set the streaming of
*'''streamable:''' ''true'' if this element should stream in/out like normal, ''false'' if it should always be streamed in.

===Returns===
Returns whether the element could be set to be streamable.

==Example==
This example creates an [[object]] at the center of the map which will always be streamed in when the resource which contains it starts.
<syntaxhighlight lang="lua">
local function testNonStreamableObjects()
local object = createObject ( 1097, 0, 0, 5 )
setElementStreamable ( object, false ) -- Make the object always be streamed in
end
addEventHandler ( "onClientResourceStart", resourceRoot, testNonStreamableObjects )
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

Template:CEF functions

2015-08-13T15:07:12Z

Sbx320: Added setBrowserAjaxHandler

{{New items|3.0150|1.5|
*[[createBrowser]]
*[[guiCreateBrowser]]
*[[guiGetBrowser]]
*[[executeBrowserJavascript]]
*[[focusBrowser]]
*[[isBrowserFocused]]
*[[getBrowserProperty]]
*[[getBrowserTitle]]
*[[getBrowserURL]]
*[[injectBrowserMouseDown]]
*[[injectBrowserMouseMove]]
*[[injectBrowserMouseUp]]
*[[injectBrowserMouseWheel]]
*[[isBrowserLoading]]
*[[loadBrowserURL]]
*[[setBrowserProperty]]
*[[setBrowserRenderingPaused]]
*[[setBrowserVolume]]
*[[getBrowserSettings]]
*[[isBrowserDomainBlocked]]
*[[requestBrowserDomains]]
|}}
{{New items|3.0160|1.6|
*[[setBrowserAjaxHandler]]
|}}
<noinclude>[[Category:Functions templates]]</noinclude>

SetBrowserAjaxHandler

2015-08-13T15:05:16Z

Sbx320: Created page with "__NOTOC__ {{Client_function}} {{New feature/item|3.0160|1.6|| This function provides a requestable ajax resource for Lua/Javascript communication for a Element/Browser|brows..."

__NOTOC__
{{Client_function}}
{{New feature/item|3.0160|1.6||
This function provides a requestable ajax resource for Lua/Javascript communication for a [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserAjaxHandler ( browser webBrowser, string url[, function handler] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:setAjaxHandler||setBrowserAjaxHandler }}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''url:''' The URL endpoint to handle

===Optional Arguments===
*'''handler:''' The function to call if the webBrowser attempts to open the ajax endpoint. If this parameter is nil or omitted, the ajax handler for the url will be deleted.

===Additional Information===
The handling function (if given), will be called with two tables, representing GET and POST parameters. The handling function may return a string which will be provided to the browser as file content.
{{Warning|Due to CEF Limitations POST parameters do not work and will (until fixed) always be empty.}}

==Example==
This example will output all GET Parameters as well the number of requests made to the ajax endpoint.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

--This is the function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

local counter = 0
setBrowserAjaxHandler(webBrowser, "ajax.html",
function(get, post)
counter = counter+1
local output = string.format("<pre>You have requested this page %d times.\n", counter)
-- List Parameters
local getParameters = "Get Parameters: \n"
for k, v in pairs(get) do
getParameters = getParameters..string.format("[%s] = %s\n", k, v)
end

output = output..getParameters.."</pre>"
return output
end
);

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load our file.
loadBrowserURL(webBrowser, "ajax.html?hello=world")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>
===Returns===
Returns ''true'' if the ajax handler could be created/removed.

==See Also==
{{CEF_functions}}

CreateBrowser

2015-07-02T11:17:43Z

Sbx320: Fixed a typo

__NOTOC__
{{Client_function}}
{{New feature/item|3.0150|1.5||
This function creates a new web [[Element/Browser|browser]] element.
}}

==Syntax==
<syntaxhighlight lang="lua">element createBrowser ( int width, int height, bool isLocal [, bool transparent = false ] )</syntaxhighlight>
{{OOP||[[Element/Browser|Browser]]}}

===Required Arguments===
*'''width:''' The browser's native width
*'''height:''' The browser's native height
*'''isLocal:''' See examples
''
===Optional Arguments===
*'''transparent:''' ''true'' if you want the browser transparent, ''false'' for opaque.

===Returns===
Returns ''true'' if the [[browser]] element was successfully created, ''false'' otherwise. Returns also ''false'', if the user disabled remote pages and ''isLocal'' was set to ''false''.

==Local Example==
This example shows you how to create a fullscreen Webbrowser (showing a local html file) without input-handling.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

--This is the function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load our file.
loadBrowserURL(webBrowser, "html/site.html")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==Remote Example==
This example shows you how to create a fullscreen Webbrowser (showing youtube.com) without input-handling.<br>
Remember, that youtube.com is on the global whitelist. If you want to load a domain/page that is not on the global whitelist, you have to request it with [[requestBrowserDomains|requestBrowserDomains]].
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in remote mode.
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)

--Function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load www.youtube.com
loadBrowserURL(webBrowser, "http://www.youtube.com")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

SetCameraTarget

2015-03-30T01:46:18Z

Sbx320:

__NOTOC__
{{Server client function}}
This function allows you to set a player's camera to follow other elements instead. Currently supported element type is:
*[[Player]]s

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setCameraTarget ( player thePlayer [, player target = nil ] )
</syntaxhighlight>
{{OOP||[[player]]:setCameraTarget|cameraTarget|getCameraTarget}}
===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to modify.

===Optional Arguments===
*'''target:''' The player who you want the camera to follow. If none is specified, the camera will target the player.
'''Note:''' setCameraTarget will behave strangely if the target you want the camera to follow is inside a vehicle that has hydraulics (upgrade id: 1087) added server sided and if the target is not you.
</section>

<section name="Client 1" class="client" show="true">
<syntaxhighlight lang="lua">
bool setCameraTarget ( player target )
</syntaxhighlight>

===Required Arguments===
*'''target:''' The player who you want the local camera to follow.
</section>

{{New feature/item|4.0132|1.3.1|5212|
<section name="Client 2" class="client" show="true">
This syntax mantains the player targeted by the camera, but makes the camera look at the specified coordinates. It has no effect when the camera doesn't have a target.
<syntaxhighlight lang="lua">bool setCameraTarget ( float targetX, float targetY, float targetZ )</syntaxhighlight>

===Required Arguments===
*'''targetX, targetY, targetZ:''' The target position that you want the local camera to look at.
</section>}}

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

==Example==
This is an example of how one could implement a spectator function. Using the left and right arrow keys you can view other players. Note that this code isn't complete as it doesn't take into account joining or quitting players.
<section class="client" name="Client script" show="true">
<syntaxhighlight lang="lua">
g_Players = getElementsByType("player") -- get a list of all players in the server
for i,aPlayer in ipairs(g_Players) do -- find out what index the local player has in the list
if aPlayer == getLocalPlayer() then
g_CurrentSpectated = i
break
end
end

function spectatePrevious() -- decrement the spectate index and spectate the corresponding player
if g_CurrentSpectated == 1 then
g_CurrentSpectated = #g_Players
else
g_CurrentSpectated = g_CurrentSpectated - 1
end
setCameraTarget(g_Players[g_CurrentSpectated])
end

function spectateNext() -- increment the spectate index and spectate the corresponding player
if g_CurrentSpectated == #g_Players then
g_CurrentSpectated = 1
else
g_CurrentSpectated = g_CurrentSpectated + 1
end
setCameraTarget(g_Players[g_CurrentSpectated])
end

-- Bind above functions to arrow keys
bindKey("arrow_l", "down", spectatePrevious)
bindKey("arrow_r", "down", spectateNext)
</syntaxhighlight>
</section>

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

Template:Useful Functions

2014-12-26T21:04:55Z

Sbx320: Added attachEffect

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

UnbindKey

2014-11-18T08:16:23Z

Sbx320: Fixed incorrect bot section

__NOTOC__
{{Server client function}}
Removes an existing key bind from the specified player.
{{Note|unbindKey will only work on binds that were added by the same resource}}
{{Note|unbindKey on the server may return ''true'' on failure}}
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool unbindKey ( player thePlayer, string key, string keyState, string command )
</syntaxhighlight>
<syntaxhighlight lang="lua">
bool unbindKey ( player thePlayer, string key, [ string keyState, function handler ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to unbind the key of.
*'''key:''' The key you wish to unbind. See [[Key names]] for a list of valid key names.
*'''keyState:''' Can be either:
**'''"up":''' If the bound key triggered a function when the key was released
**'''"down":''' If the bound key triggered a function when the key was pressed
**'''"both":''' If the bound key triggered a function when the key was pressed and released
*'''command :''' (Syntax 1) The command you wish to unbind.

===Optional Arguments===
*'''keyState:''' is optional in Syntax 2.
*'''handler:''' (Syntax 2) The function you wish to unbind.
Note: If you do not specify ''handler'', any instances of ''key'' being bound will be unbound, whatever function they are bound to.

===Returns===
Returns '''true'' if the key was unbound, ''false'' if it was not previously bound or invalid arguments were passed to the function.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool unbindKey ( string key, string keyState, string command )
</syntaxhighlight>
<syntaxhighlight lang="lua">
bool unbindKey ( string key, [ string keyState, function handler ] )
</syntaxhighlight>

===Required Arguments===
*'''key:''' The key you wish to unbind. See [[Key names]] for a list of valid key names.
*'''keyState:''' Can be either:
**'''"up":''' If the bound key triggered a function when the key was released
**'''"down":''' If the bound key triggered a function when the key was pressed
**'''"both":''' If the bound key triggered a function when the key was pressed and released
*'''command :''' (Syntax 1) The command you wish to unbind.

===Optional Arguments===
*'''keyState:''' is optional in Syntax 2.
*'''handler:''' (Syntax 2) The function you wish to unbind.
Note: If you do not specify ''handler'', any instances of ''key'' being bound will be unbound, whatever function they are bound to.

===Returns===
Returns '''true'' if the key was unbound, ''false'' if it was not previously bound or invalid arguments were passed to the function.
</section>

==Example==
<section name="Server" class="server" show="true">
This function binds the player's ''F1'' key to a function ''goMoo'' which outputs a chat message when pressed. The key is then unbound so that it can effectively only be used once per life.
<syntaxhighlight lang="lua">
-- define the function that will be called when F1 is pressed
function goMoo( player )
outputChatBox ( getPlayerName ( player ) .. " says Mooooooo!" )
unbindKey ( player, "F1", "down", goMoo ) -- this function will no longer be triggered by the player, after removing the bind.
end

function playerSpawn ( )
bindKey ( source, "F1", "down", goMoo ) -- bind the player's F1 key to the 'goMoo' function defined above
end
addEventHandler ( "onPlayerSpawn", getRootElement(), playerSpawn ) -- make the playerSpawn function be called when a player spawns
</syntaxhighlight>
</section>

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

CreateBlip

2014-11-18T07:40:18Z

Sbx320: Fixed incorrect bot section

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

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

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

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

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

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

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

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

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

==See Also==
{{Blip_functions}}

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

AttachEffect

2014-07-04T02:44:41Z

Sbx320: Created page with "{{Useful Function}} <lowercasetitle/> __NOTOC__ This function allows you to attach an effect to an element. ==Syntax== <syntaxhighlight lang="lua">bool attachEffect(effect theEffect, element..."

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to attach an effect to an element.
==Syntax==
<syntaxhighlight lang="lua">bool attachEffect(effect theEffect, element theElement, [vector3 vecOffset])</syntaxhighlight>

===Required arguments===
* '''theEffect''': The effect which should be attached.
* '''theElement''': The element, which the effect should be attached to.

===Optional arguments===
* '''vecOffset''': a Vector3 describing the offset position similar to attachElements.

===Return===
Returns true

==Code==
<syntaxhighlight lang="lua">
local attachedEffects = {}

-- Taken from https://wiki.multitheftauto.com/wiki/GetElementMatrix example
function getPositionFromElementOffset(element,offX,offY,offZ)
local m = getElementMatrix ( element ) -- Get the matrix
local x = offX * m[1][1] + offY * m[2][1] + offZ * m[3][1] + m[4][1] -- Apply transform
local y = offX * m[1][2] + offY * m[2][2] + offZ * m[3][2] + m[4][2]
local z = offX * m[1][3] + offY * m[2][3] + offZ * m[3][3] + m[4][3]
return x, y, z -- Return the transformed point
end

function attachEffect(effect, element, pos)
attachedEffects[effect] = { effect = effect, element = element, pos = pos }
addEventHandler("onClientElementDestroy", effect, function() attachedEffects[effect] = nil end)
addEventHandler("onClientElementDestroy", element, function() attachedEffects[effect] = nil end)
return true
end

addEventHandler("onClientPreRender", root,
function()
for fx, info in pairs(attachedEffects) do
local x, y, z = getPositionFromElementOffset(info.element, info.pos.x, info.pos.y, info.pos.z)
setElementPosition(fx, x, y, z)
end
end
)

</syntaxhighlight>

==Example==
<section name="Example" class="server" show="true">
This example attachs a fire on top of the local player's vehicle.
<syntaxhighlight lang="lua">
local pov = getPedOccupiedVehicle(localPlayer)
local fx = createEffect("fire", pov.position)
attachEffect(fx, pov, Vector3(0, 0, 2))
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

Changes in 1.4

2014-06-24T21:16:03Z

Sbx320: Removed duplicate isChatVisible, Added isTrainChainEngine

{{Changelogs}}

== Main Additions / Changes ==
* Localization of MTA's menus
* [[OOP]] classes
* [[Matrix|Matrices]] and [[Vector|Vectors]]
* Significantly improved train synchronization
* Improved all sound functions to work with player elements

== Scripting ==

=== Scripting: New functions ===

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

==== Server ====
* Added [[isBan]]
* Added [[setBanAdmin]]
* Added [[setBanReason]]
* Added [[setUnbanTime]]
* Added [[getAccountsBySerial]]
* Added [[getAccountSerial]]

==== Shared (''Client & Server side'') ====
* Added additional optional parameter bInstant to setPlayerMoney to instantly set the money without counting up/down
* Fixed toJSON/fromJSON not handling binary data properly

=== Scripting: New Events ===

==== Client ====
* Added [[onClientFileDownloadComplete]]

==== Server ====
* Added [[onWeaponFire]]

=== Scripting: Changes, Bugfixes and Additions ===
* Fixed getResourceConfig() not working on foreign resources
* Fixed the Brown Streak Carriage (ID: 570)
* Changed attachTrailerToVehicle to support trains

== Client ==

=== Client: Additions ===
* Distinguish between left and right Shift, Ctrl and Alt presses.
* Added SettingHUDMatchAspectRatio, SettingAspectRatio to dxGetStatus

=== Client: Bugfixes & Changes ===
* Fixed the money "counts down" GTA-Style when you change a server.
* Fixed peds being invulnerable to gun fire when doing a drive by.
* Fixed onClientPlayerDamage not triggering for spray can.
* Satchels should now be removed on [[resetMapInfo]]
* Fixed getPedMoveState returns false when moving in crouch state
* Fixed guiScrollPaneGetVerticalScrollPosition returning strange and stepped values.
* Fixed setPedCameraRotation not working.
* Fixed peds continuing to fire their weapons after running out of ammo.

== Server ==

=== Server: Additions ===
* [[setElementDimension]] should now apply to children
* More descriptive module error messages
* Commands: unloadmodule and reloadmodule
* Added server side custom weapons.

=== Server: Bugfixes & Changes ===
* Fixed 128 character limit in [[setAccountData]]
* Wildcard bans should now be checked properly on connect
* Fixed Team members not being sent to clients if set in [[onResourceStart]].

== Resources ==
* None yet

== Editor ==
* None yet

== Extra information ==
''More detailed information available on [https://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and Google Code repositories:
:* [https://code.google.com/p/mtasa-blue/source/list MTA: SA Blue]
:* [https://code.google.com/p/mtasa-resources/source/list MTA: SA Official Resources]

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

GetTeamWithFewestPlayers

2014-06-14T15:53:54Z

Sbx320: Undo revision 39866 by Le'CC (talk)

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function gets a team from it's few players.
'''Note:''' If 2 teams has the same count, then the first one found will be returned!
==Syntax==
<syntaxhighlight lang="lua">team getFewPlayersOnTeams ( element team1,element team2)</syntaxhighlight>

===Return===
Returns a [[team]] else false.

==Code==
<syntaxhighlight lang="lua">
function getFewPlayersOnTeams(team1,team2)
if (isElement(team1) and getElementType(team1) == "team") and (isElement(team2) and getElementType(team2) == "team") then
local team1C = countPlayersInTeam (team1)
local team2C = countPlayersInTeam (team2)
if team1C == team2C then return team1
else
if team1C == math.min(team1C,team2C) then
return team1
else
return team2
end
end
end
return false
end
</syntaxhighlight>

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

<syntaxhighlight lang="lua">

function setPlayerToTeam(source)
local redteam = getTeamFromName ( "Red" )
local blueteam = getTeamFromName ( "Blue" )
if redteam and blueteam then
local theteam = getfewPlayersOnTeams(redteam,blueteam)
if theteam then
setPlayerTeam(source,theteam)
local PlayerName = getPlayerName ( source )
outputChatBox ( " " .. joinedPlayerName .. " Joined "..getTeamName(theteam).." team !" , root, 255, 255, 255 )
end
else
createTeam ("Red",255,0,0)
createTeam ("Blue",0,0,255)
setPlayerToTeam(source)
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), setPlayerToTeam )

</syntaxhighlight>
</section>

Author: Booo

==See Also==
{{Useful_Functions}}

OnClientVehicleCollision

2014-06-09T17:25:05Z

Sbx320: Formatting

{{Client event}}
__NOTOC__
This event is triggered when a vehicle collides with peds/vehicles/objects.

==Parameters==
<syntaxhighlight lang="lua">
element theHitElement, float force, int bodypart, float collisionX, float collisionY, float collisionZ, float normalX, float normalY, float normalZ, float hitElementForce, int model
</syntaxhighlight>
'''Note:''' ''theHitElement'' will be nil or false if it's a default SA object and it will trigger twice for vehicles because one vehicle hit another and one got hit by another.
*'''theHitElement:''' the other entity, or nil if the vehicle collided with the world
*'''force:''' the impact magnitude (Note: this is NOT the damage it is a force value which is then multiplied by the vehicles collision damage multiplier. for an example of this see below)
*'''bodyPart:''' the bodypart that hit the other element
*'''collisionX/Y/Z:''' the position the collision took place
*'''normalX/Y/Z:''' the surface normal of the hit object
*'''hitElementforce:''' 0 for non vehicles or the force of the other vehicle
*'''model:''' model of the hit element (useful to detect building collisions as hitElement will be nil)

==Type==
This event is a pre reaction event meaning it occurs before any game level reaction to the collision which include:
* Bike knock off effect
* Collision particles
* All types of damage reaction such as broken wings, wind shields, engine damage, broken lights and so on
* Audio of the impact

==Source==
The source of this event is the vehicle that collided with something.

==Issues==
{{Issues|
{{Issue|7422|onClientVehicleCollision doesnt trigger when hitting some frozen objects}}
}}

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleCollision", root,
function(collider,force, bodyPart, x, y, z, nx, ny, nz)
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- force does not take into account the collision damage multiplier (this is what makes heavy vehicles take less damage than banshees for instance) so take that into account to get the damage dealt
local fDamageMultiplier = getVehicleHandling(source).collisionDamageMultiplier
-- Create a marker (Scaled down to 1% of the actual damage otherwise we will get huge markers)
local m = createMarker(x, y, z, "corona", force * fDamageMultiplier * 0.01, 0, 9, 231)
-- Destroy the marker in 2 seconds
setTimer(destroyElement, 2000, 1, m)
end
end
)

</syntaxhighlight>

<syntaxhighlight lang="lua">
-- This code works because onClientVehicleCollision is triggered before any SA reaction to the collision, therefore we can update the knocked off bike status just before the collision and stop the falling off effect happening :)
addEventHandler("onClientVehicleCollision", root,
function ( hit )
-- firstly did we trigger this event
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- knock off defaults to false
local knockOff = false
-- if our hit element is nil (we just hit an SA map object)
if ( hit == nil ) then
-- set knockOff to true
knockOff = true
end

-- update our can be knocked off bike status accordingly
setPedCanBeKnockedOffBike(localPlayer, knockOff)
end
end
)

</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

OnClientVehicleCollision

2014-06-09T17:23:58Z

Sbx320: Test fix #2 for dev-wiki bot not recognizing parameters

{{Client event}}
__NOTOC__
This event is triggered when a vehicle collides with peds/vehicles/objects.
'''Note:''' ''theHitElement'' will be nil or false if it's a default SA object and it will trigger twice for vehicles because one vehicle hit another and one got hit by another.

==Parameters==
<syntaxhighlight lang="lua">
element theHitElement, float force, int bodypart, float collisionX, float collisionY, float collisionZ, float normalX, float normalY, float normalZ, float hitElementForce, int model
</syntaxhighlight>
*'''theHitElement:''' the other entity, or nil if the vehicle collided with the world
*'''force:''' the impact magnitude (Note: this is NOT the damage it is a force value which is then multiplied by the vehicles collision damage multiplier. for an example of this see below)
*'''bodyPart:''' the bodypart that hit the other element
*'''collisionX/Y/Z:''' the position the collision took place
*'''normalX/Y/Z:''' the surface normal of the hit object
*'''hitElementforce:''' 0 for non vehicles or the force of the other vehicle
*'''model:''' model of the hit element (useful to detect building collisions as hitElement will be nil)

==Type==
This event is a pre reaction event meaning it occurs before any game level reaction to the collision which include:
* Bike knock off effect
* Collision particles
* All types of damage reaction such as broken wings, wind shields, engine damage, broken lights and so on
* Audio of the impact

==Source==
The source of this event is the vehicle that collided with something.

==Issues==
{{Issues|
{{Issue|7422|onClientVehicleCollision doesnt trigger when hitting some frozen objects}}
}}

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleCollision", root,
function(collider,force, bodyPart, x, y, z, nx, ny, nz)
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- force does not take into account the collision damage multiplier (this is what makes heavy vehicles take less damage than banshees for instance) so take that into account to get the damage dealt
local fDamageMultiplier = getVehicleHandling(source).collisionDamageMultiplier
-- Create a marker (Scaled down to 1% of the actual damage otherwise we will get huge markers)
local m = createMarker(x, y, z, "corona", force * fDamageMultiplier * 0.01, 0, 9, 231)
-- Destroy the marker in 2 seconds
setTimer(destroyElement, 2000, 1, m)
end
end
)

</syntaxhighlight>

<syntaxhighlight lang="lua">
-- This code works because onClientVehicleCollision is triggered before any SA reaction to the collision, therefore we can update the knocked off bike status just before the collision and stop the falling off effect happening :)
addEventHandler("onClientVehicleCollision", root,
function ( hit )
-- firstly did we trigger this event
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- knock off defaults to false
local knockOff = false
-- if our hit element is nil (we just hit an SA map object)
if ( hit == nil ) then
-- set knockOff to true
knockOff = true
end

-- update our can be knocked off bike status accordingly
setPedCanBeKnockedOffBike(localPlayer, knockOff)
end
end
)

</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

OnClientVehicleCollision

2014-06-09T17:22:58Z

Sbx320: Test fix for dev-wiki bot not recognizing parameters

{{Client event}}
__NOTOC__
This event is triggered when a vehicle collides with peds/vehicles/objects.

==Parameters==
'''Note:''' ''theHitElement'' will be nil or false if it's a default SA object and it will trigger twice for vehicles because one vehicle hit another and one got hit by another.
<syntaxhighlight lang="lua">
element theHitElement, float force, int bodypart, float collisionX, float collisionY, float collisionZ, float normalX, float normalY, float normalZ, float hitElementForce, int model
</syntaxhighlight>
*'''theHitElement:''' the other entity, or nil if the vehicle collided with the world
*'''force:''' the impact magnitude (Note: this is NOT the damage it is a force value which is then multiplied by the vehicles collision damage multiplier. for an example of this see below)
*'''bodyPart:''' the bodypart that hit the other element
*'''collisionX/Y/Z:''' the position the collision took place
*'''normalX/Y/Z:''' the surface normal of the hit object
*'''hitElementforce:''' 0 for non vehicles or the force of the other vehicle
*'''model:''' model of the hit element (useful to detect building collisions as hitElement will be nil)

==Type==
This event is a pre reaction event meaning it occurs before any game level reaction to the collision which include:
* Bike knock off effect
* Collision particles
* All types of damage reaction such as broken wings, wind shields, engine damage, broken lights and so on
* Audio of the impact

==Source==
The source of this event is the vehicle that collided with something.

==Issues==
{{Issues|
{{Issue|7422|onClientVehicleCollision doesnt trigger when hitting some frozen objects}}
}}

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleCollision", root,
function(collider,force, bodyPart, x, y, z, nx, ny, nz)
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- force does not take into account the collision damage multiplier (this is what makes heavy vehicles take less damage than banshees for instance) so take that into account to get the damage dealt
local fDamageMultiplier = getVehicleHandling(source).collisionDamageMultiplier
-- Create a marker (Scaled down to 1% of the actual damage otherwise we will get huge markers)
local m = createMarker(x, y, z, "corona", force * fDamageMultiplier * 0.01, 0, 9, 231)
-- Destroy the marker in 2 seconds
setTimer(destroyElement, 2000, 1, m)
end
end
)

</syntaxhighlight>

<syntaxhighlight lang="lua">
-- This code works because onClientVehicleCollision is triggered before any SA reaction to the collision, therefore we can update the knocked off bike status just before the collision and stop the falling off effect happening :)
addEventHandler("onClientVehicleCollision", root,
function ( hit )
-- firstly did we trigger this event
if ( source == getPedOccupiedVehicle(localPlayer) ) then
-- knock off defaults to false
local knockOff = false
-- if our hit element is nil (we just hit an SA map object)
if ( hit == nil ) then
-- set knockOff to true
knockOff = true
end

-- update our can be knocked off bike status accordingly
setPedCanBeKnockedOffBike(localPlayer, knockOff)
end
end
)

</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

ES/Resource:Editor

2014-05-27T23:09:36Z

Sbx320: Shouldn't be in English categories

{{Resource page}}
El editor de mapas de MTA:SA te permite crear mapas para los modos de juego.
Para iniciarlo, simplemente presiona "Map Editor" en el menú principal de MTA

==Menus==
Una vez que el editor haya comenzado, se te mostrarán dos menús de barras: la principal (arriba), y la de elementos (esquina inferior izquierda).

===Menú principal===
Estos son los botones en el menú principal:
* [[Image:Editor_New.png]] Crear un nuevo mapa.
* [[Image:Editor_Open.png]] Abrir un mapa existente.
* [[Image:Editor_Save.png]] Grabar el mapa en que estás trabajando.
* [[Image:Editor_Save_as.png]] Grabar el mapa bajo un nombre diferente.
* [[Image:Editor_Options.png]] Modificar las opciones generales del editor.
* [[Image:Editor_Undo.png]] Deshacer la última acción.
* [[Image:Editor_Redo.png]] Restaurar la última acción deshecha.
* [[Image:Editor_Locations.png]] Lista de lugares "marcados" (como los Favoritos).
* [[Image:Editor_Current_elements.png]] Lista de todos los elementos contenidos en el mapa (vehículos, objetos, marcadores, pickups, etc).
* [[Image:Editor_Map_settings.png]] Propiedades del mapa, como el tiempo o la gravedad. Aquí también puedes especificar los modos de juego que son compatibles con tu mapa.
* [[Image:Editor_Definitions.png]] Cargar las [[Resource:Editor/EDF| Definiciones del Editor (EDF)]].
* [[Image:Editor_Test.png]] Probar el mapa.

===Menú de elementos===
El menú de elementos es usado para agregar nuevos elementos al mapa.
* [[Image:Editor_Vehicle.png]] Crear un vehículo.
* [[Image:Editor_Object.png]] Crear un objeto (edificios, caminos, basura, árboles, rocas, decoración exterior, etc).
* [[Image:Editor_Pickup.png]] Crear un pickup (sólo se puede crear de vida, armadura o de un arma).
* [[Image:Editor_Marker.png]] Crear un marcador.

Adicionalmente, si tienes una [[Resource:Editor/EDF| Definición de Editor (EDF)]] cargada, girando la rueda del ratón (con el cursor sobre el menú) puedes cargar los elementos derivados de esa definición.

==Usando el editor==
Esta sección te explicará cómo crear y modificar mapas.

===Moviéndose alrededor del mapa===
Al iniciarse el editor, inicias en el ''modo de cámara''. Puedes usar las teclas '''WSAD''' para mover la cámara, y el ratón para girarla. Cuando te muevas, puedes mantener la tecla '''ALT''' para moverte más lento, o la tecla '''SHIFT''' para ir más rápido.

Para acceder a la interfaz del editor y al panel de control, necesitas cambiar al ''modo de cursor''. Puedes cambiar entre el modo de cursor y el modo de cámara con la tecla '''F'''. Cuando estés en modo de cursor, tu vista estará congelada, y solo podrás usar el cursor del ratón para manipular elementos y usar la interfaz gráfica.

El modo de cámara puede ser reconocido por una mira en medio de la pantalla. Puedes usarla para seleccionar y mover elementos como en el modo de cursor. Esta mira luce así:

[[Image:Editor_Crosshair.png|center]]

===Empezando un nuevo mapa===
* Inicia el editor, o si ya está iniciado, apreta el boton ''Nuevo'' del menú.
* Apreta el botón ''Opciones de mapa''. En la pestaña ''Meta'', llena los campos de "Name" y "Author" con el nombre de tu mapa y tu nick en MTA, respectivamente. También abre la pestaña ''Gamemodes'' y agrega los modos de juego para los cuales tu mapa está hecho (éstos se van a mover a la lista de ''Added Gamemodes''). Puedes hacer esto seleccionándolos y apretando en ''Add'', o haciendo doble click sobre ellos. Apreta OK cuando estés listo.
[[Image:Editor_Mapsettings.png|center]]
* Apreta en la ventana de ''Definiciones'' y agrega los recursos en donde uses los elementos alternativos. Estos debieran consistir de los modos que tu seleccionaste en la ventana de ''Map settings'', ademas de eventuales recursos adicionales. Para mas informacion acerca de las definiciones del editor, ve [[Resource:Editor/EDF|EDF (En Inglés)]]. Apreta OK cuando estes listo.

===Creando nuevos elementos===
* Si tu estas en el modo de camara, cambia al modo de cursor primero apretando '''F'''.
* Apreta un boton en el menu de elementos que represente lo que tu quieres. Ej: Apreta el boton con un auto en el para agregar un vehiculo.
* Un nuevo elemento del tipo seleccionado sera creado y pegado a tu cursor. Muevelo a la posicion que quieras y apreta el '''botón izquierdo''' para dejarlo.

[[Image:Editor_Addelem.png|center]]

Para crear un elemento alternativo que es especifico a un recurso, mueve tu cursor sobre el menu de elementos y gira la rueda del ratón hasta el recurso esperado. Ten en cuenta que para este trabajo, primero necesitas haber agregado el archivo de [[Resource:Editor/EDF|Definición de editor]] del recurso en la ventana ''Definitions''.

[[Image:Editor_Selectedf.png|center]]

===Seleccionando===
* '''Click izquierdo''' sobre un elemento para seleccionarlo en ''modo de teclado''.
* '''Click derecho''' sobre este elemento para seleccionarlo en ''modo de ratón''.
* Apreta la '''Barra espaciadora''' o apreta sobre un area vacia para sacar la selección.

El elemento elegido, si lo hay, es representado por un marcador de cono amarillo. Elementos (particularmente objetos) con pesima colision se peuden detectar facilmente activando el ''modo de alta sensibilidad'', apretando la tecla '''E'''. Esto incrementara la detección.

El dialogo ''Current elements'' puede ser usado tambien para seleccionar elementos. Has doble-click sobre un item de la lista para seleccionarlo en ''modo de teclado''

===Moviendo===
El movimiento de los elementos se puede hacer de muchas maneras:

'''Con el ratón'''
* Simplemente selecciónalo y déjalo con el '''boton izquierdo'''
O bien:
* Selecciona el elemento en el modo de ratón ('''boton derecho'''), muévelo hacia la posición que quieras, y haz clic izquierdo para dejarlo.

También puedes ajustar la ''distancia'' de un elemento acercándolo o alejándolo de la cámara mediante el cambio al modo de cámara. Haz ''''clic derecho''' en un elemento, y gira la '''rueda del ratón'''.

'''Con el teclado'''
* Selecciona el elemento en el modo de teclado ('''clic izquierdo''').
* Luego, usa las '''teclas de dirección''' para mover el elemento en un plano horizontal (ejes ''X'' y ''Z''), y '''RePág'''/'''AvPág''' para moverlo verticalmente (eje Z). Mantén presionado '''ALT''' para disminuir la velocidad de movimiento, y '''SHIFT''' para incrementarla.

Por defecto, los elementos se mueven relativamente a la cámara y no están limitadas a sus ejes. Esto se puede desactivar en el menú de '''Opciones'''.

===Rotando===

'''Con el ratón'''
Puedes rotar un elemento selecionado en el eje Z, con la rueda del ratón.
* Seleciona el elemento con un clic (derecho o izquierdo) y ruédala mantiendo apretado '''CTRL'''.

'''Con el teclado'''
* Selecciona el elemento ('''clic izquierdo''').
* Mientras se presiona '''CTRL''' (la marca de selección se volverá verde), y usa las '''teclas de dirección''' o '''RePág'''/'''AvPág''' para rotar el elemento en los 3 ejes.

En ambos métodos, puedes presionar '''ALT''' para reducir la velocidad de rotación del elemento, y '''SHIFT''' para incrementarla.

[[Image:Editor_Rotateelem.png|center]]

===Cambio de modelo y otras propiedades===
La mayoría de los elementos tiene una variedad de opciones que pueden ser alteradas para cambiar su apariencia. Ejemplos son los modelos, color y las actualizaciones visuales de un auto.

* Abre la ventana de propiedades de un elemento, presionando dos veces en el o seleccionándolo y apretando '''F3'''.
* Hace las modificaciones que tu quieras. Por ejemplo, para cambiar el modelo de un auto o objeto, presiona en el botón '''Browse''' al lado de "model" para abrir el buscador de modelos.
* presiona OK cuando estés listo

[[Image:Editor_Props.png|center]]

===Clonando===
Puedes clonar un elemento seleccionándolo y presionando '''C'''.

* En el modo de cursor, este elemento clonado será "adjuntado" a tu cursor. Para posicionarlo haz click con el botón izquierdo.
* En el modo de teclado, el elemento será puesto en la misma posición del elemento original.

Si presionas '''CTRL''' mientras haces click, el elemento será clonado otra vez.

También puedes usar el botón ''Pullout'' de la esquina inferior derecha de la ventana de propiedades del elemento.

===Borrando===
Simplemente selecciona el elemento y pulsa ''SUPR''' ''(Borrar o Suprimir)''.

También puedes usar el botón ''Pullout'' de la esquina inferior derecha de la ventana de propiedades del elemento.

==Creando mapas para modos de juego específicos==
Para lograr esto, tienes que hacer 2 cosas.
* Clickea '''Map Settings''' en la barra superior del editor, busca la sección '''Gamemodes'''. De ahí seleccionas los modos de juego en los que tu mapa se puede usar.
* También necesitarás usar [[Resource:Editor/EDF|Archivos de Definición del Editor]] (EDF, o sea Editor Definition Files). Estos te permiten poner elementos de un modo de juego en específico, ya sean puntos de Spawn, las banderas de CTF, etc... Los EDF se cargan desde la sección "Definitions", en "Map Settings".

==Controles==
Aquí tienes la lista de los controles por defecto. Para editarlos, debes ir a la sección "Binds", en "Settings", en el menú de MTA, mientras el editor está abierto.

===Cámara===
{|
|-
| camera_move_forwards
| '''w'''
|-
| camera_move_backwards
| '''s'''
|-
| camera_move_left
| '''a'''
|-
| camera_move_right
| '''d'''
|-
| high_sensitivity_mode
| '''e'''
|}

===Clonación===
{|
|-
| clone_selected_element
| '''c'''
|-
| clone_drop_modifier
| '''lctrl''' || ''(Left CTRL)''
|}

===Manipulación de elementos===
{|
|-
| element_move_forward
| '''arrow_u''' || ''(Arrow key Up)''
|-
| element_move_backward
| '''arrow_d''' || ''(Arrow key Down)''
|-
| element_move_left
| '''arrow_l''' || ''(Arrow key Left)''
|-
| element_move_right
| '''arrow_r''' || ''(Arrow key Right)''
|-
| element_move_downwards
| '''pgdn''' || ''(Page Down)''
|-
| element_move_upwards
| '''pgup''' || ''(Page Up)''
|-
| zoom_in
| '''mouse_wheel_down'''
|-
| zoom_out
| '''mouse_wheel_up'''
|-
| quick_rotate_increase
| '''mod_rotate''' + '''mouse_wheel_up''' || ''(Left CTRL + Mouse wheel Up)''
|-
| quick_rotate_decrease
| '''mod_rotate''' + '''mouse_wheel_down''' || ''(Left CTRL + Mouse wheel Down)''
|-
| mod_rotate
| '''lctrl''' || ''(Left CTRL)''
|-
| mod_slow_speed
| '''lalt''' || ''(Left ALT)''
|-
| mod_fast_speed
| '''lshift''' || ''(Left SHIFT)''
|-
| destroy_selected_element
| '''delete'''
|-
| drop_selected_element
| '''space'''
|-
| pickup_selected_element
| '''F2'''
|-
| reset_rotation
| '''mod_rotate''' + '''r''' || ''(Left CTRL + R)''
|}

===GUI (Interfaz Gráfica)===
{|
| toggle_gui_display
| '''F4'''
|-
| toggle_cursor
| '''f'''
|-
| select_target_keyboard
| '''mouse1''' || ''(Left Mouse button)''
|-
| select_target_mouse
| '''mouse2''' || ''(Right Mouse button)''
|-
| edf_next
| '''mouse_wheel_up'''
|-
| edf_prev
| '''mouse_wheel_down'''
|-
| undo
| '''Ctrl''' + '''z'''
|-
| redo
| '''Ctrl''' + '''y'''
|-
| properties_toggle
| '''F3'''
|-
| browser_up
| '''arrow_u''' || ''(Arrow key Up)''
|-
| browser_down
| '''arrow_d''' || ''(Arrow key Down)''
|-
| browser_zoom_in
| '''mouse_wheel_up'''
|-
| browser_zoom_out
| '''mouse_wheel_down'''
|-
| browser_confirm
| '''enter'''
|-
| currentelements_up
| '''num_8''' || ''(Numpad key 8)''
|-
| currentelements_down
| '''num_2''' || ''(Numpad key 2)''
|-
| toggle_test
| '''F5'''
|}

==Multijugador==
El editor de mapas está hecho para que se pueda usar por más de un jugador a la vez. Esto se hace copiando los "resources" que usa el editor, a tu servidor. Luego tienes que iniciarlo y ya puedes hacer mapas con otros jugadores.

Nota: no hay sistema de restricciones en el editor; todos los jugadores tienen los mismos permisos para editar el mapa.

==Plugins y Recursos externos==
{{Main|Resource:Editor/Plugins}}

El editor permite una importación básica de recursos externos. Esto es útil para "resources" que manipulan o crean objetos que el editor no puede, como vehículos con modelos modificados.

Usando el comando '''import <nombreDeResource>''' en la consola, los elementos del resource pueden ser importados al editor.

==Preguntas Frecuentes==
==== No veo nada (pantalla negra) al usar el editor ====

Generalmente esto ocurre debido a una mala instalación del editor de mapas. Si usas una versión estable de MTA, prueba a instalarlo de nuevo, y asegúrate de que las opciones "Client" y "Server" del instalador estén marcadas.

En cambio, si usas una versión "nightly", debes bajar la última versión de los[http://code.google.com/p/multitheftauto/wiki/NightlyBuilds?tm=2 "resources" (paso 3)], descomprimir el archivo y colocar su contenido en:
''MTA San Andreas\server\mods\deathmatch\resources'', donde ''MTA San Andreas'' es la carpeta donde instalaste MTA San Andreas (por defecto es: C:\Archivos de Programa\MTA San Andreas).

'''Poner los archivos en: MTA San Andreas\mods\deathmatch\resources es un error común''' - no funcionarán ahí. Asegúrate de que dentro de la ruta donde colocas los archivos encuentres la palabra "server".

Si este problema persiste aún después de haber hecho los pasos mencionados y revisada la versión actual, puede ser porque tienes una versión obsoleta del archivo ''acl.xml''. Puedes descargarlo [http://multitheftauto.googlecode.com/svn/trunk/MTA10_Server/mods/deathmatch/acl.xml aquí]. Una vez descargado, colócalo en la carpeta '''MTA San Andreas/server/mods/deathmatch/'''.

==== Me sale un mensaje que dice "Could not start the local server. See console for details" al iniciar el editor ====
Esto pasa porque tu archivo ''mtaserver.conf'' está dañado o está mal editado. Puedes descargarlo [http://multitheftauto.googlecode.com/svn/trunk/MTA10_Server/mods/deathmatch/editor.conf aquí]. Debes colocarlo en '''MTA San Andreas/server/mods/deathmatch/'''.

==== Guardé un mapa con el editor, pero no lo encuentro en la carpeta resources. Sin embargo el editor lo carga en la lista ====
Esto se debe a que Windows Vista/7 tiene cietos límites de escritura para procesos no administrativos del directorio Archivos de Programa. Los archivos se guardan en el directorio "VirtualStore" en vez de en Archivos de Programa. Deberías poder encontrar tu mapa en el directorio:
C:\Usuarios\<NOMBRE>\AppData\Local\VirtualStore\Program Files\MTA San Andreas\server\mods\deathmatch\resources\

Si inicias el servidor o el cliente de MTA con derechos administrativos, tu mapa debería ser guardado en el lugar correcto.

==== Encontré un error o tengo una sugerencia ====
Visita el [http://bugs.mtasa.com sistema de seguimiento de errores] oficial. También puedes ingresar al [http://www.multitheftauto.com/irc.html canal de IRC].

==Traductores==

*Gothem
*F4ST3R
*Benxamix2/The Kid

[[ru:Resource:Editor]]
[[en:Resource:Editor]]

PlaySFX3D

2014-05-23T11:36:46Z

Sbx320: r6444 Update

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound in the GTA world 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 pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, 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
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

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

{{New feature/item|4.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX3D( string "radio", string radioStation, int trackId, float x, float y, float z [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===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 fire alarm sound near you (looped).
<syntaxhighlight lang="lua">
local x, y, z = getElementPosition(localPlayer)
if not playSFX3D("script", 7, 1, x + 10, y, z, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

PlaySFX

2014-05-23T11:36:22Z

Sbx320: r6444 Update

__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 pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid 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.

{{New feature/item|4.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file

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

PlaySFX3D

2014-05-23T11:05:22Z

Sbx320: r6443 Update

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound in the GTA world 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 pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, 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
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

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

{{New feature/item|4.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX3D( string "radio", string radioStation, int trackId, float x, float y, float z [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "KROSE", "K-DST", "Cutscene", "Beats", "Bounce FM", "SFUR", "Radio Los Santos", "Radio X", "CSR", "K-JAH", "Master Sounds", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===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 fire alarm sound near you (looped).
<syntaxhighlight lang="lua">
local x, y, z = getElementPosition(localPlayer)
if not playSFX3D("script", 7, 1, x + 10, y, z, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

PlaySFX

2014-05-23T11:02:47Z

Sbx320: Formatting

__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 pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid 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.

{{New feature/item|4.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "KROSE", "K-DST", "Cutscene", "Beats", "Bounce FM", "SFUR", "Radio Los Santos", "Radio X", "CSR", "K-JAH", "Master Sounds", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file

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

2014-05-23T11:02:33Z

Sbx320: r6443 Update

__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 pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
In case of these invalid 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.

{{New feature/item|4.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "KROSE", "K-DST", "Cutscene", "Beats", "Bounce FM", "SFUR", "Radio Los Santos", "Radio X", "CSR", "K-JAH", "Master Sounds", "WCTR".
*'''trackId :''' The radio track id within the radio station audio file

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

Client Scripting Events

2014-04-22T04:46:10Z

Sbx320: Undo revision 39430 by Domtheo (talk) Spambot

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==GUI events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[pl:Zdarzenia_po_stronie_klienta]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]

Vehicle IDs

2014-04-22T04:45:34Z

Sbx320: Undo revision 39429 by Domtheo (talk) Spambot

==Introduction==
This is a list of GTA:SA's vehicle ID numbers, as listed in the vehicles.ide file. These vehicle ID numbers are used for several vehicle scripting functions.

Lua table of all the valid vehicle IDs listed on this page:
<syntaxhighlight lang="lua">vehicleIDS = { 602, 545, 496, 517, 401, 410, 518, 600, 527, 436, 589, 580, 419, 439, 533, 549, 526, 491, 474, 445, 467, 604, 426, 507, 547, 585,
405, 587, 409, 466, 550, 492, 566, 546, 540, 551, 421, 516, 529, 592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460,
417, 469, 487, 513, 581, 510, 509, 522, 481, 461, 462, 448, 521, 468, 463, 586, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454, 485, 552, 431,
438, 437, 574, 420, 525, 408, 416, 596, 433, 597, 427, 599, 490, 432, 528, 601, 407, 428, 544, 523, 470, 598, 499, 588, 609, 403, 498, 514, 524,
423, 532, 414, 578, 443, 486, 515, 406, 531, 573, 456, 455, 459, 543, 422, 583, 482, 478, 605, 554, 530, 418, 572, 582, 413, 440, 536, 575, 534,
567, 535, 576, 412, 402, 542, 603, 475, 449, 537, 538, 441, 464, 501, 465, 564, 568, 557, 424, 471, 504, 495, 457, 539, 483, 508, 571, 500,
444, 556, 429, 411, 541, 559, 415, 561, 480, 560, 562, 506, 565, 451, 434, 558, 494, 555, 502, 477, 503, 579, 400, 404, 489, 505, 479, 442, 458,
606, 607, 610, 590, 569, 611, 584, 608, 435, 450, 591, 594 }</syntaxhighlight>

Lua table of vehicles that are not lockable:
<syntaxhighlight lang="lua">notLockableVehicles = {594, 606, 607, 611, 584, 608, 435, 450, 591, 539, 441, 464, 501, 465, 564, 472, 473, 493, 595, 484, 430,
453, 452, 446, 454, 581, 509, 481, 462, 521, 463, 510, 522, 461, 448, 468, 586, 425, 520}</syntaxhighlight>
Lua table of vehicles without number plates:
<syntaxhighlight lang="lua">noNumberPlates = { 592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460, 417, 469, 487, 513, 509, 481,
510, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454 }</syntaxhighlight>

==2-Door and Compact cars==
<table border="1" class="unnamed1">
<tr><th>Name</th><th>ID</th><td></td><th>Name</th><th>ID</th></tr><tr><td>Alpha</td><td>602</td><td></td><td>Hustler</td><td>545</td></tr><tr><td>Blista Compact</td><td>496</td><td> </td><td>Majestic</td><td>517</td></tr><tr><td>Bravura</td><td>401</td><td> </td><td>Manana</td><td>410</td></tr><tr><td>Buccaneer</td><td>518</td><td> </td><td>Picador</td><td>600</td></tr><tr><td>Cadrona</td><td>527</td><td> </td><td>Previon</td><td>436</td></tr><tr><td>Club</td><td>589</td><td> </td><td>Stafford</td><td>580</td></tr><tr><td>Esperanto</td><td>419</td><td> </td><td>Stallion</td><td>439</td></tr><tr><td>Feltzer</td><td>533</td><td> </td><td>Tampa</td><td>549</td></tr><tr><td>Fortune</td><td>526</td><td> </td><td>Virgo</td><td>491</td></tr><tr><td>Hermes</td><td>474</td><td> </td><td> </td><td> </td></tr></table>

== 4-Door and Luxury cars==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Admiral</td><td>445</td><td> </td><td>Oceanic</td><td>467</td></tr><tr><td>Damaged Glendale</td><td>604</td><td> </td><td>Premier</td><td>426</td></tr><tr><td>Elegant</td><td>507</td><td> </td><td>Primo</td><td>547</td></tr><tr><td>Emperor</td><td>585</td><td> </td><td>Sentinel</td><td>405</td></tr><tr><td>Euros</td><td>587</td><td> </td><td>Stretch</td><td>409</td></tr><tr><td>Glendale</td><td>466</td><td> </td><td>Sunrise</td><td>550</td></tr><tr><td>Greenwood</td><td>492</td><td> </td><td>Tahoma</td><td>566</td></tr><tr><td>Intruder</td><td>546</td><td> </td><td>Vincent</td><td>540</td></tr><tr><td>Merit</td><td>551</td><td> </td><td>Washington</td><td>421</td></tr><tr><td>Nebula</td><td>516</td><td> </td><td>Willard</td><td>529</td></tr></table>

==Aircraft==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>
Name</th><th>ID</th></tr><tr><td>Andromada</td><td>592</td><td> </td><td>
Nevada</td><td>553</td></tr><tr><td>AT-400</td><td>577</td><td> </td><td>

News Chopper</td><td>488</td></tr><tr><td>Beagle</td><td>511</td><td> </td><td>
Police Maverick</td><td>497</td></tr><tr><td>Cargobob</td><td>548</td><td> </td><td>
Raindance</td><td>563</td></tr><tr><td>Cropduster</td><td>512</td><td> </td><td>

Rustler</td><td>476</td></tr><tr><td>Dodo</td><td>593</td><td> </td><td>
Seasparrow</td><td>447</td></tr><tr><td>Hunter</td><td>425</td><td> </td><td>
Shamal</td><td>519</td></tr><tr><td>Hydra</td><td>520</td><td> </td><td>

Skimmer</td><td>460</td></tr><tr><td>Leviathan</td><td>417</td><td> </td><td>
Sparrow</td><td>469</td></tr><tr><td>Maverick</td><td>487</td><td> </td><td>
Stuntplane</td><td>513</td></tr></table>

==Bikes==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>BF-400</td><td>581</td><td> </td><td>Mountain Bike</td><td>510</td></tr><tr><td>Bike</td><td>509</td><td> </td><td>NRG-500</td><td>522</td> </tr><tr><td>BMX</td><td>481</td><td> </td><td>PCJ-600</td><td>461</td></tr><tr><td>Faggio</td><td>462</td><td> </td><td>Pizza Boy</td><td>448</td></tr><tr><td>FCR-900</td><td>521</td><td> </td><td>Sanchez</td><td> 468</td></tr><tr><td>Freeway</td><td>463</td><td> </td><td>Wayfarer</td><td>586</td></tr></table>

==Boats==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Coastguard</td><td>472</td></tr><tr><td>Dinghy</td><td>473</td></tr><tr><td>Jetmax</td><td>493</td></tr><tr><td>Launch</td><td>595</td></tr><tr><td>Marquis</td><td>484</td></tr><tr><td>Predator</td><td>430</td></tr><tr><td>Reefer</td><td>453</td></tr><tr><td>Speeder</td><td>452</td></tr><tr><td>Squalo</td><td>446</td></tr><tr><td>Tropic</td><td>454</td></tr></table>

==Civil Servant / Public Transportation (Road Vehicles)==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr>
<tr><td>Baggage</td><td>485</td></tr>
<tr><td>Utility Van</td><td>552</td></tr>
<tr><td>Bus</td><td>431</td></tr>
<tr><td>Cabbie</td><td>438</td></tr>
<tr><td>Coach</td><td>437</td></tr>
<tr><td>Sweeper</td><td>574</td></tr>
<tr><td>Taxi</td><td>420</td></tr>
<tr><td>Towtruck</td><td>525</td></tr>
<tr><td>Trashmaster</td><td>408</td></tr></table>

==Government Vehicles==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Ambulance</td><td>416</td><td> </td><td>Police Car (Los Santos)</td><td>596</td></tr><tr><td>Barracks</td><td>433</td><td> </td><td>Police Car (San Fierro)</td><td>597</td></tr><tr><td>Enforcer</td><td>427</td><td> </td><td>Police Ranger</td><td>599</td></tr><tr><td>FBI Rancher</td><td>490</td><td> </td><td>Rhino</td><td>432</td></tr><tr><td>FBI Truck</td><td>528</td><td> </td><td>S.W.A.T.</td><td>601</td></tr><tr><td>Fire Truck</td><td>407</td><td> </td><td>Securicar</td><td>428</td></tr><tr><td>Fire Truck (Ladder)</td><td>544</td><td> </td><td> </td><td> </td></tr><tr><td>HPV1000</td><td>523</td><td> </td><td> </td><td> </td></tr><tr><td>Patriot</td><td>470</td><td> </td><td> </td><td> </td></tr><tr><td>Police Car (Las Venturas)</td><td>598</td><td> </td><td> </td><td> </td></tr></table>

==Heavy and Utility Trucks==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Benson</td><td>499</td><td> </td><td>Hotdog</td><td>588</td></tr><tr><td>Black Boxville</td><td>609</td><td> </td><td>Linerunner</td><td>403</td></tr><tr><td>Boxville</td><td>498</td><td> </td><td>Linerunner (From "Tanker Commando")</td><td>514</td></tr><tr><td>Cement Truck</td><td>524</td><td> </td><td>Mr. Whoopee</td><td>423</td></tr><tr><td>Combine Harvester</td><td>532</td><td> </td><td>Mule</td><td>414</td></tr><tr><td>DFT-30</td><td>578</td><td> </td><td>Packer</td><td>443</td></tr><tr><td>Dozer</td><td>486</td><td> </td><td>Roadtrain</td><td>515</td></tr><tr><td>Dumper</td><td>406</td><td> </td><td>Tractor</td><td>531</td></tr><tr><td>Dune</td><td>573</td><td> </td><td>Yankee</td><td>456</td></tr><tr><td>Flatbed</td><td>455</td><td> </td><td> </td><td> </td></tr></table>

==Light Trucks and Vans==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Berkley's RC Van</td><td>459</td><td> </td><td>Sadler</td><td>543</td></tr><tr><td>Bobcat</td><td>422</td><td> </td><td>Tug</td><td>583</td></tr><tr><td>Burrito</td><td>482</td><td> </td><td>Walton</td><td>478</td></tr><tr><td>Damaged Sadler</td><td>605</td><td> </td><td>Yosemite</td><td>554</td></tr><tr><td>Forklift</td><td>530</td><td> </td><td> </td><td> </td></tr><tr><td>Moonbeam</td><td>418</td><td> </td><td> </td><td> </td></tr><tr><td>Mower</td><td>572</td><td> </td><td> </td><td> </td></tr><tr><td>News Van</td><td>582</td><td> </td><td> </td><td> </td></tr><tr><td>Pony</td><td>413</td><td> </td><td> </td><td> </td></tr><tr><td>Rumpo</td><td>440</td><td> </td><td> </td><td> </td></tr></table>

==Lowriders==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Blade</td><td>536</td></tr><tr><td>Broadway</td><td>575</td></tr><tr><td>Remington</td><td>534</td></tr><tr><td>Savanna</td><td>567</td></tr><tr><td>Slamvan</td><td>535</td></tr><tr><td>Tornado</td><td>576</td></tr><tr><td>Voodoo</td><td>412</td></tr></table>

==Muscle Cars==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Buffalo</td><td>402</td></tr><tr><td>Clover</td><td>542</td></tr><tr><td>Phoenix</td><td>603</td></tr><tr><td>Sabre</td><td>475</td></tr></table>

==Trains and Railroad Cars==

<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><th>Notes</th></tr>
<tr><td>Tram</td><td>449</td><td></td></tr>
<tr><td>Freight</td><td>537</td><td></td></tr>
<tr><td>Brown Streak</td><td>538</td><td></td></tr>
<tr><td>Brown Streak Carriage</td><td>570</td><td>Removed in version [https://code.google.com/p/mtasa-blue/source/detail?r=2880 1.1-r2880], but available from [https://code.google.com/p/mtasa-blue/source/detail?r=5934 1.3.4-r5934] and forth.</tr>
<tr><td>Flat Freight</td><td>569</td><td></td></tr>
<tr><td>Box Freight</td><td>590</td><td></td></tr></table>

==RC Vehicles==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>RC Bandit</td><td>441</td></tr><tr><td>RC Baron</td><td>464</td></tr><tr><td>RC Goblin</td><td>501</td></tr><tr><td>RC Raider</td><td>465</td></tr><tr><td>RC Tiger</td><td>564</td></tr></table>

==Recreational==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Bandito</td><td>568</td><td> </td><td>Monster 3</td><td>557</td></tr><tr><td>BF Injection</td><td>424</td><td> </td><td>Quadbike</td><td>471</td></tr><tr><td>Bloodring Banger</td><td>504</td><td> </td><td>Sandking</td><td>495</td></tr><tr><td>Caddy</td><td>457</td><td> </td><td>Vortex</td><td>539</td></tr><tr><td>Camper</td><td>483</td><td> </td><td> </td><td> </td></tr><tr><td>Journey</td><td>508</td><td> </td><td> </td><td> </td></tr><tr><td>Kart</td><td>571</td><td> </td><td> </td><td> </td></tr><tr><td>Mesa</td><td>500</td><td> </td><td> </td><td> </td></tr><tr><td>Monster</td><td>444</td><td> </td><td> </td><td> </td></tr><tr><td>Monster 2</td><td>556</td><td> </td><td> </td><td> </td></tr></table>

==Street Racers==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Banshee</td><td>429</td><td> </td><td>Infernus</td><td>411</td></tr><tr><td>Bullet</td><td>541</td><td> </td><td>Jester</td><td>559</td></tr><tr><td>Cheetah</td><td>415</td><td> </td><td>Stratum</td><td>561</td></tr><tr><td>Comet</td><td>480</td><td> </td><td>Sultan</td><td>560</td></tr><tr><td>Elegy</td><td>562</td><td> </td><td>Super GT</td><td>506</td></tr><tr><td>Flash</td><td>565</td><td> </td><td>Turismo</td><td>451</td></tr><tr><td>Hotknife</td><td>434</td><td> </td><td>Uranus</td><td>558</td></tr><tr><td>Hotring Racer</td><td>494</td><td> </td><td>Windsor</td><td>555</td></tr><tr><td>Hotring Racer 2</td><td>502</td><td> </td><td>ZR-350</td><td>477</td></tr><tr><td>Hotring Racer 3</td><td>503</td><td> </td><td> </td><td> </td></tr></table>

==SUVs and Wagons==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Huntley</td><td>579</td></tr><tr><td>Landstalker</td><td>400</td></tr><tr><td>Perennial</td><td>404</td></tr><tr><td>Rancher</td><td>489</td></tr><tr><td>Rancher (From "Lure")</td><td>505</td></tr><tr><td>Regina</td><td>479</td></tr><tr><td>Romero</td><td>442</td></tr><tr><td>Solair</td><td>458</td></tr></table>

==Trailers==
<table border="1" class="unnamed1"><tr><th width="218">Name</th><th width="24">ID</th></tr><tr><td>Baggage Trailer (covered)</td><td>606</td></tr><tr><td>Baggage Trailer (Uncovered)</td><td>607</td></tr><tr><td>Farm Trailer</td><td>610</td></tr><tr></tr><tr></tr><tr><td>"Street Clean" Trailer</td><td>611</td></tr><tr><td>Trailer (From "Tanker Commando")(*PRONE TO CRASHES*)</td><td>584</td></tr><tr><td>Trailer (Stairs)</td><td>608</td></tr><tr><td>Trailer 1</td><td>435</td></tr><tr><td>Trailer 2</td><td>450</td></tr><tr><td>Trailer 3</td><td>591</td></tr></table>

==Misc==
<table border="1" class="unnamed1"><tr><th width="218">Name</th><th width="24">ID</th></tr><tr><td>RC Cam (flower pot)</td><td>594</td></table>
<br>

==Vehicle Functions==
{{Vehicle functions}}

==See Also==
[[id|ID Lists]]
[[it:ID Veicoli]]
[[ru:Vehicle IDs]]
[[de:Fahrzeug IDs]]

[[Category:ID Lists]]

SpawnPlayer

2014-04-06T10:50:52Z

Sbx320:

__NOTOC__
{{Server function}}
This function spawns the player at an arbitary point on the map.<br>
{{Note|[[setCameraTarget]] must be used to focus on the player. Also, all players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a [[fadeCamera]] after.}}

{{Note|Do not use [[spawnPlayer]] within an event handler remotely called from [[onClientPlayerWasted]]. See Issue #8148 for details.}}

==Syntax==
<syntaxhighlight lang="lua">
bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you want to spawn.
*'''x:''' The x co-ordinate to spawn the player at.
*'''y:''' The y co-ordinate to spawn the player at.
*'''z:''' The z co-ordinate to spawn the player at.

===Optional Arguments===
*'''rotation:''' rotation of the player on spawn.
*'''skinID:''' player's skin on spawn. [[Character Skins]]
*'''interior:''' interior the player will spawn into. [[Interior IDs]]
*'''dimension:''' The ID of the [[dimension]] that the player should be in.
*'''theTeam:''' the team the player will join.

===Returns===
Returns ''true'' if the player was spawned successfully, ''false'' otherwise.

==Example==
This example spawns all the players in the middle of the game map.
<syntaxhighlight lang="lua">
-- Get a table of all the players
players = getElementsByType ( "player" )
-- Go through every player
for playerKey, playerValue in ipairs(players) do
-- Spawn them at the desired coordinates
spawnPlayer ( playerValue, 0.0, 0.0, 5.0, 90.0, 0 )
end
</syntaxhighlight>

This example spawns a player when he logs in.
<syntaxhighlight lang="lua">
spawnTeam = createTeam ("Teamname", 255, 0, 0) -- Create team to spawn.
function spawnOnLogin (prevA, curA, autoLogin)
outputChatBox ("Welcome to ...", source, 255, 0, 0, false)
spawnPlayer (source, 0, 0, 5, 0, math.random (0,288), 0, 0, spawnTeam) -- spawns player with random skin
fadeCamera (source, true)
setCameraTarget (source, source)
end
addEventHandler("onPlayerLogin", getRootElement(), spawnOnLogin)
</syntaxhighlight>

==See Also==
{{Player_functions}}
[[ru:spawnPlayer]]

SpawnPlayer

2014-04-06T10:50:00Z

Sbx320: Added note about Issue #8148

__NOTOC__
{{Server function}}
This function spawns the player at an arbitary point on the map.<br>
{{Note|[[setCameraTarget]] must be used to focus on the player. Also, all players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a [[fadeCamera]] after.}}

{{Note|Do not use [[spawnPlayer]] within an event handler remotely called from [[onClientPlayerWasted]]. See http://bugs.mtasa.com/view.php?id=8148 for details.}}

==Syntax==
<syntaxhighlight lang="lua">
bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you want to spawn.
*'''x:''' The x co-ordinate to spawn the player at.
*'''y:''' The y co-ordinate to spawn the player at.
*'''z:''' The z co-ordinate to spawn the player at.

===Optional Arguments===
*'''rotation:''' rotation of the player on spawn.
*'''skinID:''' player's skin on spawn. [[Character Skins]]
*'''interior:''' interior the player will spawn into. [[Interior IDs]]
*'''dimension:''' The ID of the [[dimension]] that the player should be in.
*'''theTeam:''' the team the player will join.

===Returns===
Returns ''true'' if the player was spawned successfully, ''false'' otherwise.

==Example==
This example spawns all the players in the middle of the game map.
<syntaxhighlight lang="lua">
-- Get a table of all the players
players = getElementsByType ( "player" )
-- Go through every player
for playerKey, playerValue in ipairs(players) do
-- Spawn them at the desired coordinates
spawnPlayer ( playerValue, 0.0, 0.0, 5.0, 90.0, 0 )
end
</syntaxhighlight>

This example spawns a player when he logs in.
<syntaxhighlight lang="lua">
spawnTeam = createTeam ("Teamname", 255, 0, 0) -- Create team to spawn.
function spawnOnLogin (prevA, curA, autoLogin)
outputChatBox ("Welcome to ...", source, 255, 0, 0, false)
spawnPlayer (source, 0, 0, 5, 0, math.random (0,288), 0, 0, spawnTeam) -- spawns player with random skin
fadeCamera (source, true)
setCameraTarget (source, source)
end
addEventHandler("onPlayerLogin", getRootElement(), spawnOnLogin)
</syntaxhighlight>

==See Also==
{{Player_functions}}
[[ru:spawnPlayer]]

MergeToDoList

2014-02-09T19:55:41Z

Sbx320:

==Merge/SVN things that need doing==
All devs with commit access should add stuff to these lists so it doesn't get lost

==Things that need merging from trunk to current release==
====Important bug fixes for 1.3.4====

==Things that need merging from trunk for next point release==
====New features for 1.3.5====
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6122 6122] TODO * Fixed #8044 (ElementFrozen for Players is desynced after spawnPlayer)'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6097 6097] Added setInteriorFurnitureEnabled, getInteriorFurnitureEnabled
*[https://code.google.com/p/mtasa-blue/source/detail?r=6094 6094] Fixed GUIScrollPaneSetHorizontalScrollPosition and GUIScrollPaneSetVerticalScrollPosition not correctly using floating point numbers
*[https://code.google.com/p/mtasa-blue/source/detail?r=6093 6093] Fixed #8006 ([Request] Make an mtasa:// protocol typo handler)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6061 6061] TODO * Update for r5934 - Some fixes'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6051 6051] Updated date
*[https://code.google.com/p/mtasa-blue/source/detail?r=6050 6050] Fixed #7953 (Add rotation parameter for dxDrawText)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6047 6047] Fixed #7965 (Cannot bind num_enter key)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6045 6045] Make glitches more compatible with latency_reduction mode.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6043 6043] Fixed crouch roll glitch
*[https://code.google.com/p/mtasa-blue/source/detail?r=6042 6042] Fixed r7964 (getVehicleComponentPosition seems to return wrong positions on some vehicles)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6041 6041] Addendum to r6039 (Added add/removeDebugHook for client)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6040 6040] Fixed #7632: Bullet sync for sniper rifle. Fixed #7614: rifle has not damage without aim.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6039 6039] Added add/removeDebugHook for client
*[https://code.google.com/p/mtasa-blue/source/detail?r=6036 6036] Fix gui skin change crash
*[https://code.google.com/p/mtasa-blue/source/detail?r=6033 6033] Fixed vehicle color desync caused by setting paintjob. Fixed crash caused...
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6032 6032] TODO * Update for r5934 - See below. Fixed some streaming issues if train chain is...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6031 6031] Added upgrade message to uninstaller. Added disk space checks.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6030 6030] Fixed #7962 (Vehicle wheel states are not synced properly)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6029 6029] Improved client error messages, esp. when loading fonts and images
*[https://code.google.com/p/mtasa-blue/source/detail?r=6028 6028] Fixed #7956 (Several vehicle colours result into black ones)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6011 6011] Fixed synced health and armor values so the fractional part is more consistent
*[https://code.google.com/p/mtasa-blue/source/detail?r=6009 6009] Fixed #7389 (Problem with network floaters)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6008 6008] Addendum to r5999 (Added getCamera function to get the camera element)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6001 6001] Fixed #5854 (Client runs with reduced mathematical precision compared to the server.)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6000 6000] Disabled destroyElement and setElementParent for the camera element
*[https://code.google.com/p/mtasa-blue/source/detail?r=5999 5999] Added getCamera function to get the camera element
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5969 5969] TODO * Update for r5934 - Fixed some streaming issues (It's nearly finished)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5967 5967] TODO * Update for r5934 - Fixed a desync (train will be teleported when driving from...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5963 5963] Fixed onClientSoundStopped sometimes being late
*[https://code.google.com/p/mtasa-blue/source/detail?r=5962 5962] Fixed includes failing when a resource changes.
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5935 5935] TODO * Update for r5934 - Some/more fixes'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5934 5934] TODO * Fixed train carriages and re-enabled the Brownstreak Carriage (ID: 570)'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex
*[https://code.google.com/p/mtasa-blue/source/detail?r=5889 5889] Added onClientVehicleDamage event
*[https://code.google.com/p/mtasa-blue/source/detail?r=5882 5882] Added dxSetTextureEdge (allows you to set the texture edge for other texture types such as renderTargets + setting the border color) ('''NOTE:''' ''This commit needs to be partially merged since it contains a compile fix for 1.4'')
*[https://code.google.com/p/mtasa-blue/source/detail?r=5867 5867] Fixed #7413 (Damage proof boats still take collision damage)
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex, ...
*[https://code.google.com/p/mtasa-blue/source/detail?r=5852 5852] + [https://code.google.com/p/mtasa-blue/source/detail?r=5853 5853] Fixed an inconsistence (isPedDead is server-only; isPlayerDead available on the
client, but on the server deprecated)
*'''[https://https://code.google.com/p/mtasa-blue/source/detail?r=5318 5318] TODO * Fixed train spawning
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5289 5289] TODO * Added train rail position, rail speed, rail track and direction to sync should
make trains smoother
* teaEncode etc
* preg stuff
==Reminders for 1.4==
http://code.google.com/p/mtasa-blue/source/detail?r=5324

FileIsEOF

2014-01-28T16:35:27Z

Sbx320:

__NOTOC__
{{Server client function}}

Checks if the file position is at the end of the file.
{{Note|Due to underlying C API restrictions this function may return false until an attempt to read further than the end of the file is made.}}

==Syntax==
<syntaxhighlight lang="lua">
bool fileIsEOF ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' A handle to the file you wish to check.

===Returns===
Returns ''true'' if the file position of the specified file is at the end of the file, ''false'' otherwise.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer) -- ... and output them to the console
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

When you open a file, its file position is set to the beginning of the file. Each call to [[fileRead]] or [[fileWrite]] moves the position ahead by the amount of bytes that were read/written. This way, by using ''fileIsEOF'' you can check if you've passed through the whole file.

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

MergeToDoList

2014-01-25T14:30:39Z

Sbx320:

==Merge/SVN things that need doing==
All devs with commit access should add stuff to these lists so it doesn't get lost

==Things that need merging from trunk to current release==
====Important bug fixes for 1.3.4====

==Things that need merging from trunk for next point release==
====New features for 1.3.5====
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6094 6094] TODO * Fixed GUIScrollPaneSetHorizontalScrollPosition and GUIScrollPaneSetVerticalScrollPosition not correctly using floating point numbers'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6093 6093] TODO * Fixed #8006 ([Request] Make an mtasa:// protocol typo handler)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6061 6061] TODO * Update for r5934 - Some fixes'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6051 6051] Updated date
*[https://code.google.com/p/mtasa-blue/source/detail?r=6050 6050] Fixed #7953 (Add rotation parameter for dxDrawText)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6047 6047] Fixed #7965 (Cannot bind num_enter key)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6045 6045] Make glitches more compatible with latency_reduction mode.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6043 6043] Fixed crouch roll glitch
*[https://code.google.com/p/mtasa-blue/source/detail?r=6042 6042] Fixed r7964 (getVehicleComponentPosition seems to return wrong positions on some vehicles)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6041 6041] Addendum to r6039 (Added add/removeDebugHook for client)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6040 6040] Fixed #7632: Bullet sync for sniper rifle. Fixed #7614: rifle has not damage without aim.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6039 6039] Added add/removeDebugHook for client
*[https://code.google.com/p/mtasa-blue/source/detail?r=6036 6036] Fix gui skin change crash
*[https://code.google.com/p/mtasa-blue/source/detail?r=6033 6033] Fixed vehicle color desync caused by setting paintjob. Fixed crash caused...
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6032 6032] TODO * Update for r5934 - See below. Fixed some streaming issues if train chain is...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6031 6031] Added upgrade message to uninstaller. Added disk space checks.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6030 6030] Fixed #7962 (Vehicle wheel states are not synced properly)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6029 6029] Improved client error messages, esp. when loading fonts and images
*[https://code.google.com/p/mtasa-blue/source/detail?r=6028 6028] Fixed #7956 (Several vehicle colours result into black ones)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6011 6011] Fixed synced health and armor values so the fractional part is more consistent
*[https://code.google.com/p/mtasa-blue/source/detail?r=6009 6009] Fixed #7389 (Problem with network floaters)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6008 6008] Addendum to r5999 (Added getCamera function to get the camera element)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6001 6001] Fixed #5854 (Client runs with reduced mathematical precision compared to the server.)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6000 6000] Disabled destroyElement and setElementParent for the camera element
*[https://code.google.com/p/mtasa-blue/source/detail?r=5999 5999] Added getCamera function to get the camera element
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5969 5969] TODO * Update for r5934 - Fixed some streaming issues (It's nearly finished)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5967 5967] TODO * Update for r5934 - Fixed a desync (train will be teleported when driving from...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5963 5963] Fixed onClientSoundStopped sometimes being late
*[https://code.google.com/p/mtasa-blue/source/detail?r=5962 5962] Fixed includes failing when a resource changes.
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5935 5935] TODO * Update for r5934 - Some/more fixes'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5934 5934] TODO * Fixed train carriages and re-enabled the Brownstreak Carriage (ID: 570)'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex
*[https://code.google.com/p/mtasa-blue/source/detail?r=5889 5889] Added onClientVehicleDamage event
*[https://code.google.com/p/mtasa-blue/source/detail?r=5882 5882] Added dxSetTextureEdge (allows you to set the texture edge for other texture types such as renderTargets + setting the border color) ('''NOTE:''' ''This commit needs to be partially merged since it contains a compile fix for 1.4'')
*[https://code.google.com/p/mtasa-blue/source/detail?r=5867 5867] Fixed #7413 (Damage proof boats still take collision damage)
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex, ...
*[https://code.google.com/p/mtasa-blue/source/detail?r=5852 5852] + [https://code.google.com/p/mtasa-blue/source/detail?r=5853 5853] Fixed an inconsistence (isPedDead is server-only; isPlayerDead available on the
client, but on the server deprecated)
*'''[https://https://code.google.com/p/mtasa-blue/source/detail?r=5318 5318] TODO * Fixed train spawning
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5289 5289] TODO * Added train rail position, rail speed, rail track and direction to sync should
make trains smoother
* teaEncode etc
* preg stuff
==Reminders for 1.4==
http://code.google.com/p/mtasa-blue/source/detail?r=5324

MergeToDoList

2014-01-25T14:21:18Z

Sbx320:

==Merge/SVN things that need doing==
All devs with commit access should add stuff to these lists so it doesn't get lost

==Things that need merging from trunk to current release==
====Important bug fixes for 1.3.4====

==Things that need merging from trunk for next point release==
====New features for 1.3.5====
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6092 6092] TODO * Fixed #7944 (Server can crash when calling setControlState with a ped)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6061 6061] TODO * Update for r5934 - Some fixes'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6051 6051] Updated date
*[https://code.google.com/p/mtasa-blue/source/detail?r=6050 6050] Fixed #7953 (Add rotation parameter for dxDrawText)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6047 6047] Fixed #7965 (Cannot bind num_enter key)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6045 6045] Make glitches more compatible with latency_reduction mode.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6043 6043] Fixed crouch roll glitch
*[https://code.google.com/p/mtasa-blue/source/detail?r=6042 6042] Fixed r7964 (getVehicleComponentPosition seems to return wrong positions on some vehicles)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6041 6041] Addendum to r6039 (Added add/removeDebugHook for client)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6040 6040] Fixed #7632: Bullet sync for sniper rifle. Fixed #7614: rifle has not damage without aim.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6039 6039] Added add/removeDebugHook for client
*[https://code.google.com/p/mtasa-blue/source/detail?r=6036 6036] Fix gui skin change crash
*[https://code.google.com/p/mtasa-blue/source/detail?r=6033 6033] Fixed vehicle color desync caused by setting paintjob. Fixed crash caused...
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=6032 6032] TODO * Update for r5934 - See below. Fixed some streaming issues if train chain is...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=6031 6031] Added upgrade message to uninstaller. Added disk space checks.
*[https://code.google.com/p/mtasa-blue/source/detail?r=6030 6030] Fixed #7962 (Vehicle wheel states are not synced properly)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6029 6029] Improved client error messages, esp. when loading fonts and images
*[https://code.google.com/p/mtasa-blue/source/detail?r=6028 6028] Fixed #7956 (Several vehicle colours result into black ones)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6011 6011] Fixed synced health and armor values so the fractional part is more consistent
*[https://code.google.com/p/mtasa-blue/source/detail?r=6009 6009] Fixed #7389 (Problem with network floaters)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6008 6008] Addendum to r5999 (Added getCamera function to get the camera element)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6001 6001] Fixed #5854 (Client runs with reduced mathematical precision compared to the server.)
*[https://code.google.com/p/mtasa-blue/source/detail?r=6000 6000] Disabled destroyElement and setElementParent for the camera element
*[https://code.google.com/p/mtasa-blue/source/detail?r=5999 5999] Added getCamera function to get the camera element
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5969 5969] TODO * Update for r5934 - Fixed some streaming issues (It's nearly finished)'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5967 5967] TODO * Update for r5934 - Fixed a desync (train will be teleported when driving from...'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5963 5963] Fixed onClientSoundStopped sometimes being late
*[https://code.google.com/p/mtasa-blue/source/detail?r=5962 5962] Fixed includes failing when a resource changes.
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5935 5935] TODO * Update for r5934 - Some/more fixes'''
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5934 5934] TODO * Fixed train carriages and re-enabled the Brownstreak Carriage (ID: 570)'''
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex
*[https://code.google.com/p/mtasa-blue/source/detail?r=5889 5889] Added onClientVehicleDamage event
*[https://code.google.com/p/mtasa-blue/source/detail?r=5882 5882] Added dxSetTextureEdge (allows you to set the texture edge for other texture types such as renderTargets + setting the border color) ('''NOTE:''' ''This commit needs to be partially merged since it contains a compile fix for 1.4'')
*[https://code.google.com/p/mtasa-blue/source/detail?r=5867 5867] Fixed #7413 (Damage proof boats still take collision damage)
*[https://code.google.com/p/mtasa-blue/source/detail?r=5924 5924] Added guiEditGetCaretIndex and guiMemoGetCaretIndex, ...
*[https://code.google.com/p/mtasa-blue/source/detail?r=5852 5852] + [https://code.google.com/p/mtasa-blue/source/detail?r=5853 5853] Fixed an inconsistence (isPedDead is server-only; isPlayerDead available on the
client, but on the server deprecated)
*'''[https://https://code.google.com/p/mtasa-blue/source/detail?r=5318 5318] TODO * Fixed train spawning
*'''[https://code.google.com/p/mtasa-blue/source/detail?r=5289 5289] TODO * Added train rail position, rail speed, rail track and direction to sync should
make trains smoother
* teaEncode etc
* preg stuff
==Reminders for 1.4==
http://code.google.com/p/mtasa-blue/source/detail?r=5324

GetPedOccupiedVehicleSeat

2013-11-26T17:59:39Z

Sbx320:

__NOTOC__
{{Server function}}
This function gets the seat that a specific ped is sitting in in a vehicle.

==Syntax==
<syntaxhighlight lang="lua">int getPedOccupiedVehicleSeat ( ped thePed )</syntaxhighlight>

===Required Arguments===
*'''thePed''': The [[ped]] whose vehicle seat you're looking up.

===Returns===
Returns an integer containing the number of the seat that the ped is currently in, if any. Seat 0 represents the driver's seat, any higher represents a passenger seat. Returns ''false'' if the ped is on foot, or the ped doesn't exist.

==Example==
This example finds what seat a random player is sitting in and outputs it to the chat box.
<syntaxhighlight lang="lua">
thePed = getRandomPlayer()
theVehicle = getPedOccupiedVehicle ( thePed )
if ( theVehicle ) then
outputChatBox ( getPlayerName(thePed).." is in a vehicle in seat number " .. getPedOccupiedVehicleSeat ( thePed ) .. "." )
else
outputChatBox ( getPlayerName(thePed).." is not in a vehicle." )
end
</syntaxhighlight>

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

GetPedOccupiedVehicleSeat

2013-11-26T17:58:59Z

Sbx320: Clarification for seat ids

__NOTOC__
{{Server function}}
This function gets the seat that a specific ped is sitting in in a vehicle.

==Syntax==
<syntaxhighlight lang="lua">int getPedOccupiedVehicleSeat ( ped thePed )</syntaxhighlight>

===Required Arguments===
*'''thePed''': The [[ped]] whose vehicle seat you're looking up.

===Returns===
Returns an integer containing the number of the seat that the ped is currently in, if any. Seat 0 represents the driver, any higher represents a passenger seat. Returns ''false'' if the ped is on foot, or the ped doesn't exist.

==Example==
This example finds what seat a random player is sitting in and outputs it to the chat box.
<syntaxhighlight lang="lua">
thePed = getRandomPlayer()
theVehicle = getPedOccupiedVehicle ( thePed )
if ( theVehicle ) then
outputChatBox ( getPlayerName(thePed).." is in a vehicle in seat number " .. getPedOccupiedVehicleSeat ( thePed ) .. "." )
else
outputChatBox ( getPlayerName(thePed).." is not in a vehicle." )
end
</syntaxhighlight>

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

PlaySFX

2013-08-25T00:13:17Z

Sbx320: Changed some wordings

OnPlayerWasted

2013-08-16T11:40:27Z

Sbx320: Undo revision 36915 by Soner Sayakci (talk)

__NOTOC__
{{Server event}}
This event is triggered when a player is killed or dies.

==Parameters==
{{New feature/item|3|1.0||<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>}}

{{Deprecated_feature|3|1.0|<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart
</syntaxhighlight>}}

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[Weapons|killer weapon]] or the [[Death Reasons|death reason]].
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*{{New feature/item|3|1.0||'''stealth''': boolean value representing whether or not this was a stealth kill}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that died or got killed.

==Example==
This example prints the killer and bodypart to the chat when a player dies.
<syntaxhighlight lang="lua">
-- register player_Wasted as a handler for onPlayerWasted
function player_Wasted ( ammo, attacker, weapon, bodypart )
-- if there was an attacker
if ( attacker ) then
-- we declare our variable outside the following checks
local tempString
-- if the element that killed him was a player,
if ( getElementType ( attacker ) == "player" ) then
-- put the attacker, victim and weapon info in the string
tempString = getPlayerName ( attacker ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
-- else, if it was a vehicle,
elseif ( getElementType ( attacker ) == "vehicle" ) then
-- we'll get the name from the attacker vehicle's driver
local tempString = getPlayerName ( getVehicleController ( attacker ) ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
end
-- if the victim was shot in the head, append a special message
if ( bodypart == 9 ) then
tempString = tempString.." (HEADSHOT!)"
-- else, just append the bodypart name
else
tempString = tempString.." ("..getBodyPartName ( bodypart )..")"
end
-- display the message
outputChatBox ( tempString )
-- if there was no attacker,
else
-- output a death message without attacker info
outputChatBox ( getPlayerName ( source ).." died. ("..getWeaponNameFromID ( weapon )..") ("..getBodyPartName ( bodypart )..")" )
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), player_Wasted )
</syntaxhighlight>

And another example, this will spawn you in the middle of GTA SA world (x=0, y=0, z=3) after 2 seconds of your death
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerWasted", getRootElement( ),
function()
setTimer( spawnPlayer, 2000, 1, source, 0, 0, 3 )
end
)
</syntaxhighlight>

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

OnPlayerWasted

2013-08-16T11:40:04Z

Sbx320: Undo revision 36914 by Soner Sayakci (talk)

__NOTOC__
{{Server event}}
This event is triggered when a player is killed or dies.

==Parameters==
{{New feature/item|3|1.0||<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>}}

{{Deprecated_feature|3|1.0|<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart
</syntaxhighlight>}}

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[Weapons|killer weapon]] or the [[Death Reasons|death reason]].
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*{{New feature/item|3|1.0||'''stealth''': boolean value representing whether or not this was a stealth kill}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that died or got killed.

==Example==
This example prints the killer and bodypart to the chat when a player dies.
<syntaxhighlight lang="lua">
-- register player_Wasted as a handler for onPlayerWasted
function player_Wasted ( attacker, weapon, bodypart )
-- if there was an attacker
if ( attacker ) then
-- we declare our variable outside the following checks
local tempString
-- if the element that killed him was a player,
if ( getElementType ( attacker ) == "player" ) then
-- put the attacker, victim and weapon info in the string
tempString = getPlayerName ( attacker ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
-- else, if it was a vehicle,
elseif ( getElementType ( attacker ) == "vehicle" ) then
-- we'll get the name from the attacker vehicle's driver
local tempString = getPlayerName ( getVehicleController ( attacker ) ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
end
-- if the victim was shot in the head, append a special message
if ( bodypart == 9 ) then
tempString = tempString.." (HEADSHOT!)"
-- else, just append the bodypart name
else
tempString = tempString.." ("..getBodyPartName ( bodypart )..")"
end
-- display the message
outputChatBox ( tempString )
-- if there was no attacker,
else
-- output a death message without attacker info
outputChatBox ( getPlayerName ( source ).." died. ("..getWeaponNameFromID ( weapon )..") ("..getBodyPartName ( bodypart )..")" )
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), player_Wasted )
</syntaxhighlight>

And another example, this will spawn you in the middle of GTA SA world (x=0, y=0, z=3) after 2 seconds of your death
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerWasted", getRootElement( ),
function()
setTimer( spawnPlayer, 2000, 1, source, 0, 0, 3 )
end
)
</syntaxhighlight>

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

Template:Client vehicle events

2013-05-23T17:15:46Z

Sbx320: onClientVehicleDrown does not exist in the trunk, but only in jb-contrib

*[[onClientVehicleRespawn]]
*[[onClientVehicleEnter]]
*[[onClientVehicleExit]]
*[[onClientVehicleExplode]]
*[[onClientVehicleStartEnter]]
*[[onClientVehicleStartExit]]
*[[onClientTrailerAttach]]
*[[onClientTrailerDetach]]
{{New feature/item|3.0130|1.3|3653|
*[[onClientVehicleCollision]]
}}
{{New feature/item|4.0132|1.3.1|5012|
*[[onClientVehicleNitroStateChange]]
}}
<noinclude>[[Category:Events templates]]</noinclude>

PowerupManager

2013-05-12T13:31:29Z

Sbx320: Seems to be a resource and not a module

{{Outdated|}}

The [[PowerupManager|powerupManager]] library was created to ease the use of advanced, more custom pickups (powerups).

It exists out of server and client scripts to create, handle and destroy custom powerup items.

Advanced features contain: custom clientside animations (spin, up-down), custom collision element for triggering, server side triggering (to prevent cheating), change powerup object on the fly (for example triggering such a powerup gives a random advantage based on current modelID), ...

Also since it allows you to set a custom colShape, you can use it to create tripmines, ...
=Used by=
=Exported scripting functions=
==Server==
{{PowerupManager/ExportedServerFunctions}}
==Client==
{{PowerupManager/ExportedClientFunctions}}
=Events=
Events prefixed with pum are ceated for internal usage only. You still can hook them, but we suggest you don't.
==Server==
{{PowerupManager/ServerEvents}}
==Client==
{{PowerupManager/ClientEvents}}

[[ru:PowerupManager]]

PT-BR/Módulos

2013-05-12T13:30:27Z

Sbx320: Removed inclusion to english pages

Os módulos funcionam como extenções para o sistema Lua do Multi Theft Auto. Eles podem utilizar recursos nativos do MTA já escritas em C++ para desempenhar diversas funções que ainda não foram programadas no modo multiplayer. Todos os módulos podem ser encontrados na lista abaixo. Vale lembrar que estes não são distribuidos pelo Multi Theft Auto, portanto terão que ser instalados pelo próprio usuário.

==Lista dos módulos==
Você pode ver uma lista com as páginas totalmente documentadas [[:Category:Modules|aqui]].

==SDK para módulos==
Para que você possa criar seus próprios módulos, você deve usar o SDK fornecido abaixo para ambos os sistemas operacionais Linux e Windows.

* Linux
** Disponível em nosso [http://files.mtasa.com/apps/1.0/dm/ml_devkit.tar.gz link official]
* Microsoft Windows
** Disponível no site do [http://www.mediafire.com/?b8b3asgegn0xkm4 Mediafire]

===Funções do SDK===
*Por enquanto são essas:
**Funções Nativas:
***HelloWorld
**Funções do MySQL:
***MySQLCreate
***MySQLOpen
***MySQLDestroy
***MySQLQuery
***MySQLSafeString

[[en:Modules]]
[[ru:Modules]]