Multi Theft Auto: Wiki - User contributions [en]

Int

2009-09-02T11:39:07Z

1337MaVe:

An integer is any whole number. It can be positive, zero, or negative. Examples: 1 0 -1 3 1 6 6 19 -152 5127 -8913 9000

Note: it can also be over 9000

A number with decimals is referred to as a [[float]] number
[[Category:Scripting Concepts]]

OnPlayerContact

2009-08-31T18:05:33Z

1337MaVe:

__NOTOC__
{{Server event}}
This event is triggered when a player stands on a different element than before.

==Parameters==
<syntaxhighlight lang="lua">
element previousElement, element currentElement
</syntaxhighlight>

*'''previousElement''': The [[element]] player was standing on before. ''nil'' if none.
*'''currentElement''': The new [[element]] that the player is standing on now. ''nil'' if none.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who hit an element.

==Example==
This example outputs the element type of an element you have hit
<syntaxhighlight lang="lua">
function outputElementType ( prev, current )
if ( current ) then
outputChatBox ( "You have hit an "..getElementType ( current ) )
end
end
addEventHandler ( "onPlayerContact", getRootElement(), outputElementType )
</syntaxhighlight>

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

SetVehicleTaxiLightOn

2009-08-30T19:46:12Z

1337MaVe:

__NOTOC__
[[Category:Needs_Example]]
{{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}}

Introduction to Scripting the GUI

2009-08-30T19:38:39Z

1337MaVe:

One important feature in MTA:SA is the ability to script customized GUI (Graphic User Interface). The GUI consists of windows, button, edit boxes, check boxes... Almost every standard form components in graphical environments. They can be displayed while the user is in game, and used for inputs and outputs in place of traditional commands.

[[Image:AdminGUI.png|thumb|Admin Console GUI]]

==A tutorial to make a login window==
In this tutorial we'll make a simple login window, with two input boxes and a button. The window appears when the player joins the game, and once the button is clicked, the player is spawned. The tutorial will continue the gamemode we made in [[Scripting Introduction|Introduction to Scripting]]. We'll also take a look at client-side scripting.

===Draw the window===
All the GUI must be made client side. It is also a good practice to keep all the client scripts in a separate folder. Browse to /Your MTA Server/mods/deathmatch/resources/myserver/ directory, and create a folder named "client". Under /client/ directory, create a text file and name it "gui.lua", and in this file we will write a funtion that draws the window:
<syntaxhighlight lang="lua">
function CreateLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)
end
</syntaxhighlight>
You may click on the function's name to read its documentation. Note that the coordinates of the window is in ''percentage'' of the screen. It means that if the screen is labelled with 0 on the left end, and 1 on the right end, and if "X" is 0.5, it represents the middle of the screen. It applies to Y, window width, and window height as well (if "width" is 0.5, the window will be half as wide as the screen). Next we'll add the text labels (saying "username:" and "password:"), edit boxes and a button. Replace the function with its complete version:
<syntaxhighlight lang="lua">
function CreateLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)

X = 0.0825
Y = 0.2
Width = 0.25
Height = 0.25
guiCreateLabel(X, Y, Width, Height, "Username", true, wdwLogin)
Y = 0.5
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)

X = 0.415
Y = 0.2
Width = 0.5
Height = 0.15
edtUser = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
Y = 0.5
edtPass = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
guiEditSetMaxLength(edtUser, 50)
guiEditSetMaxLength(edtPass, 50)

X = 0.415
Y = 0.7
Width = 0.25
Height = 0.2
btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)

guiSetVisible(wdwLogin, false)
end
</syntaxhighlight>
Note that every GUI component created is a child of the window, this is done by specifying the parent element (wdwLogin, in this case) when creating the component:
<syntaxhighlight lang="lua">
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)
</syntaxhighlight>
This is very useful because later when you need to control the entire set of GUI, you can just refer to the parent element. For example:
<syntaxhighlight lang="lua">
guiSetVisible(wdwLogin, false) --hides all the GUI we made so we can show them to the player at the appropriate moment.
</syntaxhighlight>

===Using the function we wrote===
The CreateLoginWindow function is done, but it won't do anything until we call it. It is recommended to create all GUI when the client resource starts, hide them, and show them to player later when needed. Therefore, we'll write an event handler for "[[onClientResourceStart]]" to create the window:
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
CreateLoginWindow()
end
)
</syntaxhighlight>
We would like to show the window when the client joins the game, using the same event "[[onClientResourceStart]]". Now the event handler looks like:
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
CreateLoginWindow()

outputChatBox("Welcome to My MTA:SA Server, please log in. ")

if (wdwLogin ~= nil) then
guiSetVisible(wdwLogin, true)
end

showCursor(true)
guiSetInputEnabled(true)
end
)
</syntaxhighlight>
Note that we have a security check before making the window visible, so that in case the window had not been created, in which case wdwLogin is not a valid element, we don't get an error. The [[showCursor]] function gives control to your mouse, and [[guiSetInputEnabled]] makes sure when you type in the GUI, certain letters like "A", "S", "D", "W", "T" don't move your character or bring out the chatbox input. In the next step, we'll make the button work as desired.

===Scripting the button===
When the player clicks on any part of the GUI, the event "[[onClientGUIClick]]" will be triggered for the GUI component you clicked on. For instance, if you click on the button, you can add the event handler attached to the button:
<syntaxhighlight lang="lua">
addEventHandler("onClientGUIClick", theButtonElement, theHandlerFunction, false)
</syntaxhighlight>
In our script, we only need the event handler attached to the button. When it's clicked, the client will tell the server to spawn the player. Find the event handler code for "onClientResourceStart" from the previous section, and add the following line right AFTER CreateLoginWindow() is called:
<syntaxhighlight lang="lua">
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>
The event handler must be added here because it makes sure variable btnLogin contains the actual button. You cannot attach an event to an non-existant element. You should have noticed that we need the "clientSubmitLogin" function, as stated in the line above.
<syntaxhighlight lang="lua">
function clientSubmitLogin(button)
if button == "left" then

triggerServerEvent("SubmitLogin", getRootElement(), guiGetText(edtUser), guiGetText(edtPass))
guiSetInputEnabled(false)
guiSetVisible(wdwLogin, false)
showCursor(false)
end
end
</syntaxhighlight>
The variable "button" is passed by the event handler, and it's a string with the name of the button (either "left" or "right"). Here we also hit a new concept, which is custom events. Custom events can be triggered by script from the same side (server to server, or client to client), or from the other side (server to client, or vice versa). Here we use the [[triggerServerEvent]] function to trigger a custom event on the server, "SubmitLogin".

At this point we have all the code needed on the client side. On the server side, recall that we are spawning the player as soon as they join, as shown below:
<syntaxhighlight lang="lua">
function joinHandler()
local x,y,z
x = 1959.55
y = -1714.46
z = 10
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
outputChatBox("Welcome to My Server", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>
However, since we are going to spawn the player when the button is clicked, we must replace the "onPlayerJoin" event with the custom event triggered by the client script. Replace the above code with the following:
<syntaxhighlight lang="lua">
function joinHandler(username, password)
local x,y,z
x = 1959.55
y = -1714.46
z = 10
if (client) then
spawnPlayer(client, x, y, z)
fadeCamera(client, true)
outputChatBox("Welcome to My Server", client)
end
end

addEvent("SubmitLogin", true)
addEventHandler("SubmitLogin", getRootElement(), joinHandler)
</syntaxhighlight>
Note that the second arguement of [[addEvent]] function (the one with value "true") specifies whether the event can be triggered by the other side, therefore we need to turn it on since the client is triggering it. Also note the variable "client", it's an internal variable used by MTA to identify the player who triggered the event.

Finally, do not forget to include the new gui.lua file in the meta.xml of the main resource, and label it as a client script:
<syntaxhighlight lang="xml">
<script src="client/gui.lua" type="client" />
</syntaxhighlight>

As to this point, we have a basic login window that spawns the player when the "login" button is clicked. You can also use the username and password submitted by the [[triggerServerEvent]] function to verify the player's identify before spawning him.

[[it:Introduzione_allo_scripting_della_GUI]]
[[ru:Introduction to Scripting the GUI]]

TextItemSetText

2009-08-27T13:51:19Z

1337MaVe:

__NOTOC__
{{Server function}}
Overwrites a previously created text item with the specified text.

==Syntax==
<syntaxhighlight lang="lua">void textItemSetText ( textitem theTextitem, string text )</syntaxhighlight>

===Required Arguments===
*'''theTextitem:''' An existing text item that was previously created with [[textCreateTextItem]]
*'''text:''' The new text for the text item

==Example==
Here, it is being used to update a scoreboard:
<syntaxhighlight lang="lua">
function updateScoreOnWasted ( ammo, killer, weapon )
if ( killer ~= false) then -- Check to see if anything killed the player
local killerTeam = getTeamName ( getPlayerTeam(killer) )
if ( killerTeam == "grove" ) then -- if a Grove player scored the kill
groveteamscore = groveteamscore + 1 -- Grove gets 1 point
textItemSetText ( scoregrove, tostring(groveteamscore) ) -- Update scoreboard.
elseif ( killerTeam == "balla" ) then -- if a Balla player scored the kill
ballateamscore = ballateamscore + 1 -- Ballas get 1 point
textItemSetText ( scoreballa, tostring(ballateamscore) ) -- Update scoreboard.
end
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), updateScoreOnWasted )
</syntaxhighlight>

==See Also==
{{Text functions}}

TextItemSetText

2009-08-27T13:50:53Z

1337MaVe:

__NOTOC__
{{Server function}}
Overwrites a previously created text item with the specified text.

==Syntax==
<syntaxhighlight lang="lua">void textItemSetText ( textitem theTextitem, string text )</syntaxhighlight>

===Required Arguments===
*'''theTextitem:''' An existing text item that was previously created with [[textDisplayCreateText]]
*'''text:''' The new text for the text item

==Example==
Here, it is being used to update a scoreboard:
<syntaxhighlight lang="lua">
function updateScoreOnWasted ( ammo, killer, weapon )
if ( killer ~= false) then -- Check to see if anything killed the player
local killerTeam = getTeamName ( getPlayerTeam(killer) )
if ( killerTeam == "grove" ) then -- if a Grove player scored the kill
groveteamscore = groveteamscore + 1 -- Grove gets 1 point
textItemSetText ( scoregrove, tostring(groveteamscore) ) -- Update scoreboard.
elseif ( killerTeam == "balla" ) then -- if a Balla player scored the kill
ballateamscore = ballateamscore + 1 -- Ballas get 1 point
textItemSetText ( scoreballa, tostring(ballateamscore) ) -- Update scoreboard.
end
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), updateScoreOnWasted )
</syntaxhighlight>

==See Also==
{{Text functions}}

SetElementData

2009-08-13T16:35:33Z

1337MaVe:

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

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value, [bool synchronize = true] )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, [bool synchronize = true], var value )
</syntaxhighlight>
</section>

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

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

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

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

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

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

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

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

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

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

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

==See Also==
{{Element_functions}}

IfElse

2009-08-09T08:16:55Z

1337MaVe:

{{Useful Function}}
__NOTOC__
This function just adds a possibility to integrate a condition in e.g. some variable definition. It is as useful as simple. It's like the short ”(c) ? t : f ;“ statement that exists in e.g. PHP or JavaScript.

''Note: This function is basically on the wiki to enable using it in other useful functions.''

==Syntax==
<syntaxhighlight lang="lua">var IfElse( bool condition, var trueReturn, var falseReturn )</syntaxhighlight>

===Required Arguments===
* '''condition''': A condition like you could use it in an if-statement.
* '''trueReturn''': The value that should be returned if the condition is true.
* '''falseReturn''': The value that should be returned if the condition is false.

===Returns===
Returns the second argument if condition is true, the third otherwise.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function IfElse(condition, trueReturn, falseReturn)
if (condition) then return trueReturn
else return falseReturn end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example adds a command to retrieve the actual player count.
<syntaxhighlight lang="lua">
-- define the commandhandler function
function CmdPlayerCount(source)
-- get the actual player count
local playerCount = getPlayerCount()
-- send message to the player
outputChatBox("There "..IfElse(playerCount == 1, "is", "are").." actually "..playerCount.." Player"..IfElse(playerCount == 1, "", "s").." online.", source)
end
-- add the command handler
addCommandHandler("playerCount", CmdPlayerCount, false, false)
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}

ExecuteCommandHandler

2009-08-09T07:39:02Z

1337MaVe:

{{Server client function}}
__NOTOC__
This function will call all the attached functions of an existing console command, for a specified player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool executeCommandHandler ( string commandName, player thePlayer, [ string args ] )</syntaxhighlight>

==Required Arguments==
*'''commandName:''' The name of the command you wish to execute. This is what must be typed into the console to trigger the function.
*'''thePlayer:''' The player that will be presented as executer of the command to the handler function(s) of the command

==Optional Arguments==
{{OptionalArg}}
* '''args:''' Additional parameters that will be passed to the handler function(s) of the command that is called.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool executeCommandHandler ( string commandName, [ string args ] )</syntaxhighlight>

==Required Arguments==
*'''commandName:''' The name of the command you wish to execute. This is what must be typed into the console to trigger the function.

==Optional Arguments==
{{OptionalArg}}
* '''args:''' Additional parameters that will be passed to the handler function(s) of the command that is called.
</section>
===Returns===
Returns ''true'' if the command handler was called successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example defines a command handler for the command ''createmarker'' (which creates a red marker at the caller's position). It then creates a second command handler ''createmarker2'' which will call the first one.
<syntaxhighlight lang="lua">
-- Define the function that will handle the 'createmarker' command
function consoleCreateMarker ( playerSource, commandName )
-- If a player triggered it (rather than the admin) then
if ( playerSource )
-- Get that player's position
x, y, z = getElementPosition ( playerSource )
-- Create a marker at their position
createMarker ( x, y, z, 0, "checkpoint", 255, 0, 0, 255 )
-- Output it in the chat box
outputChatBox ( "You got a red marker", playerSource )
end
end
-- Add the function as a handler for the command
addCommandHandler ( "createmarker", consoleCreateMarker )

-- Define a second console command that will just call the first.
-- First define the function
function consoleCreateMarker2 ( playerSource, commandName )
-- re-route back to the original
executeCommandHandler ( "createmarker", playerSource )
end
-- Then add it as a handler for the new console command
addCommandHandler ( "createmarker2", consoleCreateMarker2 )
</syntaxhighlight>
</section>

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

Talk:SetPedAnimation

2009-08-09T07:32:17Z

1337MaVe:

Why is there only the ''one'' ped argument actually needed? An argument specyfing if it should start or cancel would be more useful imo [[User:1337MaVe|1337MaVe]] 07:32, 9 August 2009 (UTC)

Talk:SetPedAnimation

2009-08-09T07:30:50Z

1337MaVe: Created page with 'Why is there only the ''one'' ped argument actually needed? ~~~~'

Why is there only the ''one'' ped argument actually needed? [[User:1337MaVe|1337MaVe]] 07:30, 9 August 2009 (UTC)

OnPlayerChangeNick

2009-08-07T07:49:58Z

1337MaVe: Added example

[[Category:Incomplete Event]]
{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.

==Source==
The source of this event is the player that changed his nick

==Example==
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
local thePlayer = getPlayerFromNick(newNick)
outputChatBox("Sorry, there already exists an account with your new nickname as username.", thePlayer, 0, 255, 0)
outputChatBox("Please choose another one.", thePlayer, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight>

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

DE/Server Anleitung

2009-08-04T07:05:18Z

1337MaVe: /* Allgemein */

==Vorwort==
Einen MTA Server einzurichten ist einfacher, als es aussieht. Wenn Du dieser Anleitung folgst, brauchst Du nur wenige Minuten, um Deinen eigenen MTA Server zu konfigurieren.

==Installation==
===Windows (DP2)===
* Windows-Server von der [http://mtasa.com/deathmatch.html Downloadseite] herunterladen.
* Die Datei öffnen und auswählen, wohin der Server entpackt werden soll.
* Zum Schluss auf "Extract" klicken

===Windows (1.0)===
Der Windows-Server für die Nightlies ist bereits im Installer integriert.
* Aktuelle Nightly von [http://nightly.mtasa.com/mtasadm-1.0-r1294.exe nightly.mtasa.com] herunterladen
* Während der Installation wird der Server standardmäßig installiert
* Zusätzlich kann man noch die [http://code.google.com/p/multitheftauto-resources/downloads/list aktuellen Resourcen von der Google-Code-Seite] herunterladen. Diese werden dann in <server>/mods/deathmatch/resources entpackt.

==Den Server konfigurieren==
Der Server kann sowohl über die Konsole (das Fenster, das sich öffnet, wenn man die MTA Server.exe aufmacht) als auch im Spiel oder über das Webinterface verwaltet werden. Für die letzten beiden Optionen ist es nötig, mindestens einen Administrator hinzuzufügen.

===Allgemein===
Die hauptsächlichen Konfigurationsoptionen eures Server befinden sich in '''<server>/mods/deathmatch/mtaserver.conf'''.
Gespeicherte Accounts sind in '''<server>/mods/deathmatch/accounts.xml''' und Zugangsberechtigungen in '''<server>/mods/deathmatch/accounts.xml''' zu finden.

===Port-Konfiguration===
Hier wird erklärt welche Ports ihr öffnen müsst, damit auch andere Spieler auf eurem Server spielen können.

Als erstes öffnet ihr die Datei '''<server>/mods/deathmatch/mtaserver.conf'''' und sucht nach diesen Zeilen:
<syntaxhighlight lang="xml">
<serverport>22004</serverport>
<httpport>22005</httpport>
</syntaxhighlight>
Diese geben den Port für den Gameserver (in diesem Fall 22004) und für den eingebauten Webserver (22005) an.

Um den Server überhaupt von Außen erreichbar zu machen, müssen die entsprechenden Ports freigegeben werden. Auf der Seite [http://portforward.com/ portforward.com] wird für viele Router erklärt, wie dies funktioniert. Auch in eurer Firewall müssen (falls vorhanden) die Ports konfiguriert werden. Der MTA-Server an sich benötigt '''UDP''' für <serverport>, und sofern ihr keinen externen Webserver (später dazu mehr) nutzen wollt, noch eine TCP-Freigabe für <httpport>.

Um festzulegen, ob euer Server für Jeden in der Serverliste angezeigt werden soll, ist folgende Option vorhanden:
<syntaxhighlight lang="xml">
<ase>1</ase> 
<object name="user.BennyLava" />
</group>
...
</acl>
</syntaxhighlight>
Resourcen und Accounts kann man in Gruppen einordnen, und jeder Gruppe ist mindestens eine [[Access Control List]] zugeordnet. Diese gibt an, welche Rechte die Resource oder der Benutzer haben, welche Befehle jemand ausführen oder nicht ausführen darf und welche der Scripting-Funktionen nur bestimmten Resourcen zur Verfügung stehen. Alle registrierten und unregistrierten Benutzer fallen standardmäßig in die Gruppe ''Everyone'', die einigen Beschränkungen unterliegt, so fehlt beispielsweise das Recht zum Kicken und Bannen.

''Weitere Informationen zur ACL finden sich auf einer [[Access Control List|Extraseite]].''

===Das Webinterface===
===externen Webserver einrichten===
==Den Server verwalten==
Sobald man auf dem Server ist, kann man sich nun mit '''/login <passwort>''', oder falls der Benutzername unterschiedlich zum Accountname (in der ACL) ist, '''/login <accontname> <passwort>'''.

War dies erfolgreich, ist man Admin und kann einige Befehle, die speziell für Administratoren gedacht sind, nutzen.

Abgesehen von den in der '''mtaserver.conf''' eingestellten Resourcen für den Server-Start kann man jederzeit weitere starten oder bereits laufende anhalten, dazu gibt es die die Befehle
* '''start <Name der Resource>''', die die Resource mit dem Namen startet,
* '''stop <Name der Resource>''', um die Resource wieder zu stoppen, und
* '''restart <Name der Resource>''', welcher die Resource erst anhält und wieder startet.

Eine Übersicht über alle Befehle kann man mittels '''help''' in der Server- oder Ingame-Konsole (standardmäßig mit F8 bzw. ` erreichbar) anzeigen lassen.

Resourcen können weitere Funktionen und Befehle bereitstellen. Als Beispiel sei hier nur das Admin-Panel genannt, welches sich beim Einloggen mit der Meldung ''Press 'p' to open your admin panel'' zu Wort meldet. Durch Drücken dieser Taste erhält man Zugriff auf eine grafische Oberfläche, die viele zusätzliche Funktionen bereitstellt, unter anderem Kicken, Bannen und Teleportieren.

==Resourcen hinzufügen/aktualisieren==
Die Resourcen können entweder als ZIP-Archive gepackt sein oder einfache Ordner, in denen sich die zugehörigen Dateien befinden - beides wird von MTA unterstützt.
# Die Resource (ZIP oder Ordner) nach ''<server>/mods/deathmatch/resources'' kopieren
# Als Admin in der Konsole '''refresh''' eingeben. Dies durchsucht den kompletten resources-Ordner nach geänderten Resourcen, neue Resourcen werden der internen Liste hinzugefügt und nicht mehr existierende angehalten und gelöscht.

==Resourcen entfernen==
Sofern Resourcen nicht mehr benötigt werden, kann man diese ähnlich einfach entfernen:
# Den Ordner oder das ZIP-Archiv aus ''<server>/mods/deathmatch/resources'' löschen
# Als Admin in der Konsole '''refresh''' eingeben.

==Einen Gamemode oder eine Map starten==
Für diesen Zweck steht die Resource [[Resource:Mapmanager|mapmanager]] bereit, auf deren Dokumentation an dieser Stelle nur verwiesen sei. Wichtig ist natürlich, dass die Resource auch läuft.

[[en:Deathmatch Server Manual]]
[[it:Manuale del Server]]
[[nl:Deathmatch Server Manual]]
[[ru:Deathmatch Server Manual]]

Server Manual

2009-08-03T11:56:36Z

1337MaVe:

__TOC__

==Getting started==
It is much easier than it looks to get a server up and running for your internet or LAN buddies: follow this wiki article and you will hopefully be on your way to hosting your own MTA:SA DM Server in no time!

==Installing the server==
The dedicated server application is available in different flavours depending on the platform of the server.

==Linux installation==
===Ubuntu===
I installed the server on Ubuntu 6.05 LTS. I will add installation instructions for other linux distros at a later time.
This install was done on a fresh os install so a few things have to be installed first.
First of all ssh into your server using whatever client you like. I prefer putty.
Start by typing '''sudo apt-get upgrade''' It will prompt you to put your password in again. After the upgrade is done running type
'''sudo apt-get install pico''' this will install the easy to use pico text editor that you will use to edit the config files.
After the install is done running you need to get a copy of libcurl3 for the server to run so type '''sudo apt-get install libcurl3'''
Once again it will ask you for your password. Once this is done now we have to get the server program onto your Linux server. There are a few methods for doing this. you can install a ftp server. you can use putty file transfer. If you know someone with a website you can ask them to put the file on their website then use '''wget http://www.websitename.com/file.tar''' Obviously where website name is change to your friends website. Either way once you have the tar file on your server you need to unpack it you do this by using the command '''tar -zxvf filename.tar'''
===Gentoo===
I assume that if people are using Gentoo, they know enough of an operating system to get files from the web to their server theirselves... (otherwise, look above and read the ubuntu part)

These versions I needed for DP2:

Update your gcc version to 4.2.2:
* unmask gcc in /etc/portage/package.unmask)
* emerge gcc
* switch to gcc 4.2.2: gcc-config i686-pc-linux-gnu-4.2.2
Update your libstdc++ version to 3.3 if you haven't got that version
* emerge libstdc++
Install libcurl:
* emerge libcurl
Unpack mtasa, and run it...

==Windows installation==
Installation of the MTA:SA DM server on Windows is easy as pie.
*Go to the [http://mtasa.com/deathmatch.html download page] and scroll down to the "Dedicated servers" section
*Click the Windows download link.
*Once the installer is downloaded, open it.
*Select a folder where you want to install the server.
*Click Install.
*Done!

''For a full explanation of acl.xml (access control list) read: [[Access_Control_List|Access Control List]]''<br/><br/>

==Configuring your server==
The Multi Theft Auto dedicated server is initially configurable through it's console window, from within the game, and from a webbrowser. In order to make use of the two last options, it is necessary to add at least one administrator user to your configuration file.

===General configuration===
All general configuration options can be found in the 'mods/deathmatch/'''mtaserver.conf'''' file and can be opened by any regular text editor.

This file is fairly straightforward; every variable has a description of what to do with it and how to change it.

===Port forwarding===
If you run your server on your own private computer, and you have an router between the internet and your computer. You need to forward 3 ports.

First of all open the file 'mods/deathmatch/'''mtaserver.conf'''' and search for the next lines:
<syntaxhighlight lang="xml">
<serverport>22004</serverport>
<httpport>22005</httpport>
</syntaxhighlight>

The ports are needed to setup the server right. We explain later how to set them, but first if you want your server to list in the server browser there is an other port we need, and that is the ase port.
(quick example for how to turn ase on or of):
<syntaxhighlight lang="xml">
<ase>1</ase> 
</syntaxhighlight>

Now we going to forward the ports in router, which is not needed if you already have all ports open, or if you don't have a router with a firewall. If so, skip this part.

If you don't know how port forwarding works in your router, go to: http://portforward.com/, find your router there, and follow the instructions there.

In almost every router you can set the port type: UDP or TCP. The following list will explain which port type is needed for what:

Main server port: UDP

HTTP Port: TCP

ASE Port: UDP (this is needed if you want your server to appear in the server list)

The ASE port is also simply to get:

ASE port = Main Server port + 123

So, if you have the main server port set to 22003, then the ASE port will be 22126.

Good luck!

===Adding administrators===
It is strongly recommended to add at least one administrator to your server in order to make use of the built-in webserver to easily maintain and configure your server. This administrator will then also be able to log-in from within the game and control the server.

To add an administrator to your server, follow these steps:<br>
<ol>
<li>Make sure your server is stopped; if your server is still running, all changes you make will be overwritten</li>
<li>Open the file 'mods/deathmatch/'accounts.xml'''' with any text editor</li>
<li>Add a new account into the file by using the XML-syntax below, we use the username "BennyLava" with password "123password" for illustration purposes
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<accounts>
...
<account name="BennyLava" password="123password" />
</accounts>
</syntaxhighlight>
</div>
<li>Save and close the file</li>
<li>Open the file 'mods/deathmatch/'acl.xml'''' with any text editor</li>
<li>Add the account to the ''Admin'' group by using the XML-syntax below
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<ACL>
...
<group name="Admin">
<acl name="Admin"/>
...
<object name="user.BennyLava" />
</group>
...
</ACL>
</syntaxhighlight>
</div>

You can actually add your user to any group you want. Each group is linked to an ACL ([[Access Control List]]). Each ACL contains a series of specific allowed or denied rights. These groups exist so different users can be assigned different rights. The ''Admin'' group points to the ''Admin'' ACL, which is empty (thus allowing all possible commands). The ''Everyone'' group points to the ''Default'' ACL that puts a series of restrictions on the available commands (to disallow regular players from using admin commands).
</li>
<li>
You're done! You can add as many administrators or users as you want this way, take a look at some of the other groups and ACLs for example. The ACL is also accessible through the [[Access_Control_List|Lua scripting engine]].<br>

It is recommended to take a look at the web interface, we will explain how to do this below.
</li>
</ol>
'''Note''': There are also ways to add accounts and edit rights for the server while it's running. "addaccount <user> <password>" is an internal command to add accounts, but you will have to use the web interface to add these accounts to specific groups/ACLs!<br />

===Using the web interface===
The dedicated server comes with a few Lua [[resources]] that provide a nice little web interface to your server. This can be used to easily maintain your server, as it allows you to add users, start/stop resources, and more.

The web interface resources are enabled by default and are served through the built-in HTTP web server. To make sure the built-in HTTP web server runs on a port you like (22005 by default), follow these steps:
<ol>
<li>Make sure your server is stopped
<li>Open the file '''mods/deathmatch/mtaserver.conf''' with any text editor</li>
<li>Verify that the HTTP server is enabled:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpserver>1</httpserver>
</syntaxhighlight>
</div>
</li>
<li>Change the HTTP server port to your liking:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpport>22005</httpport>
</syntaxhighlight>
</div>
</li>
<li>Save and close the configuration file</li>
<li>Start your server</li>
<li>If you happened to have changed the start-up resources in your configuration file, make sure the following resources are started:

# resourcebrowser
# resourcemanager
# webadmin
# webmap

These are automatically started in the default configuration file, in case you just installed your server.
</li>
<li>Open a web browser (Internet Explorer 6 or 7 are NOT supported: use [http://www.mozilla.com/firefox Mozilla Firefox], [http://www.google.com/chrome Google Chrome], [http://www.apple.com/safari/download Apple Safari], [http://www.opera.com Opera] or others) and navigate to the HTTP server URL: '''http://server:port/'''. For example, If you are running a local server on HTTP port 22005, use '''http://127.0.0.1:22005/'''.</li>
<li>Enter the username and password of the administrator you added in the previous section.</li>
</ol>

<br />
You should now be able to maintain your server from the web interface.

=== Configuring an external web server ===
The built-in web server is also used to serve files that are required by resources running on your server to any player that is connected to your server. For example, if you are running a game script with a scripted graphical user interface, or custom models, these need to be transferred to every connected player in order to function properly. This is done by either the built-in web server, or an external web server (that is usually a bit faster) but needs to be set up separately.

For performance or consistency reasons during the game, you could choose to make use of such an external web server if you have one set up. The external web server needs to be accessible for the public, so any client will be able to download the necessary client-side files in order to join and play on your server.

To enable downloading off an external web server, you should configure the ''httpdownload'' and ''httpdownloadurl'' tags in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml"><httpdownload>1</httpdownload>
<httpdownloadurl>http://www.myserver.tld/directory/here</httpdownloadurl>
</syntaxhighlight></div>

Since all the default resources provided with the dedicated server are zipped, and are normally automatically extracted by the built-in web server, you now have to provide a way for the clients to download the unextracted files to their computers. The unextracted files are always available in the '''<SERVER>/mods/deathmatch/resourcecache''' directory.

<ol>
<li>Launch the dedicated server once and exit again. This will extract the zip files into the '''<SERVER>/mods/deathmatch/resourcecache''' directory.</li>
<li>Go into the directory above and copy the resources to your external web server's public directory, this can be done in several ways:
<ul>
<li>If you don't care about your '''server-side files being publically available''': create a symbolic link (Linux), a junction (Windows) or just plain copy the contents of the '''resourcecache''' directory to your public web server directory.</li>
<li>If you don't want your server files to be publically available through your web server: go into the '''resourcecache''' directory and manually copy the folders over to your public web server directory, removing any server-side files (they are '''not''' necessary for the client-side downloading) you do not want to be hosting on your web server.<br />
<br />
A quick way of securing your server-side files is currently not available. We will investigate into developing a tool that automatically copies only the necessary client-side files for all resources on your server.
</ul>
</li>
</ol>

'''Note 1''': Please try to avoid any special characters (e.g. ~, !) in your download URLs.<br />
'''Note 2''': Please do not use a trailing slash in your download URL (e.g. ''hxxp://www.myserver.tld/directory'' rather than ''hxxp://www.myserver.tld/directory/'')

==Starting your server==
Begin by making sure that you have finished all configuration of your server, starting your server is the last stage so everything must be ready!

To start your server double click on MTA Server.exe, make sure you allow it through any firewalls and forward ports where nessessary.

==Installing/Updating resources on your server==
Resources can come in two formats, either a ZIP format or just a normal folder with the script files inside it. The MTA:SA DM server supports both these methods.

# Move or copy the new resource to your <SERVER>\mods\deathmatch\resources folder.
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Uninstalling resources==
Resources can easily be removed from your server if you no longer want them.

# Delete the ZIP file or the folder of the resource you wish to uninstall
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Administrating your server==
You can start resources by typing the command "start resourcename" in the server console, or stop ones with "stop resourcename".

It's also possible to execute these and other admin commands from the ingame console (which you can bring up with the ` key or F8); for this to work, you first need to log in with the command "login username password". Additionally, you can press the p key to bring up the admin panel: this is a graphical interface which allows you to easily kick or ban misbehaving players, among others.

For further commands, type "help" in a console.

==Starting a map/gamemode==
See the commands section of the documentation for [[Resource:Map manager|mapmanager]] for more information.

==Useful Notes==

# You may also update the resources while ingame as long as you have the correct access levels by typing "refresh" in the clients console or "/refresh" in the chat window. This may cause a second of lag if you have many resources.
# In the above instructions, <SERVER> is the path to your server's main directory. In most cases this is C:\Program Files\MTA San Andreas\server
# You can choose a different config file for the server to use by passing it in the command line after a --config argument, e.g. mtaserver.exe --config anotherconfig.cfg.
# Do not be alarmed by the warning regarding the parsing of the settings.xml file. This happens because your server installation is still clean and unused.

====Need further help?====
Why not pop over to our [http://forum.mtasa.com/ Forums] or join us on [irc://irc.multitheftauto.com/mta IRC] (irc.multitheftauto.com #mta - [http://www.mirc.com MIRC])

[[de:MTA DM Server Anleitung]]
[[it:Manuale del Server]]
[[nl:Deathmatch Server Manual]]
[[ru:Deathmatch Server Manual]]

Server Manual

2009-08-03T11:54:23Z

1337MaVe:

__TOC__

==Getting started==
It is much easier than it looks to get a server up and running for your internet or LAN buddies: follow this wiki article and you will hopefully be on your way to hosting your own MTA:SA DM Server in no time!

==Installing the server==
The dedicated server application is available in different flavours depending on the platform of the server.

==Linux installation==
===Ubuntu===
I installed the server on ubuntu 6.05 LTS. I will add installation instructions for other linux distros at a later time.
This install was done on a fresh os install so a few things have to be installed first.
First of all ssh into your server using whatever client you like. I prefer putty.
Start by typing '''sudo apt-get upgrade''' It will prompt you to put your password in again. After the upgrade is done running type
'''sudo apt-get install pico''' this will install the easy to use pico text editor that you will use to edit the config files.
After the install is done running you need to get a copy of libcurl3 for the server to run so type '''sudo apt-get install libcurl3'''
Once again it will ask you for your password. Once this is done now we have to get the server program onto your Linux server. There are a few methods for doing this. you can install a ftp server. you can use putty file transfer. If you know someone with a website you can ask them to put the file on their website then use '''wget http://wwww.websitename.com/file.tar''' Obviously where website name is change to your friends website. Either way once you have the tar file on your server you need to unpack it you do this by using the command '''tar -zxvf filename.tar'''
===Gentoo===
I assume that if people are using Gentoo, they know enough of an operating system to get files from the web to their server theirselves... (otherwise, look above and read the ubuntu part)

These versions I needed for DP2:

Update your gcc version to 4.2.2:
* unmask gcc in /etc/portage/package.unmask)
* emerge gcc
* switch to gcc 4.2.2: gcc-config i686-pc-linux-gnu-4.2.2
Update your libstdc++ version to 3.3 if you haven't got that version
* emerge libstdc++
Install libcurl:
* emerge libcurl
Unpack mtasa, and run it...

==Windows installation==
Installation of the MTA:SA DM server on Windows is easy as pie.
*Go to the [http://mtasa.com/deathmatch.html download page] and scroll down to the "Dedicated servers" section
*Click the Windows download link.
*Once the installer is downloaded, open it.
*Select a folder where you want to install the server.
*Click Install.
*Done!

''For a full explanation of acl.xml (access control list) read: [[Access_Control_List|Access Control List]]''<br/><br/>

==Configuring your server==
The Multi Theft Auto dedicated server is initially configurable through it's console window, from within the game, and from a webbrowser. In order to make use of the two last options, it is necessary to add at least one administrator user to your configuration file.

===General configuration===
All general configuration options can be found in the 'mods/deathmatch/'''mtaserver.conf'''' file and can be opened by any regular text editor.

This file is fairly straightforward; every variable has a description of what to do with it and how to change it.

===Port forwarding===
If you run your server on your own private computer, and you have an router between the internet and your computer. You need to forward 3 ports.

First of all open the file 'mods/deathmatch/'''mtaserver.conf'''' and search for the next lines:
<syntaxhighlight lang="xml">
<serverport>22004</serverport>
<httpport>22005</httpport>
</syntaxhighlight>

The ports are needed to setup the server right. We explain later how to set them, but first if you want your server to list in the server browser there is an other port we need, and that is the ase port.
(quick example for how to turn ase on or of):
<syntaxhighlight lang="xml">
<ase>1</ase> 
</syntaxhighlight>

Now we going to forward the ports in router, which is not needed if you already have all ports open, or if you don't have a router with a firewall. If so, skip this part.

If you don't know how port forwarding works in your router, go to: http://portforward.com/, find your router there, and follow the instructions there.

In almost every router you can set the port type: UDP or TCP. The following list will explain which port type is needed for what:

Main server port: UDP
HTTP Port: TCP
ASE Port: UDP (this is needed if you want your server to appear in the server list)

The ASE port is simply to get:
ASE port = Main Server port + 123
So, if you have the main server port set to 22003, then the ASE port will be 22126.

Good luck!

===Adding administrators===
It is strongly recommended to add at least one administrator to your server in order to make use of the built-in webserver to easily maintain and configure your server. This administrator will then also be able to log-in from within the game and control the server.

To add an administrator to your server, follow these steps:<br>
<ol>
<li>Make sure your server is stopped; if your server is still running, all changes you make will be overwritten</li>
<li>Open the file 'mods/deathmatch/'accounts.xml'''' with any text editor</li>
<li>Add a new account into the file by using the XML-syntax below, we use the username "BennyLava" with password "123password" for illustration purposes
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<accounts>
...
<account name="BennyLava" password="123password" />
</accounts>
</syntaxhighlight>
</div>
<li>Save and close the file</li>
<li>Open the file 'mods/deathmatch/'acl.xml'''' with any text editor</li>
<li>Add the account to the ''Admin'' group by using the XML-syntax below
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<ACL>
...
<group name="Admin">
<acl name="Admin"/>
...
<object name="user.BennyLava" />
</group>
...
</ACL>
</syntaxhighlight>
</div>

You can actually add your user to any group you want. Each group is linked to an ACL ([[Access Control List]]). Each ACL contains a series of specific allowed or denied rights. These groups exist so different users can be assigned different rights. The ''Admin'' group points to the ''Admin'' ACL, which is empty (thus allowing all possible commands). The ''Everyone'' group points to the ''Default'' ACL that puts a series of restrictions on the available commands (to disallow regular players from using admin commands).
</li>
<li>
You're done! You can add as many administrators or users as you want this way, take a look at some of the other groups and ACLs for example. The ACL is also accessible through the [[Access_Control_List|Lua scripting engine]].<br>

It is recommended to take a look at the web interface, we will explain how to do this below.
</li>
</ol>
'''Note''': There are also ways to add accounts and edit rights for the server while it's running. "addaccount <user> <password>" is an internal command to add accounts, but you will have to use the web interface to add these accounts to specific groups/ACLs!<br />

===Using the web interface===
The dedicated server comes with a few Lua [[resources]] that provide a nice little web interface to your server. This can be used to easily maintain your server, as it allows you to add users, start/stop resources, and more.

The web interface resources are enabled by default and are served through the built-in HTTP web server. To make sure the built-in HTTP web server runs on a port you like (22005 by default), follow these steps:
<ol>
<li>Make sure your server is stopped
<li>Open the file '''mods/deathmatch/mtaserver.conf''' with any text editor</li>
<li>Verify that the HTTP server is enabled:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpserver>1</httpserver>
</syntaxhighlight>
</div>
</li>
<li>Change the HTTP server port to your liking:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpport>22005</httpport>
</syntaxhighlight>
</div>
</li>
<li>Save and close the configuration file</li>
<li>Start your server</li>
<li>If you happened to have changed the start-up resources in your configuration file, make sure the following resources are started:

# resourcebrowser
# resourcemanager
# webadmin
# webmap

These are automatically started in the default configuration file, in case you just installed your server.
</li>
<li>Open a web browser (Internet Explorer 6 or 7 are NOT supported: use [http://www.mozilla.com/firefox Mozilla Firefox], [http://www.google.com/chrome Google Chrome], [http://www.apple.com/safari/download Apple Safari], [http://www.opera.com Opera] or others) and navigate to the HTTP server URL: '''http://server:port/'''. For example, If you are running a local server on HTTP port 22005, use '''http://127.0.0.1:22005/'''.</li>
<li>Enter the username and password of the administrator you added in the previous section.</li>
</ol>

<br />
You should now be able to maintain your server from the web interface.

=== Configuring an external web server ===
The built-in web server is also used to serve files that are required by resources running on your server to any player that is connected to your server. For example, if you are running a game script with a scripted graphical user interface, or custom models, these need to be transferred to every connected player in order to function properly. This is done by either the built-in web server, or an external web server (that is usually a bit faster) but needs to be set up separately.

For performance or consistency reasons during the game, you could choose to make use of such an external web server if you have one set up. The external web server needs to be accessible for the public, so any client will be able to download the necessary client-side files in order to join and play on your server.

To enable downloading off an external web server, you should configure the ''httpdownload'' and ''httpdownloadurl'' tags in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml"><httpdownload>1</httpdownload>
<httpdownloadurl>http://www.myserver.tld/directory/here</httpdownloadurl>
</syntaxhighlight></div>

Since all the default resources provided with the dedicated server are zipped, and are normally automatically extracted by the built-in web server, you now have to provide a way for the clients to download the unextracted files to their computers. The unextracted files are always available in the '''<SERVER>/mods/deathmatch/resourcecache''' directory.

<ol>
<li>Launch the dedicated server once and exit again. This will extract the zip files into the '''<SERVER>/mods/deathmatch/resourcecache''' directory.</li>
<li>Go into the directory above and copy the resources to your external web server's public directory, this can be done in several ways:
<ul>
<li>If you don't care about your '''server-side files being publically available''': create a symbolic link (Linux), a junction (Windows) or just plain copy the contents of the '''resourcecache''' directory to your public web server directory.</li>
<li>If you don't want your server files to be publically available through your web server: go into the '''resourcecache''' directory and manually copy the folders over to your public web server directory, removing any server-side files (they are '''not''' necessary for the client-side downloading) you do not want to be hosting on your web server.<br />
<br />
A quick way of securing your server-side files is currently not available. We will investigate into developing a tool that automatically copies only the necessary client-side files for all resources on your server.
</ul>
</li>
</ol>

'''Note 1''': Please try to avoid any special characters (e.g. ~, !) in your download URLs.<br />
'''Note 2''': Please do not use a trailing slash in your download URL (e.g. ''hxxp://www.myserver.tld/directory'' rather than ''hxxp://www.myserver.tld/directory/'')

==Starting your server==
Begin by making sure that you have finished all configuration of your server, starting your server is the last stage so everything must be ready!

To start your server double click on MTA Server.exe, make sure you allow it through any firewalls and forward ports where nessessary.

==Installing/Updating resources on your server==
Resources can come in two formats, either a ZIP format or just a normal folder with the script files inside it. The MTA:SA DM server supports both these methods.

# Move or copy the new resource to your <SERVER>\mods\deathmatch\resources folder.
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Uninstalling resources==
Resources can easily be removed from your server if you no longer want them.

# Delete the ZIP file or the folder of the resource you wish to uninstall
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Administrating your server==
You can start resources by typing the command "start resourcename" in the server console, or stop ones with "stop resourcename".

It's also possible to execute these and other admin commands from the ingame console (which you can bring up with the ` key or F8); for this to work, you first need to log in with the command "login username password". Additionally, you can press the p key to bring up the admin panel: this is a graphical interface which allows you to easily kick or ban misbehaving players, among others.

For further commands, type "help" in a console.

==Starting a map/gamemode==
See the commands section of the documentation for [[Resource:Map manager|mapmanager]] for more information.

==Useful Notes==

# You may also update the resources while ingame as long as you have the correct access levels by typing "refresh" in the clients console or "/refresh" in the chat window. This may cause a second of lag if you have many resources.
# In the above instructions, <SERVER> is the path to your server's main directory. In most cases this is C:\Program Files\MTA San Andreas\server
# You can choose a different config file for the server to use by passing it in the command line after a --config argument, e.g. mtaserver.exe --config anotherconfig.cfg.
# Do not be alarmed by the warning regarding the parsing of the settings.xml file. This happens because your server installation is still clean and unused.

====Need further help?====
Why not pop over to our [http://forum.mtasa.com/ Forums] or join us on [irc://irc.multitheftauto.com/mta IRC] (irc.multitheftauto.com #mta - [http://www.mirc.com MIRC])

[[de:MTA DM Server Anleitung]]
[[it:Manuale del Server]]
[[nl:Deathmatch Server Manual]]
[[ru:Deathmatch Server Manual]]

Template:DxFonts

2009-08-03T11:45:45Z

1337MaVe:

** '''"default":''' Tahoma
** '''"default-bold":''' Tahoma Bold
** '''"clear":''' Verdana
** '''"arial":''' Arial
** '''"pricedown":''' Pricedown (GTA's theme text)

{{New feature|3|1.0|
** '''"bankgothic":''' Bank Gothic Medium
** '''"diploma":''' Diploma Regular
** '''"beckett":''' Beckett Regular
}}

Standard GUI Font Names

2009-08-03T11:43:32Z

1337MaVe:

These are the available CEGUI fonts that are used in Multi Theft Auto and can be accessed with the GUI scripting functions [[guiGetFont]] and [[guiSetFont]].

<gallery heights="48" widths="236" perrow="3" caption="Available font properties and previews">
Image:mta-font_default-normal.gif|<div style="font-weight: bold">default-normal</div>Tahoma regular, 9px
Image:mta-font_default-small.gif|<div style="font-weight: bold">default-small</div>Tahoma regular, 7px
Image:mta-font_default-bold-small.gif|<div style="font-weight: bold">default-bold-small</div>Tahoma bold, 8px
Image:mta-font_clear-normal.gif|<div style="font-weight: bold">clear-normal</div>Verdana regular, 9px
Image:mta-font_sa-header.gif|<div style="font-weight: bold">sa-header</div>Diploma regular, 26px auto-scaled
Image:mta-font_sa-gothic.gif|<div style="font-weight: bold">sa-gothic</div>Beckett regular, 47px auto-scaled
</gallery>
[[Category:Scripting Concepts]]

[[ru:GUI Fonts]]

GetElementHealth

2009-08-02T19:16:38Z

1337MaVe:

{{Server client function}}
__NOTOC__
This function returns the current health for the specified [[element]]. This can be a [[player]], a [[ped]], or a [[vehicle]].

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">
float getElementHealth ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[player]] or [[vehicle]] whose health you want to check.

===Returns===
Returns a float indicating the element's health, or ''false'' if invalid arguments were passed.
</section>

==Example==
<section name="Clientside example" class="client" show="true">
This example outputs the health of the player who enters the command 'showhealth', and their vehicle's health.
<syntaxhighlight lang="lua">
function showLocalHealth()
-- get the player's health and output it
local playerHealth = getElementHealth ( getLocalPlayer() )
outputChatBox ( "Your health: " .. playerHealth )

-- get the player's vehicle: if he is in one, output its health as well
local playerVehicle = getPlayerOccupiedVehicle ( getLocalPlayer() )
if playerVehicle then
local vehicleHealth = getElementHealth ( playerVehicle )
outputChatBox ( "Your vehicle's health: " .. vehicleHealth )
end
end
addCommandHandler ( "showhealth", showLocalHealth )
</syntaxhighlight>
</section>
==See Also==
{{Element functions}}

SetElementVisibleTo

2009-07-24T00:47:08Z

1337MaVe:

__NOTOC__
{{Server function}}
{{Needs_Checking|Can an element only be visible to one element (and its children) at a time? If so, do we need clearElementVisibleTo? If not, surely we need to remove the root element before using this function?|[[User:EAi|EAi]]
}}
{{Needs_Checking| I tried to make a blip visible to 1 player but it doesn't work unless I use getRootElement() [[User:Norby89|Norby89]] 10:20, 3 August 2007 (CDT)

I tried to hide a marker from 1 player but I have to make the marker especially visible to this player before (tested on DP2)
[[User:mvol|mvol]] 21:51, 20 January 2008 (CDT)

This issue is reported as issue #3158. [[User:EAi|eAi]] 21:25, 20 January 2008 (CST)
}}

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

==Syntax==
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>

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

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

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

The following example shows how to hide the marker on 'someguy' from 'anotherguy'
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromNick ( "someguy" )
local anotherguy = getPlayerFromNick ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
-- First off make the marker visible especially to 'anotherguy'
setElementVisibleTo ( myMarker, anotherguy, true )
-- Then hide it
setElementVisibleTo ( myMarker, anotherguy, false )
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

SetElementData

2009-07-24T00:40:35Z

1337MaVe:

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

==Syntax==

<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, [bool synchronize], var value )
</syntaxhighlight>
</section>

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

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server and remote clients.

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

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

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

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

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

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

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

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

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

==See Also==
{{Element_functions}}

EngineReplaceCOL

2009-03-28T09:28:14Z

1337MaVe:

__NOTOC__
{{Client function}}

This function replaces the collision file of the given model id to the collision file passed. Use [[engineLoadCOL]] to load the collision file first.

==Syntax==

<syntaxhighlight lang="lua">
bool engineReplaceCOL ( col theCol, int modelID )
</syntaxhighlight>

===Required Arguments===

*'''theCol:''' The collision file to replace with
*'''modelID:''' The model ID whose collision file you want to replace

===Returns===

Returns ''true'' if the collision was successfully replaced, ''false'' or ''nil'' if the collision could not be replaced for a reason.

==Example==
<section name="Client" class="client" show="true">
Client-Side example for replacing object collision with custom one.
<syntaxhighlight lang="lua">
function ReplaceCollision ( )
outputChatBox ( "> Replacing Collision Data." )
col = engineLoadCOL( "myColFile.col" )
engineReplaceCOL( col, 3356 )
end

addEvent ( "collisionReplace", true )
addEventHandler ( "collisionReplace", getRootElement(), ReplaceCollision )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCols ( )
triggerClientEvent ( "collisionReplace", getRootElement(), collisionReplace )
end
addCommandHandler("replacecol", ReplaceCols)
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}

RespawnVehicle

2009-03-28T09:26:53Z

1337MaVe:

{{Server function}}
__NOTOC__
This function respawns a vehicle according to its set respawn position, set by [[setVehicleRespawnPosition]]. To spawn to a specific location, [[spawnVehicle]] can be used..

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

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

===Returns===
Returns ''true'' if the vehicle respawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==

This example makes an exploded vehicle re-spawn after 5 seconds!

<syntaxhighlight lang="lua">
function respawnExplodedVehicle()
setTimer(respawnVehicle, 5000, 1, source)
end
addEventHandler("onVehicleExplode", getRootElement(), respawnExplodedVehicle)
</syntaxhighlight>

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

IsConsoleActive

2009-03-28T09:25:09Z

1337MaVe:

__NOTOC__
{{Client function}}
This function returns whether the ingame console window is visible or not.

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

===Returns===
Returns ''true'' if the console is visible, ''false'' if not.

==Example==
This example does...
<syntaxhighlight lang="lua">
function consoleactiveCommand(arg)
local active = "not active."
if (isConsoleActive()) then active = "active." end
outputChatBox("Your console is " .. active)
end
addCommandHandler("consoleactive", consoleactiveCommand)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

IsConsoleActive

2009-03-28T09:24:26Z

1337MaVe:

IsConsoleActive

2009-03-28T09:24:14Z

1337MaVe:

__NOTOC__
{{Client function}}
This function returns whether the ingame console window is visible or not.

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

===Returns===
Returns ''true'' if the console is visible, ''false'' if not.

==Example==
This example does...
<syntaxhighlight lang="lua">
function consoleactiveCommand(arg)
local active = "not active."
if (isConsoleActive()) then active = "active.")
outputChatBox("Your console is " .. active)
end
addCommandHandler("consoleactive", consoleactiveCommand)
</syntaxhighlight>

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

Template:Radio Station IDs

2009-03-25T18:31:02Z

1337MaVe:

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* 0: Radio off
* 1: Playback FM
* 2: K-Rose
* 3: K-DST
* 4: Bounce FM
* 5: SF-UR
* 6: Radio Los Santos
* 7: Radio X
* 8: CSR 103.9
* 9: K-Jah West
* 10: Master Sounds 98.3
* 11: WCTR
* 12: User Track Player
</div>

OnClientPlayerRadioSwitch

2009-03-25T18:30:28Z

1337MaVe:

__NOTOC__
{{Client event}}
This event is triggered whenever a players radio station is changed

==Parameters==
<syntaxhighlight lang="lua">
int stationID
</syntaxhighlight>

*'''stationID''': An [[int]]eger representing the station the player switched to.
Station ID's:
{{SoundID}}
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the Radio station will not change.
==Example==
<syntaxhighlight lang="lua">
--Todo
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client Audio functions===
{{Client_audio_functions}}

XmlNodeGetAttribute

2009-03-24T20:59:52Z

1337MaVe:

__NOTOC__
{{Server client function}}
This function is used to return an attribute of a node in a configuration file.

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetAttribute ( xmlnode node, string name )
</syntaxhighlight>

===Required Arguments===
*'''node:''' The node from which you wish to return the attribute
*'''name:''' The name of the attribute.

===Returns===
Returns the attribute in string form.

==Example==
Suppose we have a gametype where only one type of car is used, and this type should not depend on the map but rather be set in an external configuration file and be used in all maps. Here's an example where the configuration file is an XML document:

settings.xml
<syntaxhighlight lang="xml">
<car model="528" posX="123.4" posY="456.7" posZ="12.3" rot="90.0" />
</syntaxhighlight>

Lua code
<syntaxhighlight lang="lua">
local xml = getResourceConfig("myVehicles.xml") -- load XML file and get its root element
local carmodel = xmlNodeGetAttribute(xml, "model") -- get attribute of root element
local carX = xmlNodeGetAttribute(xml, "posX")
local carY = xmlNodeGetAttribute(xml, "posY")
local carZ = xmlNodeGetAttribute(xml, "posZ")
local carA = xmlNodeGetAttribute(xml, "rot")
createVehicle(carmodel, carX, carY, carZ, 0.0, 0.0, carA)
</syntaxhighlight>

==See Also==
{{XML_functions}}

ShowPlayerHudComponent

2009-03-07T16:16:02Z

1337MaVe: /* Syntax */

__NOTOC__
{{Server client function}}
This function will show or hide a part of the player's HUD.

{{Needs Checking|component 'clock' does not hide the clock}}

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( player thePlayer, string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' description
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>

===Returns===
Returns ''true'' if the component was shown or hidden succesfully, ''false'' if an invalid argument was specified.

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
function hudChanger ()
showPlayerHudComponent ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
showPlayerHudComponent ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}