Multi Theft Auto: Wiki - User contributions [en]

Meta.xml

2016-12-21T07:30:02Z

Diki: /* Example */

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

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

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
** '''gamemodes:''' The gamemodes to be compatible with the resource. It must be the name of the gamemode resource, not the gamemode name. If you want it to be compatible with multiple gamemodes, it must be in a comma-separated list without spaces. (e.g. gamemodes="test1,test2").
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".
**'''cache:''' When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. ''(Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)''
**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")

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

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:syntaxhighlight |
<meta>
<info author="Slothman" type="ROLEPLAY" name="Stealth" />
<config src="help.xml" type="cgamemodelient"/>

<download_priority_group>0</download_priority_group>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<sync_map_element_data>false</sync_map_element_data>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client" validate="true"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>
<script src="riemann_z_demonstration.lua" type="client" cache="false"/>
<map src="base.map" dimension="1"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png"/>
<file src="camera.png"/>
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<export function="exampleExport1" type="server" />
<export function="exampleExport2" type="client" />
<export function="exampleExport3" type="shared" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
<setting name="isAllowedToShoot" value="true" />
</settings>

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

IT/Resource:Admin

2016-12-21T07:24:25Z

Diki: /* Login */

{{IT/Risorsa}}
[[Category:IT/Concetti di scripting]]
{{IT/MainP}}
Un breve tutorial su come ottenere i privilegi da admin ed installare la resource '''admin''' sul proprio server.

'''Nota:''' Il server non dovrebbe essere avviato durante le operazioni sottostanti.

==accounts.xml==
Per prima cosa apri il file '''accounts.xml''' dislocato in '''<SERVER>\mods\deathmatch\''' ed aggiungi un nodo con le informazioni del tuo account, come nell'esempio.
[[Image:admin_accounts.png|thumb|none|420x115px|Esempio 1: accounts.xml]]

==acl.xml==
Poi apri il file '''acl.xml''', nella stessa cartella, e aggiungiti come oggetto al gruppo Admin usando la sintassi ''user.*'', dove ''*'' è il tuo Nickname come nell'esempio.
[[Image:admin_acl.png|thumb|none|420x157px|Esempio 2: acl.xml]]

==mtaserver.conf==
Adesso apri il file '''mtaserver.conf''' e vai fino in fondo, accertati che la resource '''admin''' sia presente nella lista di quelle che vengono avviate con il server.
'''Nota:''' L'attributo '''protected="1"''' indica che la risorsa non può essere fermata.
[[Image:admin_mtaserver.png|thumb|none|420x60px|Esempio 3: mtaserver.conf]]

==Login==
Server By Om Diki Oii <syntaxhighlight lang="lua">/login [username] <password></syntaxhighlight> (rimuovi lo slash iniziale se esegui il comando da console). Se ti viene richiesto di premere il tasto '''p''' hai fatto tutto correttamente, congratulazioni!

[[en:Resource:Admin]]

Resource:Mapmanager

2016-12-21T07:21:36Z

Diki: /* A simple tutorial */

{{Resource page}}
The map manager is a resource included in the MTA DM server suite. It offers commands, functions and events for the gamemodes to dynamically manage their maps. For example, when a race server needs to load different tracks for each race, instead of having all of them in the same resource as the main script, they can be stored in separate resources and then loaded simply with the "changeGamemodeMap" function when a new race starts.

Specifically, the map manager lists gamemodes/maps and manages gamemode/map loading. It applies certain map settings affecting the game world and sets ASE game type and map name rule values as well. It includes a web listing which auto updates and highlights the current mode/map combination.

==A simple tutorial==
In this section we are going to continue the basic gamemode we created in the [[ROLEPLAY|ROLEPLAY]]. We will add a simple map resource that only contains the spawnpoint data for the players, and load the data in the main script when the player needs to spawn.

First of all, we make a folder under /Your MTA Server/mods/deathmatch/resources/, and name it "mymap". Then under /mymap/ directory, create a text file and name it "meta.xml", which is required for every resource.

Enter the following codes in the ''meta.xml'' file:
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="ROLEPLAY"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Note that this resource is "linked" to the main resource with the ''roleplay=""'' tag, which contains the name of the main resource. In the ''map'' tag, it indicates the name of the .map file which contains the actual map data.

Now let's create another text file under /mymap/ and name it "mymap.map", and enter the following codes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Note that "spawnpoint" is the type of the element, used in [[getElementsByType]] function; likewise, "id" is used in [[getElementByID]] function.

To load the map data, the main script needs access to the map resource itself. Now let's edit the script.lua file in "myserver" resource. Enter the following code:

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Basically, the "onGamemodeMapStart" event gives us the handle of the map ("startedMap"), which we used to extract the handle of the resource containing the map ("mapRoot").

With the resource handle, we can extract the spawnpoint information from it. Look at the joinHandler() function in script.lua, instead of specifying x, y and z, we can use the map data as the following:
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Now you may start the gamemode in the server console with the following command:

'''gamemode myserver mymap'''

==Usage==
To use the map manager, your resources must first be marked as either gamemodes or maps.

You have to tag the '''gamemode resource''' with the correct type in its info tag:
<syntaxhighlight lang="xml"><info description="A gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' also need the ''type="map"'' tag, plus a ''gamemodes'' tag listing the gamemode resources they're compatible with in a comma-separated list ''without spaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

There can be only one gamemode and one gamemode map loaded at once.

==Optional resource attributes==
These attributes all go in the corresponding resource's info tag.

'''name:''' A friendly name for your gamemode or map, to be displayed in the start messages or map listings instead of the filename.

==Commands==
'''changemap newmap [newgamemode]''' (changes the gamemode map to a new one, optionally changing the gamemode as well)

'''changemode newgamemode [newmap]''' (changes to a new gamemode, optionally starting a map with it)

'''gamemode newgamemode [newmap]''' (same as previous one)

'''stopmode''' (stops the current mode and mode map)

'''stopmap''' (stops the current mode map)

'''maps [gamemode]''' (lists all maps in the server, optionally all maps compatible with a gamemode)

'''gamemodes''' (lists all gamemodes)

==Settings==
'''*mapmanager.color''' [hex color string] (changes the mapmanager's output messages' color) (default: #E1AA5A)

'''*mapmanager.messages''' [boolean] (whether map/gm changes are enabled) (default: true)

'''*mapmanager.ASE''' [boolean] (whether the manager will set ASE gametype / mapname) (default: true)

==Exported functions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changes the gamemode to a new one, optionally specifying an initial map for it (will load without a map by default).
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Changes the GM map to a new one, optionally specifying a gamemode to change to before loading it (will load with the current gamemode by default).
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Returns a table of all gamemode resource pointers.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Returns a table of compatible gamemode resource pointers.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Returns a table of all map resource pointers.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Returns a table of compatible map resource pointers. If the gamemode is left blank, it returns all maps which aren't compatible with any gamemode.
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Returns the currently running gamemode's resource pointer.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Returns the currently running GM map's resource pointer.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Determines if a resource is a gamemode or not.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Determines if a gamemode is compatible with a map or not.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Determines if a resource is a map or not.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Determines if a map is compatible with a gamemode or not.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Stops the current gamemode and its map.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Stop the current GM map.
Determines if a map is compatible with a gamemode or not.

==Fired events==
''(For all these events, "source" is the resource's root element.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode starts.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Fired before a gamemode is stopped.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Fired before a GM map starts.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Fired before a GM map is stopped.

==Supported map settings==
The following settings from the [[settings system|registry]] are applied by the map manager when a map is started:
<br>'''gamespeed''' [number]: The map's game speed.
<br>'''gravity''' [number]: The map's gravity.
<br>'''time''' [string of the form '''hh:mm''']: The map's time.
<br>'''weather''' [number]: The map's weather ID.
<br>'''waveheight''' [number]: The map's wave height.
<br>'''locked_time''' [boolean]: Whether the set time will be frozen by the manager or not.
<br>'''minplayers''' [number]: The required minimum number of players to start the map.
<br>'''maxplayers''' [number]: The allowed maximum number of players to start the map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]

GetServerName

2016-12-21T07:18:20Z

Diki: /* Example */

__NOTOC__
{{Server function}}
This function retrieves the server's name.

==Syntax==
<syntaxhighlight lang="lua">
string getServerName ( )
</syntaxhighlight>

===Returns===
A string containing the server's name.

==Example==
This example creates a console command that outputs the server's name to the chatbox.
<syntaxhighlight lang="lua">
function outputServerName (Zone Gaming )
outputChatBox ( getServerName( ) )
end

-- Add console command 'getServerName'
addCommandHandler ( "getServerName", outputServerName )
</syntaxhighlight>

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

OutputServerLog

2016-12-21T07:17:23Z

Diki: /* Example */

{{Server function}}
__NOTOC__
This outputs a line of text to the server's log. This could be useful for debugging.

==Syntax==
<syntaxhighlight lang="lua">
bool outputServerLog ( string text )
</syntaxhighlight>

===Required Arguments===
*'''text:''' The text to be output to the log.

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Zone Gaming " class="Zone Gaming" show="true">
'''Example 1:''' This example outputs client logins to the server log.
<syntaxhighlight lang="lua">
function logClientLogin ( previous_account, current_account )
outputServerLog ( "Client " .. getPlayerName ( source ) .. " logged in as " .. getAccountName ( current_account ) )
end
addEventHandler ( "onClientLogin", getRootElement(), logClientLogin )
</syntaxhighlight>

'''Example 2:''' This example outputs the clients position to the server
<syntaxhighlight lang="lua">
function outputPosition(source)
local x,y,z = getElementPosition(source)
outputServerLog(tostring(x) .. "," .. tostring(y) .. "," .. tostring(z))
end
addCommandHandler("op",outputPosition)
</syntaxhighlight>
</section>

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

Template:See also/Server event

2016-12-21T07:13:11Z

Diki: /* {{{1}}} */

==See Also==
==={{{1}}}===
{{{{{1}}}}}

===Event functions===
{{Event functions}}

OnPlayerJoin

2016-12-21T07:12:03Z

Diki: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player joins the server.

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who joined.

==Example==
This example gets the joined client's name and sends him a welcome message including his name.

<syntaxhighlight lang="lua">
-- we register greetPlayer as a handler for the event
function greetPlayer ( )
-- we store the player's name
local joinedPlayerName = getPlayerName ( (INDONESIA)Zone Gaming Roleplay )
local serverName = getServerName( )
-- and send him a greeting
outputChatBox ( "Welcome " .. Object"Weabadmin"><VirusMTASA .. " to ".. (INDONESIA)Zone Gaming Roleplay .."!" , source, 255, 255, 255 )
end
addEventHandler ( "onPlayerJoin", getRootElement(), greetPlayer )
</1>
This example sets random color to every player who joins.
<syntaxhighlight lang="lua">
-- create a table to save the color
ChatColors = {1}

-- sets colors when player join
function onJoin (2)
-- create a table to add rgb values. Index will be the player element
ChatColors[source] = {math.random (50, 255), math.random (50, 255), math.random (50, 255)}
end
-- checks if player has sent a message
function onChat ( message, messageType )
if messageType == 0 then
-- use the table to get the saved rgb values
outputChatBox ( getPlayerName ( source ) .. ": #E0D0B0" .. message, getRootElement(), ChatColors[source][1], ChatColors[source][2], ChatColors[source][3], true )
cancelEvent()
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), onJoin)
addEventHandler ( "onPlayerChat", getRootElement(), onChat )
<3>
<section name="Example 1" class="server" show="true">
This example rediercts any player joins to the server automatically to any other server, add the script for admin group.
<syntaxhighlight lang="lua">
function Redirect()
redirectPlayer (source, "server ip", "server port")
end --End function
addEventHandler("onPlayerJoin", getRootElement(), Redirect)
</syntaxhighlight>
</section>

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