Multi Theft Auto: Wiki - User contributions [en]

EngineLoadTXD

2010-08-13T12:49:46Z

50p: /* Syntax */

{{Client function}}
__NOTOC__
This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file [, bool filteringEnabled = true ] )
</syntaxhighlight>
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
===Required Arguments===
*'''txd_file:''' The [[filepath]] to the txd file you want to load

===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.

===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

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

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

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

==See Also==
{{Engine_functions}}

AddCommandHandler

2010-08-12T10:54:35Z

50p: /* Example */

__NOTOC__
{{Server client function}}
{{Note_box|It is strongly advised that you do not use the same name for your handler function as the command name, as this can lead to confusion if multiple handler functions are used. Use a name that describes your handler's purpose more specifically.}}
This function will attach a scripting function (handler) to a console command, so that whenever a player or administrator uses the command the function is called.

Multiple command handlers can be attached to a single command, and they will be called in the order that the handlers were attached. Equally, multiple commands can be handled by a single function, and the ''commandName'' parameter used to decide the course of action.

For users, a command is in the format:

''commandName'' ''argument1'' ''argument2''

This can be triggered from the player's console or directly from the chat box by prefixing the message with a forward slash (''/''). For server side handlers, the server admin is also able to trigger these directly from the server's console in the same way as they are triggered from a player's console.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction, [bool restricted = false, bool caseSensitive = true] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
*'''restricted:''' Specify whether or not this command should be restricted by default. Use this on commands that should be inaccessible to everyone as default except special users specified in the ACL (Access Control List). This is to make sure admin commands such as ie. 'punish' won't be available to everyone if a server administrator forgets masking it in ACL. This argument defaults to false if nothing is specified.
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}

</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction, [bool caseSensitive = true] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}
</section>

====Handler function parameters====
These are the parameters for the handler function that is called when the command is used.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName, [string arg1, string arg2, ...] </syntaxhighlight>

* '''playerSource:''' The player who triggered the command. If not triggered by a player (e.g. by admin), this will be ''false''.
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Example 4''' below.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua"> string commandName, [string arg1, string arg2, ...] </syntaxhighlight>
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Example 4''' below.
</section>

===Returns===
Returns ''true'' if the command handler was added successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example defines a command handler for the command ''createmarker''. This will create a red marker at the position of the player player who uses it.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command
function consoleCreateMarker ( playerSource )
-- If a player triggered it (rather than the admin) then
if ( playerSource ) then
-- Get that player's position
local x, y, z = getElementPosition ( playerSource )
-- Create a size 2, red checkpoint marker at their position
createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
-- Output it in his chat box
outputChatBox ( "You got a red marker", playerSource )
end
end
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
addCommandHandler ( "createmarker", consoleCreateMarker )
</syntaxhighlight>

'''Example 2:''' A simple health setting command. If a player types ''/sethealth X'' in the chatbox his health will be set to X. Note that the function [[setElementHealth]] is used rather than something like "setPlayerHealth". This function is more generic and can also be used to set the health of vehicles.
<syntaxhighlight lang="lua">
function consoleSetHealth(playerSource, commandName, health)
setElementHealth(playerSource, tonumber(health))
end
addCommandHandler("sethealth", consoleSetHealth)
</syntaxhighlight>

'''Example 3:''' This example implements a ''set_vehicle_color'' command.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command
function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )
-- If a player triggered this in-game
if ( playerSource ) then
-- Get the player's vehicle
local playerVehicle = getPedOccupiedVehicle ( playerSource )
-- If the player is in a vehicle and we've got at least 1 parameter
if ( playerVehicle and col1 ) then
-- Get the vehicle's existing color and use it if fewer than 4 arguments were passed
local exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )

if not col2 then col2 = exCol2 end
if not col3 then col3 = exCol3 end
if not col4 then col4 = exCol4 end

-- Set the vehicle's color
setVehicleColor ( playerVehicle, col1, col2, col3, col4 )
else
-- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text
outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )
outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )
outputConsole ( "You must be in a vehicle to use this function.", playerSource )
end
end
end
-- Attach the 'consoleSetVehicleColor' function to the "set_vehicle_color" command
addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )
</syntaxhighlight>

'''Example 4:''' This example makes use of Lua's vararg expression to implement a ''check_parameters'' command to count the number of parameters passed, merge them all into a single string and output it. This is also shows you how you can use table.concat to merge all the passed arguments. This is particularly useful when you want to read in a sentence of text passed from the user.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command (which can accept a variable number of arguments after commandName)
function consoleCheckParameters ( playerSource, commandName, ... )
-- If a player, not an admin, triggered it,
if playerSource then
-- Get the number of arguments in the arg table (arg table is the same as: {...})
local parameterCount = #arg
-- Output it to the player's chatbox
outputChatBox ( "Number of parameters: " .. parameterCount, playerSource )
-- Join them together in a single comma-separated string
local stringWithAllParameters = table.concat( arg, ", " )
-- Output this parameter list to the player's chatbox
outputChatBox ( "Parameters passed: " .. stringWithAllParameters, playerSource )
end
end
-- Attach the 'consoleCheckParameters' function to the "check_parameters" command
addCommandHandler ( "check_parameters", consoleCheckParameters )
</syntaxhighlight>

'''Example 5:''' This example shows using a single function to handle multiple command handlers. This isn't advised for general usage, as it makes code harder to understand, but where multiple command handlers share some logic, it can be a useful way of reducing duplicated code. Generally, it would be preferable to put this shared logic in a separate function instead, as this gives you more control over the flow.

<syntaxhighlight lang="lua">
-- make the function
function moneyCmd(player, cmd, amount)
if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
if cmd == "givemoney" then
amount = tonumber(amount)
if amount then
givePlayerMoney(player, amount)
else
outputChatBox("[usage] /givemoney [amount]", player)
end
else if cmd == "takemoney" then
amount = tonumber(amount)
if amount then
takePlayerMoney(player, amount)
else
outputChatBox("[usage] /takemoney [amount]", player)
end
end
else
outputChatBox("You aren't able to use this command", player)
end
end

addCommandHandler("givemoney", moneyCmd);
addCommandHandler("takemoney", moneyCmd);
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
'''Example 1:''' This creates a GUI window and allows a player to change its alpha (transparency) value with a command. Note that, in a clientside script, the player using the command is not passed as a parameter to the handler function, since it is always the local player.

<syntaxhighlight lang="lua">--Create a window
myWindow = guiCreateWindow ( 0.30, 0.10, 0.5, 0.60, "GUI window title", true )

--Add a command handler to change the alpha of the GUI window. Usage example: 'alpha 0.15'
function changeAlpha ( commandName, alphaAmount )
-- All command parameters are strings, so we'll convert the value to a number first
alphaAmount = tonumber(alphaAmount)
guiSetAlpha ( myWindow, alphaAmount )
end
addCommandHandler ( "alpha", changeAlpha )
</syntaxhighlight>
</section>

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

Optional Arguments

2010-08-12T01:37:22Z

50p:

[[Optional Arguments]] are arguments that are passed to a function but are not required for the function to run. Often, if you do not specify them, default values will be used instead.

When looking at the Syntax for an argument, Optional arguments are always enclosed in Square brackets.

Example:

<syntaxhighlight lang="lua">createVehicle ( int model, float x, float y, float z, [ float rx, float ry, float rz ] )</syntaxhighlight>

In this example, '''rx''', '''ry''', and '''rz''' are [[Optional Arguments]].

==Using Optional Arguments==

[[Optional Arguments]] have one limitation. You cannot use any optional arguments unless ''all previous arguments are also supplied.''

This means that in the previous example, if you wanted to supply '''rz''', you would also need to supply '''rx''', and '''ry''' ''in order.''

[[pl:Argumenty opcjonalne]]
[[Category:Scripting Concepts]]
[[ru:Optional Arguments]]

SetTrafficLightState

2010-08-09T15:03:43Z

50p:

__NOTOC__
{{Server client function}}
Sets the current traffic light state. This state controls the traffic light colors. For instance, state '''1''' will cause the north and south traffic lights to be amber, and the ones left and east will turn red.

==Syntax==
<syntaxhighlight lang="lua">
bool setTrafficLightState ( int state )
</syntaxhighlight>

===Required Arguments===
*'''state''': The [[Traffic_light_states|state]] you wish to use (possible values: 0-9)

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

==Example==
This example doesn't exist

==See Also==
{{World_functions}}

[[Category:Needs_Example]]

OnClientRender

2010-08-06T17:44:28Z

50p: /* Example - happy now?! */

__NOTOC__
{{Client event}}
This event is triggered every time GTA renders a new frame. It is required for the DirectX drawing functions, and also useful for other clientside operations that have to be applied repeatedly with very short time differences between them.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way. This will be a little bit laggy. If you want the camera to follow something (eg. player or vehicle) then use [[onClientPreRender]] instead.
<syntaxhighlight lang="lua">
root = getRootElement ()
function updateCamera ()
local x, y, z = getElementPosition ( getLocalPlayer () )
setCameraMatrix ( x, y, z + 50, x, y, z )
end
addEventHandler ( "onClientRender", root, updateCamera )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientRender

2010-08-06T16:12:53Z

50p: /* Added example */

__NOTOC__
{{Client event}}
This event is triggered every time GTA renders a new frame. It is required for the DirectX drawing functions, and also useful for other clientside operations that have to be applied repeatedly with very short time differences between them.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way. This will be a little bit laggy. If you want the camera to follow something (eg. player or vehicle) then use [[onClientPreRender]] instead.
<syntaxhighlight lang="lua">
root = getRootElement ()
function updateCamera ()
local x, y, z = getElementPosition ( getLocalPlayer () )
setCameraMatrix ( x, y, z + 50, x, y, z )
end
addEventHandler ( "onClientPreRender", root, updateCamera )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

IterElements

2010-07-29T22:10:50Z

50p:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is useful for '''for''' loops. You don't have to type ''ipairs( getElementsByType( "player" ) )'' but simply ''iterElements( "player" )''. It's very useful if you have many for loops in your code. [[doForAllElements]] has to iterate through elements every time you call 1 function per call but this iterates through elements and what you do to/with the elements is up to you.

==Syntax==
<syntaxhighlight lang="lua">iterator iterElements( string elementType )</syntaxhighlight>

===Required Arguments===
* '''elementType''': Type of the elements that you want to iterate through.

==Code==
<syntaxhighlight lang="lua">
function iterElements( elementType )
local i = 0;
local tab = getElementsByType( elementType );
return function( )
i = i + 1;
if tab[ i ] then
return i, tab[ i ];
end
end
end
</syntaxhighlight>

==Example==
This example will iterate through all players and vehicles. It will heal the players, give them $1000, send them a message informing them about the action and fix all vehicles when the resource starts.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", getResourceRootElement( ),
function( )
for _, plr in iterElements( "player" ) do
setElementHealth( plr, 100 );
givePlayerMoney( plr, 1000 );
outputChatBox( "You've just been healed and given $1000!", plr );
end

for _, veh in iterElements( "vehicle" ) do
fixVehicle( veh );
end
end
)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

IterElements

2010-07-29T22:09:47Z

50p: Undo revision 24122 by Lil Toady (Talk)

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is useful for '''for''' loops. You don't have to type ''ipairs( getElementsByType( "player" ) )'' but simply ''iterElements( "player" )''. It's very useful if you have many for loops in your code. [[doForAllElements]] has to iterate through elements every time you call 1 function per call but this iterates and what you do to the elements is up to you.

==Syntax==
<syntaxhighlight lang="lua">iterator iterElements( string elementType )</syntaxhighlight>

===Required Arguments===
* '''elementType''': Type of the elements that you want to iterate through.

==Code==
<syntaxhighlight lang="lua">
function iterElements( elementType )
local i = 0;
local tab = getElementsByType( elementType );
return function( )
i = i + 1;
if tab[ i ] then
return i, tab[ i ];
end
end
end
</syntaxhighlight>

==Example==
This example will iterate through all players and vehicles. It will heal the players, give them $1000, send them a message informing them about the action and fix all vehicles when the resource starts.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", getResourceRootElement( ),
function( )
for _, plr in iterElements( "player" ) do
setElementHealth( plr, 100 );
givePlayerMoney( plr, 1000 );
outputChatBox( "You've just been healed and given $1000!", plr );
end

for _, veh in iterElements( "vehicle" ) do
fixVehicle( veh );
end
end
)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

PlaySound3D

2010-07-20T19:39:23Z

50p: /* Required Arguments */

__NOTOC__
{{Client function}}
Creates a [[sound]] element in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>

===Required Arguments===
*'''soundPath:''' The [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag.)
*'''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===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

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

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

PlaySound

2010-07-20T19:38:59Z

50p:

__NOTOC__
{{Client function}}
Creates a [[sound]] element and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>

===Required Arguments===
*'''soundPath:''' The [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

Template:Useful Functions

2010-07-14T22:08:11Z

50p:

*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span>

*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>

*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span>

*[[doForAllElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function can be used to execute a specified function for all elements of a specified type.</span>

*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span>

*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span>

*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span>

*[[getAge]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span>

*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span>

*[[GetTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].</span>

*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span>

*[[IsYearALeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</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>

*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span>

*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>

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

*[[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.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.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</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>

[[Category:Useful Functions]]

IterElements

2010-07-14T22:07:41Z

50p:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is useful for '''for''' loops. You don't have to type ''ipairs( getElementsByType( "player" ) )'' but simply ''iterElements( "player" )''. It's very useful if you have many for loops in your code. [[doForAllElements]] has to iterate through elements every time you call 1 function per call but this iterates and what you do to the elements is up to you.

==Syntax==
<syntaxhighlight lang="lua">iterator iterElements( string elementType )</syntaxhighlight>

===Required Arguments===
* '''elementType''': Type of the elements that you want to iterate through.

==Code==
<syntaxhighlight lang="lua">
function iterElements( elementType )
local i = 0;
local tab = getElementsByType( elementType );
return function( )
i = i + 1;
if tab[ i ] then
return i, tab[ i ];
end
end
end
</syntaxhighlight>

==Example==
This example will iterate through all players and vehicles. It will heal the players, give them $1000, send them a message informing them about the action and fix all vehicles when the resource starts.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", getResourceRootElement( ),
function( )
for _, plr in iterElements( "player" ) do
setElementHealth( plr, 100 );
givePlayerMoney( plr, 1000 );
outputChatBox( "You've just been healed and given $1000!", plr );
end

for _, veh in iterElements( "vehicle" ) do
fixVehicle( veh );
end
end
)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2010-07-14T22:07:34Z

50p:

*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span>

*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>

*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span>

*[[doForAllElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function can be used to execute a specified function for all elements of a specified type.</span>

*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span>

*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span>

*[[getAge]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span>

*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span>

*[[GetTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].</span>

*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span>

*[[IsYearALeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</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>

*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span>

*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>

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

*[[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.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.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</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>

*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span>

[[Category:Useful Functions]]

IterElements

2010-07-14T22:04:52Z

50p: Created page with '{{Useful Function}} <lowercasetitle/> __NOTOC__ This function is useful for '''for''' loops. You don't have to type ''ipairs( getElementsByType( "player" ) )'' but simply ''iterE…'

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is useful for '''for''' loops. You don't have to type ''ipairs( getElementsByType( "player" ) )'' but simply ''iterElements( "player" )''. It's very useful if you have many for loops in your code. [[doForAllElements]] has to iterate through elements every time you call 1 function per call but this iterates and what you do to the elements is up to you.

==Syntax==
<syntaxhighlight lang="lua">iterator iterElements( string elementType )</syntaxhighlight>

===Required Arguments===
* '''elementType''': Type of the elements that you want to iterate through.

==Code==
<syntaxhighlight lang="lua">
function iterElements( elementType )
local i = 0;
local tab = getElementsByType( elementType );
return function( )
i = i + 1;
if tab[ i ] then
return i, tab[ i ];
end
end
end
</syntaxhighlight>

==Example==
This example will iterate through all players and vehicles. It will heal the players, give them $1000, send them a message informing them about the action and fix all vehicles when the resource starts.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", getResourceRootElement( ),
function( )
for _, plr in iterElements( "player" ) do
setElementHealth( plr, 100 );
givePlayerMoney( plr, 1000 );
outputChatBox( "You've just been healed and given $1000!", plr );
end

for _, veh in iterElements( "vehicle" ) do
fixVehicle( veh );
end
end
)
</syntaxhighlight>

CSharp SDK

2010-07-08T20:39:58Z

50p: /* fixed link to my wiki profile */

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

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

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

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

2. Create instance of MTA class:

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

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

'''OR'''

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

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

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

'''OR'''

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

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

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

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

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

==Download==
You can download C# MTA SDK here:
*[http://scripteditor.beta.mtasa.com/files/MTA_SDK_1.0.zip C# MTA SDK 1.0]

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

GetVehicleCurrentGear

2010-07-03T14:24:52Z

50p:

__NOTOC__
{{Client function}}

Gets the specified vehicle's current gear.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleCurrentGear ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle to get the gear of

===Returns===
Returns the gear if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
Example of a program that outputs the current gear to the lower, center of the screen
<syntaxhighlight lang="lua">

g_player = getLocalPlayer()
g_root = getRootElement()

function makeGearGui( )
local sx,sy = guiGetScreenSize()
local wx = 50
local wy = 50
gearLabel = guiCreateLabel(((sx/2)-wx),(sy-wy),wx,wy,"5",false)
end

function onRender()
g_vehicle = getPedOccupiedVehicle(g_player)
if g_vehicle then
g_curGear = tostring(getVehicleCurrentGear(g_vehicle))
guiSetText(gearLabel,g_curGear)
else
guiSetText(gearLabel,"")
end
end

makeGearGui()
addEventHandler("onClientRender",g_root,onRender)
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

OnPlayerConnect

2010-06-04T12:56:48Z

50p: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player attempts to connect to the server.

==Parameters==
<syntaxhighlight lang="lua">
string playerNick, string playerIP, string playerUsername, string playerSerial, int playerVersion
</syntaxhighlight>

*'''playerNick''': The player's current nickname.
*'''playerIP''': The player's current IP.
*'''playerUsername''': The player's community username.
*'''playerSerial''': The player's serial number.
''Extra parameter from 1.0.2 onwards:''
*'''playerVersion''': The player's MTA version in pure numerical form, e.g. ''''256'''' for 1.0, ''''257'''' for 1.0.1, etc.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.

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

This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.

<syntaxhighlight lang="lua">
--when a player connects
function playerConnect (playerNick, playerIP, playerUsername, playerSerial, playerVersion)
if playerNick == "Player" then --check if his nick is "Player"
cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
else
--output some data about the player
outputChatBox (playerNick.." just connected to the server.")
outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)
end
end

--add the playerConnect function as a handler for onPlayerConnect
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example cancels connection if player uses older MTA (older than 1.0.3)
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", getRootElement(),
function ( _,_,_,_, clientVersion )
if ( clientVersion < 259 ) then
cancelEvent( true, "Update your MTA before you join this server!" );
end
end
)
</syntaxhighlight>
</section>
{{See also/Server event|Player events}}

Known Issues - FAQ

2010-05-15T16:07:49Z

50p: /* Halt after MTA splash screen */

Post here your proposed Q&A, regarding the known problems with MTA:SA and their solutions, especially the problems we are encountering now, that might be also encountered by users in the final release. You're also welcome to edit them grammar/style wise.

[[Resource:Editor#FAQ|Map editor FAQ/known issues can be found here.]]<br>
[[MTA 0.5 Known Issues|Known issues for MTA 0.5 can be found here.]]

== Client ==

=== General ===
==== I have the Steam version of GTA San Andreas. How can I play MTASA? ====
The Steam version of GTASA is current incompatible with MTASA. However, by following a few simple steps, the Steam version can be made to work:
* Find a '''GTA SA 1.00 No CD''' (Google will give useful results). You should obtain a 1.00 Cracked/NoCd EXE, not a Disc image. Any HOODLUM release will work fine.
* Open the download with Winrar or other similar archive tools, and inside there should be a gta_sa.exe. Place this file inside your installation directory. This is normally '''C:\Program Files\Steam\steamapps\common\grand theft auto san andreas'''. No files need to be replaced during this process.

This procedure will not affect your Steam version of GTASA, but will allow MTASA to boot alongside it.

==== Does MTASA work with v1.01 or v2.00 of GTA San Andreas? ====
No. It can be made to work with them however - please see [http://forum.multitheftauto.com/viewtopic.php?t=15151 this forum topic] for instructions on patching the exe.

==== Initial black screen/hanging GTA splash screens ====
* '''MTA shows a permanent black screen or hanging GTA splash screens.'''

It may be necessary that during/after the logo splash screens in Grand Theft Auto you have to give some input in order to skip the videos correctly. Try to click your left-mouse button a few times, or tapping a few keys.

* '''MTA shows a permanent black screen after the GTA splash screens (possibly with text in the bottom right corner).'''

This can be related to a lack of support for DirectX or video card features, on your system, which are needed to run the dynamically rendered menu. This dynamic menu is enabled by default. You can disable it by opening your [[coreconfig.xml]] configuration file located in the ''GTA San Andreas\MTA'' directory, and changing the value of ''menu_options'' to ''248''.

==== Halt after MTA splash screen ====
* '''Nothing happens after the 'Stop playing with yourself' splash screen'''

If you use nVidia GeForce, try turning off nView Desktop Manager before starting MTA.

Also try deleting GTA San Andreas settings file ("gta_sa.set") in "Documents\GTA San Andreas User Files" folder.

If it all fails and you run Kaspersky Anti-Virus or Internet Security, make sure status of "multi theft auto.exe" in not restricted. Other anti-virus software may block MTA from running.

==== Crash after MTA splash screen ====
* '''MTA crashes after the 'Stop playing with yourself' logo. Both single player and the MTA: Race ran fine before.'''

Try downloading the latest DirectX Runtime files from [http://www.microsoft.com/downloads/details.aspx?FamilyID=2da43d38-db71-4c1b-bc6a-9b6652cd92a3&DisplayLang=en Microsoft]. Also check in Task Manager, if gta_sa.exe process isn't already running.

If you run at any substandard resolutions (e.g. 960x720), try to change your resolution to a commonly supported one (e.g. 640×480, 800×600, 1024×768, 1152×864, 1280×1024) by launching Grand Theft Auto: San Andreas in normal mode, setting the new resolution and exiting.

If you are a user of Windows Vista or Windows 7, try the following:
* Enable Windows XP SP3 compatiblity mode for both Multi Theft Auto.exe and gta_sa.exe, setting their privilege level to "Run this program as an administrator".
* Configure Data Execution Prevention: Use the setting ''Turn DEP for all programs and services except those I select''. Click ''add'' and find "Multi Theft Auto.exe" and "gta_sa.exe" and add them.
* Run MTASA as administrator.

==== You receive an error stating "San Andreas data files have been modified" ====

You can fix this by downloading [http://community.mtasa.com/data.zip this archive] and extracting it into your Grand Theft Auto San Andreas\data directory. Make sure to replace '''all''' files. If that doesn't work, try reinstalling GTA San Andreas.

==== Assertion in CMainMenu.cpp line 106 upon launching MTASA ====
* '''I'm getting an assertion in CMainMenu.cpp (line 106) after I have launched MTASA. I'm able to ignore it, but then game crashes after I try to connect to a server.'''

This is likely caused by GTASA or MTA:SA being installed in a path that contains non-ASCII characters (eg. Cyrillic, Polish, Japanese) in it.

To resolve this, you need to uninstall MTA:SA and GTASA, then install them in such paths that don't contain such characters.

==== Crash after connecting to any server ====
* '''MTASA crashes upon connecting to any server. Single player runs fine.'''

Single player mods can affect the way MTA:SA works, potentially causing crashes - you should always use a clean GTASA install for MTA:SA.

This might also occur on non-modded installs, when your GTASA executable is in an unsupported by MTA:SA version (eg. 1.0 German or Australian). To resolve this, use [http://forum.multitheftauto.com/viewtopic.php?f=89&t=15151 our converter].

==== Controls not working ====
* '''My controls don't seem to work as they should.'''

Try using the 'copygtacontrols' command in the console.

==== Incorrect models ====
* '''Woman model's breasts look awkward ingame / I'm seeing odd, spider-like shaped player models.'''

This is caused by the way GTA handles player stats. To fix this, be sure to set both fat and muscles player stats to 0, when you're changing player skin.

==== Incorrect drive-by functionality ====
* '''Drivebys arent working as they should'''

Drivebys are handled by script, and will change depending on the loaded gamemode.

==== Unsaved settings ====
* '''My MTA setting(s) didn't get saved (...) I crashed.'''

First, configure the MTA the way you want to, then exit the game and launch it again. Settings should get saved. Alternatively, try removing the coreconfig.xml file, then configure it and quit the game.

==== Gamepad support ====
* '''MTA doesn't recognise my gamepad'''

Ensure that your controller is the first controller recognised by Windows (MTA will only use the first controller). You can configure your gamepad in options in MTASA's main menu.

==== Free mouselook not working properly ====
* '''MTA doesnt recognise my mouse'''

Some people got problems with their mouse in MTA. They can use it in the menu, connect to a server, but they can't use the mouse for free look.
This problem can be solved by entering a server, click your Win/Windows key at your keyboard once, and then click your mouse.
If that doesn't work try starting GTA in Singleplayer, go to options > controler setup and set "Configuration" to "Mouse + Keys" instead of "Joypad".

==== Server browser not working ====
* '''The in-game server browser shows "Loading" but does not come up with any servers'''

Depending on the type and status of the internet connection you are using, it can take up to a few seconds for the server browser to retrieve all the servers. Please wait a little longer for the results to appear.

If all else fails, you can logon to [http://www.game-monitor.com/search.php?game=mta GameMonitor], and click the green play icon to play on that server.

==== Invalid serial number ====
* '''I am getting an 'Invalid serial number' error when trying to launch or play the game'''

You are running an outdated version of Multi Theft Auto. Head over to the [http://mtasa.com/ main page] and download the latest version of Multi Theft Auto.

==== 'Network module could not be located' ====
* '''I am getting 'Network module could not be located' error message upon launching MTA:SA

Copy the file 'net.dll' from your GTA:SA/mta directory into your GTA:SA directory, overwriting existing files.

==== 'Network module not compatible!' on MTA:SA launch ====
* '''I am getting 'Network module not compatible!' error message upon launching MTA:SA

This could mean that your MTA:SA install is incomplete or broken. Reinstall it.

==== 'No such mod installed (deathmatch)' ====
* '''I am getting a 'No such mod installed (deathmatch)' error message when trying to connect to any server

'''Option 1:''' Simply re-install MTA. <br>
'''Option 2:''' Run both gta_sa.exe and Multi Theft Auto.exe with administrator privileges.

==== D3dx9_**.dll is not found ====
* '''When I start Multi Theft Auto: San Andreas I am getting an error D3dx9_**.dll (** = a number) cannot be found.

This means that DirectX 9 is not installed or not up to date.
To install/update DirectX download the [http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=2da43d38-db71-4c1b-bc6a-9b6652cd92a3 DirectX End-User Runtime Web Installer] from the Microsoft download site.

=== Windows Vista®-related ===

==== Crash on connect ====
* '''I seem to crash whenever I connect to a server just before I go in-game on Vista'''

This seems to be an issue with the Microsoft DirectX April 2006 SDK Redistributable DLL file (d3dx9_30.dll) when running in compatibility mode. Please make sure that compatibility mode is competely turned off for '''both''' your GTA_SA.exe and Multi Theft Auto.exe executables.

==== Clock manipulation error ====
* '''I am getting 'Clock manipulation detected!' error message upon launching MTA:SA

This is caused by incorrect system date/time being set (which could be a result of wrong settings or a faulty battery on the pc's motherboard). Setting time and date again should fix the problem.

It might also happen if you are using an AMD Athlon 64 X2 processor with some old drivers. Update them at [http://support.amd.com/us/Pages/drivers.aspx AMD's site].

==== Halt on launch ====
* '''When I launch MTA:SA, nothing happens (GTA_SA.exe is running but not loading up)

Run MTA:SA with Administrator privileges. To do this, right click on the installer executable, choose 'Properties', go into 'Compatibility' tab and tick the check box on the last field and try again.

==== General GTA problems ====
* '''I have unexplainable GTA problems or crashes'''

Make sure your computer as well as your GTA install meet the [[Deathmatch_Client_Manual#System_requirements|minimum requirements]] and that you are not running in any 98/2000/XP/2003 compatibility modes.

Also try the solutions from these pages:
* http://www.gtaforums.com/index.php?showtopic=273549&view=findpost&p=4537502
* http://pullmonkey.com/2007/4/30/how-i-got-gta-san-andreas-to-work-with-a-crappy-os-vista

== Server ==

=== General ===
==== Fatal error 3 ====
* '''I'm getting ''Fatal Error 3'' whenever I connect to my server'''

This error happens when the server you are trying to connect to is unable to provide you the required downloads, because it does not have http downloading enabled. Be sure to set the '''httpdownload''' configuration tag in your configuration to '''1'''.
==== Download error 9: Error downloading requested files ====
* '''I'm getting ''Download Error 9: Error downloading requested files'' whenever I connect to my server'''

This error happens when the server you are trying to connect to is unable to provide you with a valid link. This results in a 404 (Not found) HTTP error and an error at your end.

* If you are running the built-in server ('''httpserver''' is set to '''1''' and '''httpdownloadurl''' is empty), make sure that your HTTP server is accessible (you can try to access it by using a browser) for everyone.

* If you have configured an external web server ('''httpdownloadurl''' is set to your custom URL), make sure that your HTTP is accessible and make sure you have read the [[Deathmatch_Server_Manual#Configuring_an_external_web_server | Configuring an external web server]] guide.
==== Download error 28 ====
Try closing anti-virus or firewall applications. If it then works, try adding an exception to your firewall to allow your http port through.

=== Windows-related ===
No known reported issues in the version {{Current Version|full}}.

=== Linux-related ===
====Default nohup creates infinitely big nohup.out====

Temporary fix, disable the nohup file: 'nohup ./mta_server > /dev/null &'

[[es:Problemas Conocidos - FAQ]]
[[it:Bugs noti e FAQ]]
[[ru:Known Issues - FAQ]]

User:50p

2010-04-24T00:59:05Z

50p:

__TOC__

== Tools / Programming ==
[[MTASE|MTA:Script Editor]] - From scripters for scripters. As its name says, it's a script editor with many features that are designed only for creating resources for MTA:SA.

[http://forum.multitheftauto.com/viewtopic.php?f=108&t=27406| MTA:SA Map Exporter (3DS MAXScript)] - Script for 3DS Max to let you generate files required for MTA:SA custom maps.

[http://forum.mtasa.com/viewtopic.php?f=91&t=22247| Meta.xml generator] - Easy to use and helps to understand what MTA's meta.xml files are for.

== Resources ==

[http://community.mtasa.com/index.php?p=resources&s=details&id=5| Speedometer] - Nice looking digital speedometer. 1st speedometer for MTA. 1 of the top downloaded resource.

[http://community.mtasa.com/index.php?p=resources&s=details&id=8| Speedometer (with needle)] - 1st needle speedometer! (WARNING! May freeze your PC for loading time)

[http://community.mtasa.com/index.php?p=resources&s=details&id=38| Welcome window] - Simple "Welcome" window with a logo at the top. Can be used as "Accept the rules if you want to play"

[http://community.mtasa.com/index.php?p=resources&s=details&id=54| Bank System] - One and the only bank system out there released to public. One of the most downloaded resource!

[http://community.mtasa.com/index.php?p=resources&s=details&id=124| Show position] - Its first objective was to show your current position at the bottom of the screen. Then it evolved. It lets you save coordinates with simple command: "// <comment>"

[http://community.mtasa.com/index.php?p=resources&s=details&id=127| Got hit!] - Have you played FPS games? Have you noticed some on screen effects when you get hit? This script creates the "hit effect" on screen when you get hit. Parts of the screen go red depending on the direction from which you got hit.

[http://community.mtasa.com/index.php?p=resources&s=details&id=169| Mod Shop] - One and the only modification shop for your vehicles. Let you players modify their vehicles like they used to do in Single-Player

[http://community.mtasa.com/index.php?p=resources&s=details&id=186| Chatbox Ads] - Do you want to show ads in chatbox? Do you want to advert your other server? Simply, use this easy to use script.

[http://community.mtasa.com/index.php?p=resources&s=details&id=202| Anti-Flood/Spam] - Have you had problems with chatbox spammers? Use this script and stop them from flooding your chatbox again. Easy to use with a few settings.

[http://community.mtasa.com/index.php?p=resources&s=details&id=234| Peds!!] - Sample ped script. Creates a ped which can follow you. It also gives them health bar which you can disable if you want to.

[http://community.mtasa.com/index.php?p=resources&s=details&id=241| GUI Library] - Creating GUI elements hasn't been easier. Make your scripts clean, easy to read. GUI event handling is much easier.

[http://community.mtasa.com/index.php?p=resources&s=details&id=427| Need for Speed-like NOS] - Did you enjoy the nitro in Need for Speed (hold button to use, release to stop)? Then that's what you are looking for. This script allows you to control how much NOS you use.

[http://community.mtasa.com/index.php?p=resources&s=details&id=623| Save'n'Load] - "Save and Load" - Bookmark your locations and go straight there with just 2 buttons. Ctrl + [0-9] to save your current position. Alt + [0-9] to load previously bookmarked location.

== ART (3D modelling) ==
http://y50p.deviantart.com/ - Find some of my 3D work there.

== Youtube ==
http://www.youtube.com/user/y50p - Watch all my videos there.

User:50p

2010-04-24T00:54:06Z

50p: Created page with '__TOC__ == Tools / Programming == MTA:Script Editor - From scripters for scripters. As its name says, it's a script editor with many features that are designed only fo…'

__TOC__

== Tools / Programming ==
[[MTASE|MTA:Script Editor]] - From scripters for scripters. As its name says, it's a script editor with many features that are designed only for creating resources for MTA:SA.

[http://forum.multitheftauto.com/viewtopic.php?f=108&t=27406| MTA:SA Map Exporter (3DS MAXScript)] - Script for 3DS Max to let you generate files required for MTA:SA custom maps.

== Resources ==

[http://community.mtasa.com/index.php?p=resources&s=details&id=5| Speedometer] - Nice looking digital speedometer. 1st speedometer for MTA. 1 of the top downloaded resource.

[http://community.mtasa.com/index.php?p=resources&s=details&id=8| Speedometer (with needle)] - 1st needle speedometer! (WARNING! May freeze your PC for loading time)

[http://community.mtasa.com/index.php?p=resources&s=details&id=38| Welcome window] - Simple "Welcome" window with a logo at the top. Can be used as "Accept the rules if you want to play"

[http://community.mtasa.com/index.php?p=resources&s=details&id=54| Bank System] - One and the only bank system out there released to public. One of the most downloaded resource!

[http://community.mtasa.com/index.php?p=resources&s=details&id=124| Show position] - Its first objective was to show your current position at the bottom of the screen. Then it evolved. It lets you save coordinates with simple command: "// <comment>"

[http://community.mtasa.com/index.php?p=resources&s=details&id=127| Got hit!] - Have you played FPS games? Have you noticed some on screen effects when you get hit? This script creates the "hit effect" on screen when you get hit. Parts of the screen go red depending on the direction from which you got hit.

[http://community.mtasa.com/index.php?p=resources&s=details&id=169| Mod Shop] - One and the only modification shop for your vehicles. Let you players modify their vehicles like they used to do in Single-Player

[http://community.mtasa.com/index.php?p=resources&s=details&id=186| Chatbox Ads] - Do you want to show ads in chatbox? Do you want to advert your other server? Simply, use this easy to use script.

[http://community.mtasa.com/index.php?p=resources&s=details&id=202| Anti-Flood/Spam] - Have you had problems with chatbox spammers? Use this script and stop them from flooding your chatbox again. Easy to use with a few settings.

[http://community.mtasa.com/index.php?p=resources&s=details&id=234| Peds!!] - Sample ped script. Creates a ped which can follow you. It also gives them health bar which you can disable if you want to.

[http://community.mtasa.com/index.php?p=resources&s=details&id=241| GUI Library] - Creating GUI elements hasn't been easier. Make your scripts clean, easy to read. GUI event handling is much easier.

[http://community.mtasa.com/index.php?p=resources&s=details&id=427| Need for Speed-like NOS] - Did you enjoy the nitro in Need for Speed (hold button to use, release to stop)? Then that's what you are looking for. This script allows you to control how much NOS you use.

[http://community.mtasa.com/index.php?p=resources&s=details&id=623| Save'n'Load] - "Save and Load" - Bookmark your locations and go straight there with just 2 buttons. Ctrl + [0-9] to save your current position. Alt + [0-9] to load previously bookmarked location.

== ART (3D modelling) ==
http://y50p.deviantart.com/ - Find some of my 3D work there.

== Youtube ==
http://www.youtube.com/user/y50p - Watch all my videos there.

IsTimer

2010-04-16T19:59:34Z

50p:

__NOTOC__
{{Server client function}}
This function checks if a variable is a [[timer]].

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isTimer ( var theVariable )</syntaxhighlight>

===Required Arguments===
* '''theVariable''': The variable that we want to check.

===Returns===
Returns ''true'' if the passed value is a timer, ''false'' otherwise.
</section>

==Example==
<section name="Server" class="server" show="true">
This example uses isTimer to prevent players from using chat/teamchat/me more than once a second, to prevent spammers.
<syntaxhighlight lang="lua">
-- This anti spam is just an example and won't work if you have other scripts and game modes which manipulate chat,
-- If you do then this script would need to be put with the other script/gamemode that handles chat else cancelEvent() won't work.

antiSpam = {} -- This makes a table called antiSpam
function antiChatSpam() -- The function that the event has called. Will stop all mainchat/teamchat/me spam.
if isTimer(antiSpam[source]) then -- Check if timer is running using isTimer (this is an example of its use and all)
cancelEvent() -- If timer is running then cancel the event
outputChatBox("Sorry mate, you may only send 1 message a second to prevent spam.", source, 255, 255, 0) -- Message to player
else
antiSpam[source] = setTimer(function(source) antiSpam[source] = nil end, 1000, 1, source) -- Timer lasting 1 second.
-- The "function(source) antiSpam[source] = nil end" should clear the player from table after 1 second so he can chat again.
-- antiSpam[source] = setTimer(... is using the table to bind that player to the timer.
end
end
addEventHandler("onPlayerChat", root, antiChatSpam) -- Event we're using, don't waste your time with getRootElement() (root is the same)
-- You now have an antispam to prevent people super spamming your chatbox!
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

StopResource

2010-04-12T15:32:32Z

50p:

__NOTOC__
{{Server function}}
This function stops a running resource.<br>
'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is triggered. This happens after the scripts are done executing for this server frame.

==Syntax==
<syntaxhighlight lang="lua">
bool stopResource ( resource theResource )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the [[resource]] that should be stopped.

===Returns===
Returns ''true'' if the resource was stopped, ''false'' if the stopping failed, or an invalid resource was passed.

==Example==
This function stops all running resources except the current one.
<syntaxhighlight lang="lua">
function stopAllResources()
-- we store a table of resources
local allResources = getResources()
-- for each one of them,
for i, resource in ipairs(allResources) do
-- if it's running, and it is not the current resource
if ( getResourceState(resource) == "running" ) and ( resource ~= getThisResource() ) then
-- then stop it
stopResource(resource)
end
end
end
</syntaxhighlight>

==See Also==
{{Resource_functions}}

MTASE

2010-02-10T21:18:23Z

50p: /*Problems with loading some resources (meta.xml)*/

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
{{TOClimit|1}}

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==

===Error/Warning messages at startup===

===File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)===
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

===Error parsing meta.xml===
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

===Not able to save file===
If you can't seem to be able to save a file that's probably because you created a new file and the file wasn't added to any resource. This is a bug and will be fixed.

===Problem with horizontal scrollbar===
If you have too long line and you paste some code on it, you may get a problem of not being able to scroll to the left (beginning of the line). This is problem with 3rd party library MTA:SE is using. It is not going to be fixed by its author (he's inactive for over 2 years now) and it's hard for us to find what is causing it. In fact, I was also given a link to another nice syntax highlighter library which I may use in the future. I hope this one doesn't have that problem.
If you encounter this problem there are a few ways to get to the beginning of the line.
* start highlighting this line so that caret moves to the left
* press Home key on your keyboard to move caret to the first character on a line

===Problems with loading some resources (meta.xml)===
If you have problems with some resources not being loaded and you get message your resource will not be shown in Resource Explorer, there are few things you can do to fix it:
- Make sure your files in not encoded in Unicode (you can open it in Windows' Notepad and save the meta.xml with ANSI encoding, don't use Notepad++ for this task since it may not change file encoding at all).
- Make sure you don't have "&" (ampersand) sign anywhere in the file since it may cause meta.xml not being parsed correctly. This is caused by .NET Framework XML parser.

Probably both of these can be fixed by changing/adding little piece of code but unfortunately I wasn't able to figure out what. If you know what can cause this parser error in C# .NET XML parser than don't hesitate and share this knowledge with me so I can fix this problem.

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

CSharp SDK

2010-01-17T21:56:28Z

50p:

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

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

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

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

2. Create instance of MTA class:

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

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

'''OR'''

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

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

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

'''OR'''

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

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

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

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

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

==Download==
You can download C# MTA SDK here:
*[http://scripteditor.beta.mtasa.com/files/MTA_SDK_1.0.zip C# MTA SDK 1.0]

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

MTASE

2010-01-17T18:20:21Z

50p: /* Problem with horizontal scrollbar */

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
{{TOClimit|1}}

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==

===Error/Warning messages at startup===

===File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)===
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

===Error parsing meta.xml===
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

===Not able to save file===
If you can't seem to be able to save a file that's probably because you created a new file and the file wasn't added to any resource. This is a bug and will be fixed.

===Problem with horizontal scrollbar===
If you have too long line and you paste some code on it, you may get a problem of not being able to scroll to the left (beginning of the line). This is problem with 3rd party library MTA:SE is using. It is not going to be fixed by its author (he's inactive for over 2 years now) and it's hard for us to find what is causing it. In fact, I was also given a link to another nice syntax highlighter library which I may use in the future. I hope this one doesn't have that problem.
If you encounter this problem there are a few ways to get to the beginning of the line.
* start highlighting this line so that caret moves to the left
* press Home key on your keyboard to move caret to the first character on a line

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

MTASE

2010-01-17T18:18:54Z

50p: /* FAQ - horizontal scrollbar problem*/

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
{{TOClimit|1}}

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==

===Error/Warning messages at startup===

===File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)===
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

===Error parsing meta.xml===
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

===Not able to save file===
If you can't seem to be able to save a file that's probably because you created a new file and the file wasn't added to any resource. This is a bug and will be fixed.

===Problem with horizontal scrollbar===
If you have too long line and you paste some code on it, you may get a problem of not being able to scroll to the left (beginning of the line). This is problem with 3rd party library MTA:SE is using. It is not going to be fixed by its author (he's inactive for over 2 years now) and it's hard for us to find what is causing it.
If you encounter this problem there are a few ways to get to the beginning of the line.
* start highlighting this line so that caret moves to the left
* press Home key on your keyboard to move caret to the first character on a line

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

SetGarageOpen

2009-12-03T20:38:06Z

50p: Undo revision 22008 by Dzakub (Talk)

__NOTOC__
{{Server client function}}
This function opens or closes the specified garage door in the world.

==Syntax==
<syntaxhighlight lang="lua">
bool setGarageOpen ( int garageID, bool open )
</syntaxhighlight>

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

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

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

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

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

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

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

IsVehicleTaxiLightOn

2009-12-02T12:16:18Z

50p: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

===Returns===
Returns ''true'' if the light is on, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example binds the 'o' key to a function that toggles the taxi's light on and off, if you're in a taxi.
<syntaxhighlight lang="lua">
function toggleTaxiLight()
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
if thePlayer == getVehicleOccupant(theVehicle, 0) then -- if is a driver
local id = getElementModel(theVehicle) -- getting vehicle model
if ((id == 420) or (id== 438)) then -- if is a taxi
local lights = isVehicleTaxiLightOn(theVehicle) -- getting vehicle lights state
setVehicleTaxiLightOn(theVehicle, not lights) -- switch lights
end
end
end

bindKey("o", "down", toggleTaxiLight) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

MTASE

2009-11-29T13:14:59Z

50p:

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
{{TOClimit|1}}

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==

===Error/Warning messages at startup===

===File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)===
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

===Error parsing meta.xml===
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

===Not able to save file===
If you can't seem to be able to save a file that's probably because you created a new file and the file wasn't added to any resource. This is a bug and will be fixed.

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

MTASE

2009-11-29T13:12:52Z

50p: /* "Not able to save */

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
{{TOClimit|1}}

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==
===Error/Warning messages at startup===

====File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)====
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

====Error parsing meta.xml====
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

===Not able to save file===
If you can't seem to be able to save a file that's probably because you created a new file and the file wasn't added to any resource.

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

SetVehicleTaxiLightOn

2009-10-19T17:26:25Z

50p:

__NOTOC__
{{Server client function}}
This function will set the taxi light on in a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleTaxiLightOn ( vehicle taxi, bool LightState )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to turn the light on.
*'''LightState:''' whether the light is on. ''True'' for on, ''False'' for off.

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

==Example==
This example sets the taxi light on when the player presses "o" in a taxi.
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerJoin" , getRootElement ( ) ,
function ( )
bindKey ( source , "o", "down",
function ( thePlayer )
if ( isPedInVehicle ( thePlayer ) ) then --is in vehicle or not?
local vehicle = getPedOccupiedVehicle ( thePlayer ) --getting player's occupied vehicle
if ( getVehicleController ( vehicle ) == thePlayer ) then --is driver or not?
local id = getElementModel ( vehicle ) --getting vehicle's model
if ( ( id == 420 ) or ( id == 438 ) ) then --is a taxi?
setVehicleTaxiLightOn ( vehicle, not isVehicleTaxiLightOn ( vehicle ) ) --changing taxi light on/off
end
end
end
end)
end )
</syntaxhighlight>

==See Also==
{{vehicle functions}}

SetVehicleHeadLightColor

2009-10-19T17:25:37Z

50p:

__NOTOC__
{{Server client function}}
This function will set the headlight color of a vehicle. valid Red Green and Blue arguments range from 0-255

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHeadLightColor ( vehicle theVehicle, int red, int green, int blue)
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the headlight color of.
*'''red:''' An integer indicating the amount of red for the vehicle's headlights
*'''green:''' An integer indicating the amount of green for the vehicle's headlights
*'''blue:''' An integer indicating the amount of blue for the vehicle's headlights

===Returns===
Returns ''true'' if vehicle's headlight color was set, ''false'' if an invalid vehicle or invalid color ranges were specified for red,green or blue.

==Example==
This example changes car lights color with command ''/carlights red_color, green_color, blue_color''

It shows error if player isn't in vehicle or color failed to change. It shows a message if color changed successful.
<syntaxhighlight lang="lua">
function changeCarLightsColor ( thePlayer, command, red, green, blue )
local theVehicle = getPedOccupiedVehicle ( thePlayer )
if ( not theVehicle ) then
return outputChatBox( "You don't have vehicle!" )
end
red = tonumber ( red )
green = tonumber ( green )
blue = tonumber ( blue )
-- check if the colour values for red, green and blue are valid
if red and green and blue then
local color = setVehicleHeadLightColor ( theVehicle, red, green, blue )
if(not color) then
outputChatBox( "Failed to change vehicle lights color" )
else
outputChatBox ( "Vehicle lights color changed sucessfully" )
end
else
outputChatBox( "Failed to change vehicle lights color" )
end
end
addCommandHandler ( "carlights", changeCarLightsColor )
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

EngineRestoreModel

2009-10-19T17:04:54Z

50p:

__NOTOC__
{{Client function}}

This function restores the visual DFF model of the given model ID. This restores the result of [[engineReplaceModel]].

==Syntax==

<syntaxhighlight lang="lua">
bool engineRestoreModel ( int modelID )
</syntaxhighlight>

===Required Arguments===

*'''modelID:''' The model ID to restore the visuals of

===Returns===

Returns ''true'' if the model was successfully restored, ''false'' or ''nil'' if it failed for some reason.

==Example==


<section name="Client" class="client" show="true">
Client-Side example for restoring model / vehicle.
<syntaxhighlight lang="lua">
function ResetModel ( )
engineRestoreModel ( 587 ) -- Object / Vehicle to restore to default GTA one.
end

addEvent ( "restoreClientModel", true )
addEventHandler ( "restoreClientModel", getRootElement(), ResetModel )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-Side example for triggering model / vehicle restore function with "restore" command.
<syntaxhighlight lang="lua">
function RestoreModel ( )
triggerClientEvent ( "restoreClientModel", getRootElement(), restoreClientModel )
end
addCommandHandler( "restore", RestoreModel )
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}

EngineRestoreCOL

2009-10-19T17:04:03Z

50p:

__NOTOC__
{{Client function}}

This function restores the original collision model of the given model ID. Reverses the effect of [[engineReplaceCOL]].

==Syntax==

<syntaxhighlight lang="lua">
bool engineRestoreCOL ( int modelID )
</syntaxhighlight>

===Required Arguments===

*'''modelID:''' The ID of the model to restore the model of

===Returns===

Returns ''true'' if this function succeeds, ''false'' or ''nil'' if it fails for some reason.

==Example==
<section name="Client" class="client" show="true">
Client-Side example for restoring object collision with default one.
<syntaxhighlight lang="lua">
function RestoreCollision ( )
engineRestoreCOL ( 3356 )
end

addEvent ( "collisionRestore", true )
addEventHandler ( "collisionRestore", getRootElement(), RestoreCollision )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-side example function for triggering the restore.
<syntaxhighlight lang="lua">
function RestoreCols ( )
triggerClientEvent ( "collisionRestore", getRootElement(), collisionRestore )
end
addCommandHandler("restorecol", RestoreCols)
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}

IsVehicleOnGround

2009-10-19T17:02:15Z

50p:

{{Server client function}}
__NOTOC__
Checks to see if a vehicle has contact with the ground.

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

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to check.

===Returns===
Returns ''true'' if vehicle is on the ground, ''false'' if it is not.

==Example==

This example tells you when you've jumped out of a vehicle.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function checkVState ( vehicle, seat, jacked )
vehName = getVehicleName ( vehicle )

if isVehicleOnGround ( vehicle ) == false then
outputChatBox ( "You jumped out of a "..vehName.."!", source, 255, 0, 0 )
end

end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), checkVState )
</syntaxhighlight>
</section>

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

OnTrailerDetach

2009-10-19T17:01:16Z

50p:

__NOTOC__
{{Server event}}
This event is triggered when a trailer is detached from a truck.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theTruck
</syntaxhighlight>

*'''theTruck''': The truck vehicle that this trailer got detached from.


==Source==
The [[event system#Event source|source]] of this event is the trailer [[vehicle]] that the truck got detached from.

==Example==

This example re-attaches a trailer when it detaches.
<syntaxhighlight lang="lua">
function reattachTrailer(theTruck)
attachTrailerToVehicle(theTruck, source) -- Reattach the truck and trailer
end

addEventHandler("onTrailerDetach", getRootElement(), reattachTrailer)
</syntaxhighlight>

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

OnClientGUIMouseUp

2009-10-19T16:59:34Z

50p:

{{Client event}}
__NOTOC__
This event is fired when the user releases his mouse button when on top of a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
string button, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the mouse button that was released on a GUI element, can be ''left'', ''right'', or ''middle''.
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the GUI element on top of which the mouse button was released.

==Example==
This example show how to add very basic ''click'n'drag'' feature for GUI elements (only for those which parent element is gui-root)
<syntaxhighlight lang="lua">
addEventHandler( "onClientGUIMouseDown", getRootElement( ),
function ( btn, x, y )
if btn == "left" then
clickedElement = source; -- store the clicked element in a global variable
local elementPos = { guiGetPosition( source, false ) };
offsetPos = { x - elementPos[ 1 ], y - elementPos[ 2 ] }; -- get the offset position
end
end
);

addEventHandler( "onClientGUIMouseUp", getRootElement( ),
function ( btn, x, y )
if btn == "left" then
clickedElement = nil;
end
end
);

addEventHandler( "onClientCursorMove", getRootElement( ),
function ( _, _, x, y )
if clickedElement then
guiSetPosition( clickedElement, x - offsetPos[ 1 ], y - offsetPos[ 2 ], false );
end
end
);
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

OnClientElementStreamOut

2009-10-19T16:59:13Z

50p:

{{Client event}}
__NOTOC__
This event is triggered whenever a physical element is streamed out. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers when the local player is leaving the element. When this event is triggered, that element is no longer physical and is now virtualized by MTA.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that streamed out

==Example==
This example shows you how to tell player that a marker was streamed out and the distance between player and the marker.
<syntaxhighlight lang="lua">
addEventHandler( "onClientElementStreamOut", getRootElement( ),
function ( )
if getElementType( source ) == "marker" then
local myPosTab = { getElementPosition( getLocalPlayer( ) ) };
local markerPosTab = { getElementPosition( source ) };
local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
outputChatBox( "A marker has just streamed out. Distance to the marker: " .. tostring( distance ) .."." );
end
end
);
</syntaxhighlight>

==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

OnClientElementStreamIn

2009-10-19T16:58:57Z

50p:

{{Client event}}
__NOTOC__
This event is triggered whenever a physical element is streamed in. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers. When this event is triggered, that element is guaranteed to be physically created as a GTA object.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that streamed in

==Example==
This example shows you how to tell player that a marker was streamed in and the distance between player and the marker.
<syntaxhighlight lang="lua">
addEventHandler( "onClientElementStreamIn", getRootElement( ),
function ( )
if getElementType( source ) == "marker" then
local myPosTab = { getElementPosition( getLocalPlayer( ) ) };
local markerPosTab = { getElementPosition( source ) };
local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
outputChatBox( "A marker has just streamed in. Distance to the marker: " .. tostring( distance ) .."." );
end
end
);
</syntaxhighlight>
==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

Resource Web Access

2009-10-15T20:56:56Z

50p: /* SDK - added C# SDK */

The Multi Theft Auto Server provides a web interface that resources can use in a variety of ways. This document's purpose is to explain what these ways are and how to go about using them.

==Overview==
There are two key parts that make up this system. The first is a standard web server that allows web browsers to request pages and files you have in a resource. The second is a system for allowing web browsers to call functions you have exported from your resource.

==Pages==
===Specifying a file in the meta===
You can specify in your resource's meta file that certain files are accessible through the web server. To do this, you add a line:
<syntaxhighlight lang="lua" lang="xml">
<html src="filename.ext" />
</syntaxhighlight>
You can then access this file from your web browser by visiting: http://host:port/resourcename/filename.ext<br/>
For example, on a locally hosted server using default http port with webmap started: http://127.0.0.1:22005/webmap/map.htm

===Binary files===
Despite the misleading name, files specified using the html node can be of any type. If they are binary files (like images, zip files) then you need to specify this in the meta file, by adding ''raw="true"'' to the ''html'' node. This means that the files are not preprocessed before being sent to the web browser.

For example:
<syntaxhighlight lang="lua" lang="xml">
<html src="image.gif" raw="true" />
</syntaxhighlight>

===Parsed files===
If a file is not specified in the meta file as "raw", then it is passed through a pre-processor before it is returned to the client. This pre-processor works much like PHP or ASP, but uses LUA. You can embed standard MTA scripts within HTML pages, controlling the output. Almost all standard MTA functions work, plus a number of special [[Template:HTTP functions|HTTP Functions]], such as [[httpWrite]], a function that outputs text to the buffer.

For example:
<syntaxhighlight lang="lua" lang="html">
<html>
<body>
This resource is called <* httpWrite( getResourceName(getThisResource()) ) *>
</body>
<html>
</syntaxhighlight>

There is a shorthand (in common with PHP and ASP) for this code, meaning that you can also write the above code as:

<syntaxhighlight lang="lua" lang="html">
<html>
<body>
This resource is called <* = getResourceName(getThisResource()) *>
</body>
<html>
</syntaxhighlight>

Aside from HTTP functions, embedded Lua has access to the following environment variables that contain information about how the page was requested:
* table '''requestHeaders''': This is a table containing all the headers that were requested with the page. You can set returned headers using [[httpSetResponseHeader]].
* table '''form''': This is a table containing all the form data submitted to the page using HTTP POST combined with any variables passed in the querystring with HTTP GET.
* table '''cookies''': This is a table of all the cookies. You can modify cookies using [[httpSetResponseCookie]].
* string '''hostname''': This is a string containing the IP address or hostname that requested the page.
* string '''url''': This is the URL of the page.
* account '''user''': This is the account of the current user.

It's important to note that parsed files are run in a separate virtual machine from the rest of your resource's code. As such, if you want to call a function in your resource's main code, you need to export the function and use the [[call]] function from your parsed file.

==Calls==
You can specify that certain exported functions in your resource are able to be called from the HTTP interface. All the SDKs (listed below) allow you to call these functions from a remote location.

To specify an exported http-accessible function, add the following to your meta.xml file:
<syntaxhighlight lang="lua" lang="xml">
<export function='functionName' http='true' />
</syntaxhighlight>

You can code your function just as you would any normal function, returning as many values as you want, including tables and resources and most importantly elements. You ''cannot'' however return other 'userdata' values such as [[xmlnode|xmlnodes]] or functions.

===Calls from the HTTP web interface===
Using calls is probably easiest from the web interface and can be done almost seamlessly.

First, add this to your meta.xml file:
<syntaxhighlight lang="lua" lang="xml">
<include resource="ajax" />
</syntaxhighlight>

Secondly, add the following to the <head> section of the page you want to call from:
<syntaxhighlight lang="lua" lang="lua">
<* = call ( getResourceFromName("ajax"), "start", getResourceName(getThisResource()) ) *>
</syntaxhighlight>

Finally, you can create a javascript block in your page and call your functions almost as if they were local. The only difference is that the calls are aysnchronous - you should specify a callback function as the last argument for your call. This is called when the function returns.

Here's a simple example.

'''meta.xml'''
<syntaxhighlight lang="lua" lang="xml">
<meta>
<include resource="ajax" />
<script src='code.lua' />
<html src='page.htm' default='true' />
<export function='showChatMessage' http='true' />
</meta>
</syntaxhighlight>

'''code.lua'''
<syntaxhighlight lang="lua" lang="lua">
function showChatMessage ( message )
outputChatBox ( message )
return 5;
end
</syntaxhighlight>

'''page.htm'''
<syntaxhighlight lang="lua" lang="html">
<html>
<head>
<* = call ( getResourceFromName("ajax"), "start", getResourceName(getThisResource()) ) *>
<script type='text/javascript'>
function say() {
var message = document.getElementById('message')
showChatMessage ( message.value,
function ( number ) {
// the function has been called and returned something
message.value = "The function returned " + number;
}
);
}
</script>
</head>
<body>
<input type='text' id='message' /><input type='button' value='say' onclick='say();' />
</body>
</html>
</syntaxhighlight>

You can see (fairly complex) examples of how this can be done in the resources ''resourcebrowser'', ''resourcemanager'' and ''webadmin''.

==Securing the web interface==
The [[ACL]] has a number of rights that can affect what files can be accessed.
* general.http: If disabled, none of the http files can be accessed (except by game clients)
* resource.'''ResourceName''': If disabled, none of the files in the resource can be accessed
* resource.'''ResourceName'''.file.'''FileName''': If disabled, the file named cannot be accessed
* resource.'''ResourceName'''.function.'''FunctionName''': If disabled, the function cannot be called
These work as with other ACL rights - you can disable them for normal users and just enable them for Admin users, or any other group of users you wish.

==SDK==
There are a number of so-called 'SDKs' available that allow you to interface with the server from other programming languages. With these you could (in theory) write whole gamemodes. In practice this is probably a bad idea, but it is useful for statistics and administration. The PHP SDK is the most developed version. Feel free to modify or create your own SDKs - if you do please send us a copy.

* [[Java SDK]]
* [[Javascript SDK]]
* [[Perl SDK]]
* [[PHP SDK]]
* [[CSharp SDK|C# SDK]]

==See Also==
[[callRemote]] - Allows game servers to call functions on PHP pages (with the PHP SDK) and on other game servers.
[[Category:Scripting Concepts]]

CSharp SDK

2009-10-15T20:55:53Z

50p: Created page with '__TOC__ Many languages can make HTTP POST requests with JSON, C# can do too. This is C# SDK for MTA. It allows you to call any HTTP exported functions from resources. The SDK its…'

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

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

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

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

2. Create instance of MTA class:

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

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

'''OR'''

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

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

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

'''OR'''

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

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

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

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

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

==Download==
You can download C# MTA SDK here:
*[http://scripteditor.beta.mtasa.com/files/MTA_SDK_1.0.zip C# MTA SDK 1.0]

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

GetPedAnimationData

2009-10-09T22:06:57Z

50p: /* function needs checking */

__NOTOC__
{{Client function}}
{{Needs Checking|This function doesn't exist in 1.0.1 --[[User:50p|50p]] 22:06, 9 October 2009 (UTC)}}
This function is used to return the animation data of a [[player]] or [[ped]] that was set using [[setPedAnimation]].

==Syntax==
<syntaxhighlight lang="lua">
table getPedAnimationData ( ped thePed )
</syntaxhighlight>

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

===Returns===
Returns a [[table]] containing information about animation. These keys are present in the table:
*'''name:''' string - name of the animation
*'''block_name:''' string - name of animation block
*'''loop:''' boolean - is animation looping?
*'''update_position:''' boolean - updating position
*'''interruptible:''' boolean - is animation interruptible?
*'''time:''' float - duration of the animation
*'''start_time:''' float - starting point
*'''finished:''' boolean - has animation finished playing?
*'''speed:''' float - speed
*'''blend_speed:''' float - blending speed

==See Also==
{{Client ped functions}}
[[Category:Needs Example]]

Scripting Introduction

2009-10-09T14:25:55Z

50p: /* added link to MTA:SE wiki page */

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

Everything that has to do with scripting happens in resources, what a resource does defines if it is a gamemode, a map or anything else. MTA comes with resources that you can optionally use in your gamemodes, such as maplimits to keep playings within a playing area or deathpickups to create weapon pickups.

'''Your first step to begin Lua scripting should be using an Lua editor. This makes scripting much easier. We recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] or [http://luaedit.luaforge.net/ LuaEdit]. There is also an unofficial [[MTASE|MTA Script Editor]] (in work-in-progress state) that you can test out.'''

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

/Your MTA Server/mods/deathmatch/resources/

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

Now you should be under this directory:

/Your MTA Server/mods/deathmatch/resources/myserver/

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Where to go from here==
You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.

From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts.

[[ru:Scripting Introduction]]
[[it:Introduzione allo scripting]]

OnClientPlayerStuntStart

2009-10-05T19:21:17Z

50p: /* Example */

__NOTOC__
{{Client event}}
This event is triggered whenever the local player starts doing a vehicle stunt.

==Parameters==
<syntaxhighlight lang="lua">
string stuntType
</syntaxhighlight>

*'''stuntType''': the type of stunt the player is starting to perform. Valid types are:
{{StuntTypes}}

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

==Example==
This is a simple stunt script which tells player what stunt he/she started and finished, time the stunt taken to perform and distance travelled while stunting.
<syntaxhighlight lang="lua">
addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType )
outputChatBox( "You started stunt: " .. stuntType );
end
);

addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType, stuntTime, distance )
outputChatBox( "You finished stunt: " .. stuntType ..", Time: " .. tostring( stuntTime ).. ", Distance: " .. tostring( distance ) );
end
);
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerStuntFinish

2009-10-05T19:20:57Z

50p: /* Example */

__NOTOC__
{{Client event}}
This event is triggered whenever the local player finishes a vehicle stunt.

==Parameters==
<syntaxhighlight lang="lua">
string stuntType, int stuntTime, float stuntDistance
</syntaxhighlight>

*'''stuntType''': the type of stunt the player just performed. Valid types are:
{{StuntTypes}}
*'''stuntTime''': the number of miliseconds the stunt lasted.
*'''stuntDistance''': the distance traveled while doing the stunt.

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

==Example==
This is a simple stunt script which tells player what stunt he/she started and finished, time the stunt taken to perform and distance travelled while stunting.
<syntaxhighlight lang="lua">
addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType )
outputChatBox( "You started stunt: " .. stuntType );
end
);

addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType, stuntTime, distance )
outputChatBox( "You finished stunt: " .. stuntType ..", Time: " .. tostring( stuntTime ) .. ", Distance: " .. tostring( distance ) );
end
);
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerStuntStart

2009-10-05T19:20:18Z

50p: /* added example */

__NOTOC__
{{Client event}}
This event is triggered whenever the local player starts doing a vehicle stunt.

==Parameters==
<syntaxhighlight lang="lua">
string stuntType
</syntaxhighlight>

*'''stuntType''': the type of stunt the player is starting to perform. Valid types are:
{{StuntTypes}}

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

==Example==
This is a simple stunt script which tells player what stunt he/she started and finished, time the stunt taken to perform and distance travelled while stunting.
<syntaxhighlight lang="lua">
addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType )
outputChatBox( "You started stunt: " .. stuntType );
end
);

addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType, stuntTime, distance )
outputChatBox( "You finished stunt: " .. stuntType ..", Time: " .. stuntTime .. ", Distance: " .. tostring( distance ) );
end
);
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerStuntFinish

2009-10-05T19:19:57Z

50p: /* added example */

__NOTOC__
{{Client event}}
This event is triggered whenever the local player finishes a vehicle stunt.

==Parameters==
<syntaxhighlight lang="lua">
string stuntType, int stuntTime, float stuntDistance
</syntaxhighlight>

*'''stuntType''': the type of stunt the player just performed. Valid types are:
{{StuntTypes}}
*'''stuntTime''': the number of miliseconds the stunt lasted.
*'''stuntDistance''': the distance traveled while doing the stunt.

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

==Example==
This is a simple stunt script which tells player what stunt he/she started and finished, time the stunt taken to perform and distance travelled while stunting.
<syntaxhighlight lang="lua">
addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType )
outputChatBox( "You started stunt: " .. stuntType );
end
);

addEventHandler( "onClientPlayerStuntFinish", getRootElement( ),
function ( stuntType, stuntTime, distance )
outputChatBox( "You finished stunt: " .. stuntType ..", Time: " .. stuntTime .. ", Distance: " .. tostring( distance ) );
end
);
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPedChoke

2009-10-05T18:55:23Z

50p: /* added example */

{{Client event}}
__NOTOC__
This event is fired when a ped chokes due to the effect of a weapon such as tear gas grenades, fire extinguishers and spray cans.
==Parameters==
<syntaxhighlight lang="lua">
int weaponID, ped responsiblePed
</syntaxhighlight>
*'''weapon:''' an [[int]] representing the ID of the weapon which caused the choking.
*'''responsiblePed:''' the ped responsible for causing the choking, possiblly nil.

==Source==
The source of this event is the ped who is choking.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the ped will not be choked.

==Example==
<section class="client" name="Client" show="true">
This example disables choking effects from the tear gas grenades.
<syntaxhighlight lang="lua">
addEventHandler( "onClientPedChoke", getRootElement( ),
function ( )
cancelEvent( );
end
);
</syntaxhighlight>
</section>

==See Also==
===Client ped events===
{{Client_ped_events}}
===Client event functions===
{{Client_event_functions}}

OnClientResourceStop

2009-10-05T18:53:47Z

50p: /* added example */

{{Client event}}
__NOTOC__
This event is triggered when a [[resource]] is stopped.

==Parameters==
<syntaxhighlight lang="lua">
resource stoppedResource
</syntaxhighlight>

*'''stoppedResource''': the [[resource]] that was stopped.

==Source==
The [[event system#Event source|source]] of this event is the client [[root element]].

==Example==
This example outputs name of resource that was started.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", getRootElement( ),
function ( stoppedRes )
outputChatBox( "Resource stopped: " .. getResourceName( stoppedRes ) );
end
);
</syntaxhighlight>

==See Also==
===Client resource events===
{{Client_resource_events}}
===Client event functions===
{{Client_event_functions}}

OnClientResourceStart

2009-10-05T18:52:35Z

50p: /* added example */

{{Client event}}
__NOTOC__
This event is triggered when a [[resource]] is started. Please note that this is '''not''' triggered the same side as the serverside variant [[onResourceStart]]. The event is triggered when any ''clientside resources'' are started. This means it is triggered when a clientside script is initiated after a download, which includes downloading after join.

==Parameters==
<syntaxhighlight lang="lua">
resource startedResource
</syntaxhighlight>

*'''startedResource''': the [[resource]] that was started.

==Source==
The [[event system#Event source|source]] of this event is the started resource's [[root element]].

==Example==
This example outputs name of resource that was started.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", getRootElement( ),
function ( startedRes )
outputChatBox( "Resource started: " .. getResourceName( startedRes ) );
end
);
</syntaxhighlight>

==See Also==
===Client resource events===
{{Client_resource_events}}
===Client event functions===
{{Client_event_functions}}