RU/Resource:Editor/EDF: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(попробовал перевести)
Line 1: Line 1:
{{RU/Resource page}}
{{RU/Resource page}}
{{translate|ru}}
{{Resource page}}
EDF stands for ''Editor Definition File''. EDF's are XML files with an .edf extension that describe the custom elements used by a resource: new element types that have no meaning to MTA itself. Examples are <spawnpoint>, <flag>, <checkpoint> etc. They also are used to define settings that are used by gamemodes, which are placed under the <settings> tag within a resource's ''meta.xml''.
__NOTOC__
EDF означает ''Editor Definition File'' (файл-описание редактора). EDF'ы являются XML-файлами с расширением .edf, которые описывают специфические элементы, используемые ресурсом: новые типы элементов, которых самих по себе в MTA нет. Образцами служат <spawnpoint> (спавн), <flag> (флаг), <checkpoint>(чекпоинт) и т.д. Они также используются для того, чтобы устанавливать настройки, используемые модами (gamemode), эти настройки находятся под тегом <settings> внутри ''meta.xml'' ресурса.


==Введение==
==Вступление==
Some resources use custom map elements. A capture the flag gamemode, for example, will likely use <flag> elements that contain flag positions and teams. When a map is loaded, the gamemode looks for any <flag> elements and installs flags accordingly - for example by creating a flag object and a collision shape.
Некоторые ресурсы используют специфические элементы карты. Например, мод захвата флага (CTF) скорее всего будет использовать элементы <flag> (флага), которые будут содержать позиции флагов и их принадлежность командам. Когда загружается карта, мод ищет любые элементы <flag> (флага) и соответствующе расставляет флаги - например, через создания объекта флага и его коллизии.


The problem with these custom elements is that, unlike built-in MTA elements, the map editor has no idea of their meaning. How should a <flag> element be visually represented? What properties does it have? Without telling the editor this information, you could not use it to create these custom elements and would instead have to resort to manually editing the .map file with a text editor. Fortunately this isn't necessary: any resource can contain an editor definition file that describes the custom map elements used by that resource.
Проблема с этими специфическими элементами в том, что в отличие от встроенных в MTA элементов, редактор карт не понимает, что они из себя представляют. Как должен быть визуально представлен собой элемент <flag> (флага)? Какие у него есть характеристики? Без передачи редактору этой информации, вы не сможете его использовать для создания таких специфических элементов, и вам придется прибегнуть к ручному редактированию .map-файла через текстовый редактор. К счастью, это необязательно: любой ресурс может содержать editor definition file, который опишет специфические элементы карты, используемые ресурсом.


==Использование определенных файлов в редакторе==
==Использование definition files в редакторе==
As described in the [[Resource:Editor|main editor manual]], to be able to create the custom elements of a resource in your map you need to add it in the ''Definitions'' window. Click the ''Definitions'' button in the main menu and double click the resource in the left list. Then close the window and roll the mousewheel in the element panel until the resource comes up. At that point you can create and manipulate custom elements of that resource like any other element.
Как и описано в [[RU/Resource:Editor|главной инструкции по редактору]], чтобы иметь возможно создавать специфические элементы ресурса на вашей карте, вам придется его добавить в окне ''Definitions''. Нажмите кнопку ''Definitions'' в главном меню и дважды щелкните по ресурсу из левого списка. Затем закройте окно и крутаните колесиком мыши в панели элементов, пока не появится желаемый ресурс. С этого момента вы можете создавать и управлять специфическими элементами этого ресурса, как любым другим элементом.


==EDF файлы==
==Построение EDF-файлов==
EDF files are simply XML files with an .edf extension. We'll start with an example: the EDF of the Capture the Orb gamemode.
EDF-файлы - просто XML-файлы с расширением .edf. Начнем с образца: EDF'а мода Capture the Orb.


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Line 33: Line 34:
</syntaxhighlight>
</syntaxhighlight>


As you can see, the syntax is fairly straightforward. The root element, &lt;def&gt;, contains a number of &lt;element&gt;s. Each of these &lt;element&gt;s describes a custom element and specifies its name, visual representation and available properties.
Как вы уже убедились, синтаксис очень легок для понимания. Root element (корневой элемент), &lt;def&gt;, содержит несколько &lt;элементов&gt;. Каждый из этих &lt;элементов&gt; описывает специфический элемент и задает его имя, визуальное представление и доступные ему настройки.


===Визуальное представление===
===Визуальное представление===


Any child node of an &lt;element&gt; that is not a &lt;data&gt; node is part of the visual representation. There can be one or more objects, markers, pickups etc. For each representation element you can optionally specify a position (posX, posY, posZ) and rotation (rotX, rotY, rotZ): these are ''relative'' to the position and rotation of the represented custom element. Using the above Capture the Orb example, if you were to create a spawnpoint at (30, 14, 3), the editor would display an object of model 3092 at (30, 14, 4) to represent it, because the object's posZ of 1 is added to the spawnpoint's z position of 3.
Каждый child node (дочерний узел) &lt;элемента&gt;, не являющийся &lt;data&gt;, отвечает за визуальное представление. Объектов, маркеров, пикапов и т.д. могут быть один или несколько. Для каждого элемента вы можете опционально задать позицию (posX, posY, posZ) и угол вращения (rotX, rotY, rotZ): они ''родственны'' с позицией и вращенем каждого отдельно взятого элемента. На примере Capture the Orb выше, если бы вы захотели создать spawnpoint на (30, 14, 3), редактор бы отобразил объект модели 3092 на координатах (30, 14, 4), потому что posZ объекта, равная 1, была бы сложена с координатой spawnpoint по оси z, равной 3.


===Настройки===
===Настройки===


Properties of a custom element are described by &lt;data&gt; nodes. Some property names have a special meaning, like ''position'' and ''rotation'': these can be changed by moving and rotating the element in the editor. The other properties can be changed in the Properties window.
Настройки специфического элемента описаны в &lt;data&gt;. Имена некоторых настроек, такие как ''position'' и ''rotation'', особенные: они могут быть изменены при перемещении и вращении элемента прямо в редакторе. Другие настройки могут быть изменены в окне Properties.


===Настройки визуального редактора===
===Визуально представление, зависимое от настроек===


It is possible to make the representation of a custom element depend on one or more of the element's properties. Take as example a &lt;checkpoint&gt; element of a race gamemode that contains a &lt;marker&gt; for representation: the checkpoint has several attributes like color and size that should be reflected in the marker. To accomplish this, specify something of the form ''!propertyname!'' in one or more of the representing element's attributes. For example:
Специфический элемент можно сделать зависимым от одной или более настроек элемента. Например, элемент &lt;checkpoint&gt; race мода, содержащий &lt;marker&gt;: checkpoint, имеет несколько атрибутов, таких как color и size, которые должны быть отражены в маркере. Чтобы это сделать, укажите что-нибудь из формы ''!propertyname!'' в качестве одного или более атрибутов, ответственных за элемент. Например:


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Line 62: Line 63:
</syntaxhighlight>
</syntaxhighlight>


Now whenever the "type", "size" or "color" property of a checkpoint is changed, the new value will be copied to its marker, and the marker's visual appearance changes accordingly.
Теперь, когда бы настройки чекпоинта "type", "size" или "color" не менялись, новое значение будет также скопировано в его маркер, в связи с чем изменится внешний вид маркера.


===Интеграция в ресурсах===
===Интеграция в ресурсы===


Once you've written your EDF, save it as an .edf file in your resource's folder and add an "edf:definition" attribute to your meta.xml's &lt;info&gt; tag, like so:
Когда вы написали свой EDF, сохраните его как .edf-файл в папке своего ресурса и добавьте атрибут "edf:definition" в тег &lt;info&gt; meta.xml, как здесь:


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Line 75: Line 76:
</syntaxhighlight>
</syntaxhighlight>


==EDF reference==
==EDF ссылки==


===Built-in elements===
===Встроенные элементы===
These are the elements you can use for representing your custom elements, along with their properties.
Эти элементы могут использоваться для ваших специфических элементов, вкупе с их настройками.


{| cellspacing="1"
{| cellspacing="1"
Line 258: Line 259:
|}
|}


===Built-in property names===
===Встроенные названия настроек===
Properties with these names have a special meaning to the editor and can be modified by other means than the Properties window.
Настройки с данными именами особенно воспринимаются редактором и могут быть изменены не только через окно Properties.
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 271: Line 272:
|}
|}


===Property types===
===Типы настроек===
These are the types you can choose from for the properties (&lt;data&gt;) of your custom elements.
Это -  типы, которые могут быть выбранными из (&lt;data&gt;) ваших специфических элементов.


====Primitives====
====Primitives====
Line 285: Line 286:
|-
|-
! style="background-color: #EEE"|natural
! style="background-color: #EEE"|natural
| style="background-color: #EEE"|Natural number (whole and positive).
| style="background-color: #EEE"|Natural number (whole and non-negative).
| style="background-color: #EEE"|&nbsp;
| style="background-color: #EEE"|&nbsp;
|-
|-
Line 305: Line 306:
|}
|}


====Coordinates====
====Координаты====
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 320: Line 321:
|}
|}


====Vehicles====
====Транспорт====
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 339: Line 340:
|}
|}


====Model ID's====
====ID моделей====
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 370: Line 371:
|}
|}


====Colshapes and markers====
====Колшейпы и маркеры====
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 386: Line 387:
|}
|}


====Specials====
====Специальные====
{| cellspacing="1"
{| cellspacing="1"
! style="background-color: #EEE"|Name
! style="background-color: #EEE"|Name
Line 400: Line 401:
| style="background-color: #EEE"|The selected value
| style="background-color: #EEE"|The selected value
|}
|}
[[en:Resource:Editor/EDF]]
[[en:Resource:Editor/EDF]]

Revision as of 08:22, 13 May 2012

EDF означает Editor Definition File (файл-описание редактора). EDF'ы являются XML-файлами с расширением .edf, которые описывают специфические элементы, используемые ресурсом: новые типы элементов, которых самих по себе в MTA нет. Образцами служат <spawnpoint> (спавн), <flag> (флаг), <checkpoint>(чекпоинт) и т.д. Они также используются для того, чтобы устанавливать настройки, используемые модами (gamemode), эти настройки находятся под тегом <settings> внутри meta.xml ресурса.

Вступление

Некоторые ресурсы используют специфические элементы карты. Например, мод захвата флага (CTF) скорее всего будет использовать элементы <flag> (флага), которые будут содержать позиции флагов и их принадлежность командам. Когда загружается карта, мод ищет любые элементы <flag> (флага) и соответствующе расставляет флаги - например, через создания объекта флага и его коллизии.

Проблема с этими специфическими элементами в том, что в отличие от встроенных в MTA элементов, редактор карт не понимает, что они из себя представляют. Как должен быть визуально представлен собой элемент <flag> (флага)? Какие у него есть характеристики? Без передачи редактору этой информации, вы не сможете его использовать для создания таких специфических элементов, и вам придется прибегнуть к ручному редактированию .map-файла через текстовый редактор. К счастью, это необязательно: любой ресурс может содержать editor definition file, который опишет специфические элементы карты, используемые ресурсом.

Использование definition files в редакторе

Как и описано в главной инструкции по редактору, чтобы иметь возможно создавать специфические элементы ресурса на вашей карте, вам придется его добавить в окне Definitions. Нажмите кнопку Definitions в главном меню и дважды щелкните по ресурсу из левого списка. Затем закройте окно и крутаните колесиком мыши в панели элементов, пока не появится желаемый ресурс. С этого момента вы можете создавать и управлять специфическими элементами этого ресурса, как любым другим элементом.

Построение EDF-файлов

EDF-файлы - просто XML-файлы с расширением .edf. Начнем с образца: EDF'а мода Capture the Orb. 

<def name="Capture the Orb">
    <element name="orb" friendlyname="Orb spawnpoint" instructions="Place your orb in a position that can be collected.">
        <data name="position" type="coord3d" default="0,0,0" />
        <marker size="0.5" type="corona" color="#ffff00ff" />
    </element>
    <element name="objective" friendlyname="Objective point" instructions="Place your objective point in a position that can be reached.">
        <data name="position" type="coord3d" default="0,0,0" />
        <marker size="3" type="cylinder" color="#9370dbaa" />
    </element>
    <element name="spawnpoint" friendlyname="Spawnpoint">
        <object editorOnly="true" model="3092" posZ="1" />
        <data name="position" type="coord3d" default="0,0,0" />
        <data name="rotation" type="coord3d" default="0,0,0" />
        <data name="skin" type="skinID" default="0" />
    </element>
</def>

Как вы уже убедились, синтаксис очень легок для понимания. Root element (корневой элемент), <def>, содержит несколько <элементов>. Каждый из этих <элементов> описывает специфический элемент и задает его имя, визуальное представление и доступные ему настройки.

Визуальное представление

Каждый child node (дочерний узел) <элемента>, не являющийся <data>, отвечает за визуальное представление. Объектов, маркеров, пикапов и т.д. могут быть один или несколько. Для каждого элемента вы можете опционально задать позицию (posX, posY, posZ) и угол вращения (rotX, rotY, rotZ): они родственны с позицией и вращенем каждого отдельно взятого элемента. На примере Capture the Orb выше, если бы вы захотели создать spawnpoint на (30, 14, 3), редактор бы отобразил объект модели 3092 на координатах (30, 14, 4), потому что posZ объекта, равная 1, была бы сложена с координатой spawnpoint по оси z, равной 3.

Настройки

Настройки специфического элемента описаны в <data>. Имена некоторых настроек, такие как position и rotation, особенные: они могут быть изменены при перемещении и вращении элемента прямо в редакторе. Другие настройки могут быть изменены в окне Properties.

Визуально представление, зависимое от настроек

Специфический элемент можно сделать зависимым от одной или более настроек элемента. Например, элемент <checkpoint> race мода, содержащий <marker>: checkpoint, имеет несколько атрибутов, таких как color и size, которые должны быть отражены в маркере. Чтобы это сделать, укажите что-нибудь из формы !propertyname! в качестве одного или более атрибутов, ответственных за элемент. Например: 

<def name="Race">
	<element name="checkpoint" friendlyname="Race checkpoint">
		<data name="position" type="coord3d" required="true" default="0,0,0" />

		<data name="type" type="selection:checkpoint,ring" required="true" default="checkpoint" />
		<data name="size" type="number" required="true" default="2.25"/>
		<data name="color" type="color" required="false" default="#ff0000ff" />
		...
		
		<marker type="!type!" size="!size!" color="!color!" />
	</element>
</def>

Теперь, когда бы настройки чекпоинта "type", "size" или "color" не менялись, новое значение будет также скопировано в его маркер, в связи с чем изменится внешний вид маркера.

Интеграция в ресурсы

Когда вы написали свой EDF, сохраните его как .edf-файл в папке своего ресурса и добавьте атрибут "edf:definition" в тег <info> meta.xml, как здесь: 

<meta>
    <info author="erorr404" type="gamemode" ... edf:definition="cto.edf" />
    ...
</meta>

EDF ссылки

Встроенные элементы

Эти элементы могут использоваться для ваших специфических элементов, вкупе с их настройками.

<blip>
Property Type
position coord3d
icon blipID
size integer
color color
dimension integer


<marker>
Property Type
position coord3d
type markerType
size number
color color
interior integer
dimension integer


<object>
Property Type
model objectID
position coord3d
rotation coord3d
interior integer
dimension integer


<ped>
Property Type
position coord3d
model skinID
rotZ number
interior integer
dimension integer


<pickup>
Property Type
position coord3d
type pickupType
amount number
respawn integer
interior integer
dimension integer


<vehicle>
Property Type
model vehicleID
position coord3d
rotation coord3d
color vehiclecolors
upgrades vehicleupgrades
plate plate
interior integer
dimension integer


<radararea>
Property Type
posX number
posY number
sizeX number
sizeY number
color color
dimension integer

Встроенные названия настроек

Настройки с данными именами особенно воспринимаются редактором и могут быть изменены не только через окно Properties.

Name Type
position coord3d
rotation coord3d

Типы настроек

Это - типы, которые могут быть выбранными из (<data>) ваших специфических элементов.

Primitives

Name Description Value
boolean Simple boolean value. "true" or "false"
natural Natural number (whole and non-negative).  
integer Whole number.  
number Rational number.  
string Simple string of text.  
color color, with or without alpha. #RRGGBB or #RRGGBBAA

Координаты

Name Description Value
camera Position and lookat coordinates for the camera. posX,posY,posZ,lookatX,lookatY,lookatZ
coord3d 3-component vector, typically used for positions and rotations. x,y,z

Транспорт

Name Description Value
plate Number plate text for a vehicle.  
vehiclecolors colors of a vehicle colorID1,colorID2,colorID3,colorID4
vehicleupgrades Upgrades of a vehicle upgradeID1,upgradeID2,...

ID моделей

Name Description Value
blipID Picture ID for blips  
objectID Model ID for objects  
pickupType Armor, health or weapon "armor", "health" or numeric weapon ID
skinID Skin ID for peds  
vehicleID Model ID for vehicles  
weaponID Weapon, e.g. M4 Numeric weapon ID, e.g. 31

Колшейпы и маркеры

Name Description Value
colshapeType collision circle, cube, rectangle, sphere or tube One of: "colcircle", "colcube", "colrectangle", "colsphere", "coltube"
markerType Arrow, checkpoint, corona, cylinder or ring marker. One of: "arrow", "checkpoint", "corona", "cylinder", "ring"

Специальные

Name Description Value
element:type Element of a certain type, for example: element:flag The element's ID
selection:val1,val2,... Shows a dropdown box from which to pick one value. The selected value
Retrieved from "https://wiki.multitheftauto.com/wiki/RU/Resource:Editor/EDF?oldid=30627"