Meta.xml: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Reverted edits by Diki (talk) to last revision by Backsage)
No edit summary
Line 1: Line 1:
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.
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
 
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
=Tags=
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
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:
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
 
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''author:''' The author of this resource
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''version:''' The version of this resource
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''name:''' The name of this resource
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''description:''' A brief description of this resource
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''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").
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<script />''' Source code for this resource, possible parameters are:
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''src:''' The file name of the source code
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
** '''type:''' The type of source code: "client", "server" or "shared".
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''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)''
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''validate:''' If set to "false", compatibility checks are skipped.
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<map />''' The map for a gamemode, possible parameters are:
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''dimension:''' Dimension in which the map will be loaded (optional)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<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)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''src:''' client-side file name (can be path too eg. "images/image.png")
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
<!--
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
-->
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<include />''' Include resources that this resource will use
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''resource:''' Resource name that you want to start with this resource
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''src:''' The file name of the config file
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''type:''' The type of the config file: "client" or "server"
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''function:''' The function name
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''type''' Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''http:''' Can the function be called via HTTP (true/false)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
*'''<html />'''
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''src:''' The filename for the HTTP file (can be a path)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''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)
Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
**'''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="gamemode" name="Stealth" />
    <config src="help.xml" type="client"/>
 
    <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]" /> <!-- round length in minutes -->
<setting name="teamdamage" value="[1]" /> <!-- 0 for team protection off, 1 for team protection on -->
<setting name="teambalance" value="[1]" /> <!--  difference limit of amount of players between teams -->
<setting name="spazammo" value="[25]" /> <!-- ammo amounts -->
<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]]

Revision as of 18:11, 1 January 2017

Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi