Multi Theft Auto: Wiki - User contributions [en]

GetWeaponState

2012-11-29T17:47:08Z

MTA SE: /* unnecessary red frame in Returns block */

__NOTOC__
{{Client function}}
{{Needs Example}}
Get the state of the custom weapon.

==Syntax==
<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The [[weapon]] to get the target of.

===Returns===
Returns a [[string]] indicating the weapon state, ''false'' otherwise.
* '''reloading''': The weapon is reloading
* '''firing''': The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate
* '''ready''': The weapon is idle

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

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

==See Also==
{{Client weapon creation functions}}

SetWaterDrawnLast

2012-11-29T17:42:28Z

MTA SE: /*Incorrect function name in syntax block*/

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.3.0|4585|
This function change [[water]] rendering order.
}}

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

===Required Arguments===
*'''bEnabled''': A boolean value determining water drawn last.

===Returns===
Returns ''true'' if set water drawn last is successfully, ''false'' otherwise.

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

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

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

IsWaterDrawnLast

2012-11-29T08:20:36Z

MTA SE: /*Incorrect function name in syntax block*/

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.3.0|4585|
This function get [[water]] rendering order.
}}

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

===Returns===
Returns ''true'' if water drawn last in rendering order, ''false'' otherwise.

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

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

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

MTASE

2012-07-11T00:47:24Z

MTA SE:

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

==Introduction==
MTA Script Editor is a tool for Lua scripters, or an Integrated Development Environment (IDE). 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. Even the management of resources can be a bit annoying sometimes. For instance, if you want to add a new script file to your resource first you have to create the file, then add the path to the file into meta.xml. Worst of all, if you ever forget about adding the file to meta.xml you end up hitting your head against the wall wondering why your script doesn't work.

We wanted to do something that would speed this process up so you could do so much in so little time. Previewing resources such as images and sounds have never been so easy. We are aiming for something along the lines of Visual Studio IDE.

==What we offer==
We have been working on this tool for quite some time 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 a nice time". Even though I'm working alone we are progressing smoothly in the development.

We have implemented the following features:
*Loading resources
*Easy resource management
*Preview resources such as sound and image files
*Lua and XML syntax highlighting
*On-the-fly (live) Lua syntax checker
*'New resource' wizard - allows you to create new resource with a few clicks
*Switching between resources
*Tabs for script files
*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
*ResourceZipper

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

*'''Function tooltip''' (available from 0.3) - tooltip showing function description. Moving mouse over function names in the function list (not the suggested functions list)
[[Image:MTASE_func_desc.png‎]]

*'''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. Just visit [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 our MTA forum topic] and post your suggestions.

==Download==

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

==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. Works on Windows 7 too!
* You must have both MTA Client and Server installed.

==FAQ==

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

===Loading irrKlang.NET2.0 library failed to load! This means you will not be able to preview sound files.===
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.

'''(THIS HAS BEEN FIXED IN 0.3)'''

===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. You should replace ampersands with '''&amp;''' as this is the correct way to represent an ampersand in XML.

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.

'''(THIS HAS BEEN FIXED IN 0.3)'''

==Contact==
You can 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 & GUI 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...

[[es:MTASE]]

CreateVehicle

2012-07-05T20:05:04Z

MTA SE: /* explain direction parameter */

{{Needs_Checking|Numberplates only seem to work for some vehicles, and then only for the front or rear plate only}}
{{Needs_Checking|Explain the direction parameter which should always be false and what is the point of having a parameter whose value need to be the same all the time. --[[User:MTA SE|MTA SE]] 20:05, 5 July 2012 (UTC)}}
__NOTOC__
{{Server client function}}
{{note_box|Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.}}
This function creates a vehicle at the specified location.

Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

==Syntax==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
</syntaxhighlight>

===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''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}}
* '''rx''': A floating point number representing the rotation about the X axis in degrees.
* '''ry''': A floating point number representing the rotation about the Y axis in degrees.
* '''rz''': A floating point number representing the rotation about the Z axis in degrees.
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.
* '''direction''': A boolean which should be set to false. *SERVER ONLY*
{{New feature/item|3.0120|1.2||
* '''variant1''': An integer for the first vehicle variant see [[Vehicle variants]]
* '''variant2''': An integer for the second vehicle variant see [[Vehicle variants]]
}}

===Returns===
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.

==Example==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="true">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

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

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

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

==See Also==

{{Vehicle functions}}

CancelLatentEvent

2012-07-04T06:04:47Z

MTA SE: /* added sections for server/client syntax */

__NOTOC__
{{Server client function}}
Stops a latent event from completing

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table cancelLatentEvent( player thePlayer, int handle )
</syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player who is receiving the event.
*'''handle:''' A handle previous got from [[getLatentEventHandles]].
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table cancelLatentEvent( int handle )
</syntaxhighlight>
===Required Arguments===
*'''handle:''' A handle previous got from [[getLatentEventHandles]].
</section>

===Returns===
Returns a true if the latent event was successfully cancelled, or false if it was not

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

==Requirements==
{{Requirements|1.3.0-9.03772|1.3.0-9.03772|}}

==See Also==
{{Event functions}}

GetLatentEventStatus

2012-07-04T06:02:31Z

MTA SE: /* added sections for server/client syntax */

__NOTOC__
{{Server client function}}
Gets the status of one queued latent event.

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getLatentEventStatus( player thePlayer, int handle )
</syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player who is receiving the event.
*'''handle:''' A handle previous got from [[getLatentEventHandles]].
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table getLatentEventStatus( int handle )
</syntaxhighlight>
===Required Arguments===
*'''handle:''' A handle previous got from [[getLatentEventHandles]].
</section>

===Returns===
Returns a table with the following info or false if invalid arguments were passed:
*'''tickStart:''' A number estimating how many ticks until the data transfer starts (Negative means the transfer has already started)
*'''tickEnd:''' A number estimating how many ticks until the data transfer completes
*'''totalSize:''' A number representing how many bytes in total this transfer will transfer
*'''percentComplete:''' A number between 0-100 saying how much is done

==Example==
<section name="Client" class="client" show="true">
The example starts a latent event and outputs the status of the transfer to the client console
<syntaxhighlight lang="lua">
function beginTransfer()
triggerLatentServerEvent("blah", resourceRoot, myVeryLongString) -- Start latent event
myHandle = getLatentEventHandles()[#getLatentEventHandles()] -- Get last latent event handle
myTimer = setTimer( updateStatus, 1000, 0 ) -- Output status once a second
end

function updateStatus()
local status = getLatentEventStatus(myHandle) -- Get latent event status
if not status then
killTimer(myTimer) -- getLatentEventStatus returns false when the handle is no longer valid
else
outputConsole( "Transfer status:"
.. " tickStart:" .. tostring(status.tickStart)
.. " tickEnd:" .. tostring(status.tickEnd)
.. " totalSize:" .. tostring(status.totalSize)
.. " percentComplete:" .. tostring(status.percentComplete)
)
end
end
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.0-9.03772|1.3.0-9.03772|}}

==See Also==
{{Event functions}}

GetLatentEventHandles

2012-07-04T05:57:09Z

MTA SE: /* added sections for server/client syntax */

__NOTOC__
{{Server client function}}
Gets the currently queued latent events. The last one in the table is always the latest event queued. Each returned handle can be used with [[getLatentEventStatus]] or [[cancelLatentEvent]]

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getLatentEventHandles ( player thePlayer )
</syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player who is receiving the events.
</section>

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

===Returns===
Returns a table of handles or false if invalid arguments were passed.

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

==Requirements==
{{Requirements|1.3.0-9.03772|1.3.0-9.03772|}}

==See Also==
{{Event functions}}

Server Scripting Functions

2012-07-03T06:36:11Z

MTA SE: /* added __TOC__ */

<pageclass class="server"></pageclass>
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function or event, use [[Requested Functions and Events]] or http://bugs.mtasa.com.

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.

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

'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''

__TOC__

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

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

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

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Module functions==
{{Module functions}}

==Object functions==
{{Object functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Resource functions==
{{Resource functions}}

==Serial functions==
{{Serial functions}}

==Server functions==
{{Server functions}}

==Settings registry functions==
{{Settings registry functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

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

==Water functions==
{{Water functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

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

[[ru:Server Scripting Functions]]
[[es:Funciones_del_Server]]
[[de:Server-Seitige Scripting Funktionen]]

MTASE

2011-11-17T21:21:06Z

MTA SE: /* Loading irrKlang.NET2.0 library failed to load!\nThis means you will not be able to preview sound files. */

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

==Introduction==
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. Works on Windows 7 too!
* 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===

===Loading irrKlang.NET2.0 library failed to load! This means you will not be able to preview sound files.===
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. You should replace ampersands with '''&amp;''' as this is the correct way to represent an ampersand in XML.

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 & GUI 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...

[[es:MTASE]]

MTASE

2011-11-17T21:20:56Z

MTA SE: /* Changed the title to: Loading irrKlang.NET2.0 library failed to load!\nThis means you will not be able to preview sound files. */

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

==Introduction==
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. Works on Windows 7 too!
* 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===

===Loading irrKlang.NET2.0 library failed to load!\nThis means you will not be able to preview sound files.===
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. You should replace ampersands with '''&amp;''' as this is the correct way to represent an ampersand in XML.

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 & GUI 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...

[[es:MTASE]]