mineprogramming wiki - Вклад участника [ru]

CoreEngine/Структура мода

2020-05-03T13:32:27Z

185.201.90.199:

Моды в Core Engine представляют собой папку с кодом, изображениями и текстурами, подхватываемых движком.

<div class="mw-parser-output"><h2> Общее </h2><p>В папке с модом находятся следующие объекты:
</p>
<ul><li>main.js - содержит весь код мода целиком. </li>
<li>launcher.js - выполняется при загрузке мода, позволяет подключить сторонние моды, управлять ресурсами. </li>
<li>config.json - файл конфигурации мода, по умолчанию содержит только две опции:
<ul><li>enabled - по умолчанию true, определяет возможность загрузки мода. </li>
<li>advanced_api - не используется самим движком, но может быть использована модом для расширения API. </li></ul></li>
<li>mod.info - не используется самим движком, но позволяет моду самоиндифицироваться. </li>
<li>resources.zip - текстурпак, содержит текстуры блоков, предметов, мобов. Разработчикам настоятельно рекомендуется собирать данный архив из содержимого папки resources. </li>
<li>resources.json - содержит список загружаемых движком текстурпаком. По умолчанию содержит только resources.zip со значением true. </li>
<li>dev - см. Структура скриптов </li>
<li>gui - папка, содержит текстуры для интерфейса, загружаются автоматически. </li>
<li>lib - см. Подключение библиотек. </li>
<li>resources - необязательна, разработчик может собирать из нее текстурпак для мода.</li></ul>
</div>

<div class="mw-parser-output">
== Структура скриптов ==

Весь код, конечно, можно писать и в main.js. Но это неудобно, к тому же при малейшем расширении кодовой базы большинство текстовых редакторов начинают тупить.<br/> Для удобной работы с кодом можно распределить его по нескольким файлам, а потом склеивать содержимое и сохранять все в main.js.<br/> Core Engine делает это автоматически. Все нужные файлы кода должны лежать в папке dev. В отличие от аддонов Factorization, можно распределять части скрипта по подпапкам.

Во время загрузки мода, если имеется dev, движок читает специальный файл-"манифест" .includes внутри dev, содержащий список файлов, подлежащих сборке. Добавлять скрипты в этот манифест очень легко. Для этого введите его путь и сохраните файл.
<pre>lol.js //движок будет искать файл %папка мода%/dev/lol.js //а тут путь %папка мода%/dev/bezmata
//кстати, эти комментарии будут находиться прямо в main.js(!), так что используйте это, если не хотите заблудиться там ;)</pre>
</div>

== <br/> Подключение библиотек ==

В Core Engine существует система особых скриптов — библиотек. Они загружаются вместе с первым модом, который использует данную библиотеку, и доступны в коде других модов с этим же скриптом.<br/> Все библиотеки хранятся в папке lib.

Чтобы создать свою библиотеку, напишите обычный скрипт и засуньте его в папку lib. В конце файла добавьте:<br/> registerAPIUnit(псевдоним, значение)<br/> Псевдоним - имя, под которым значение будет доступно в модах, использующих библиотеку.<br/> Значение - тут все, что угодно - метод библиотеки, объект, просто число или строка.<br/> Повторите этот метод для всех нужных значений.

Для подключения библиотеки к вашему моду закиньте ее в папку lib. Пропишите в нужном месте мода метод:<br/> importLib(название библиотеки, псевдоним);<br/> Название библиотеки - название файла скрипта с ней без js в кавычках.<br/> Псевдоним - нужный вам псевдоним из указанной библиотеки в кавычках. Если вам нужно все ее содержимое, пропишите универсальный псевдоним "*".

InnerCore/Создание блоков и предметов

2020-05-03T13:06:40Z

185.201.90.199:

<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
=== Регистрация ID ===

ID - уникальный идентефикатор блока\предмета, задается строкой и натуральным числом, которое сопоставляется этой строке. Чтобы зарегистрировать ID, используется модуль IDRegistry.

Для регистрации ID блока используется метод IDRegistry.genBlockID("строковый ID") - после вызова этой функции сгенерируется новый уникальный ID для блока, доступ к числовому значению которого может быть произведен как BlockID.<строковый ID>

Для регистрации ID предмета используется метод IDRegistry.genItemID("строковый ID") - после вызова этой функции сгенерируется новый уникальный ID для предмета, доступ к числовому значению которого может быть произведен как ItemID.<строковый ID>

Примеры:
<syntaxhighlight lang="Javascript">IDRegistry.genBlockID("testBlock"); // доступ BlockID.testBlock
IDRegistry.genItemID("testItem"); // доступ ItemID.testItem</syntaxhighlight>
</div>
=== Текстуры ===

В ресурсах мода текстуры блоков и предметов задаются в определенном формате: каждая текстура должна быть в формате .png и имеет имя и номер, название любой текстуры выглядит так: имя_номер.png и никак иначе. Номера текстур с одним именем должны идти последовательно и начинаться с 0.

Текстуры блоков в ресурспаке располагаются по адресу images/terrain-atlas/

Текстуры предметов в ресурспаке располагаются по адресу images/items-opaque/
<div class="mw-parser-output">
<div class="mw-parser-output">
=== Создание блоков ===

После регистрации ID для блока, создается сам блок на этом ID. На одном ID может быть создано несколько вариаций блока, каждая из которых обладает своим именем и текстурой, разные вариации одного блока в мире будут иметь один ID, но разные значения metadata, подробнее об этом будет позднее. Для создания блоков используется модуль Block.

Метод Block.createBlock("строковый ID", [вариация1, вариация2, ...]) - создает блок и все его вариации на ранее зарегистрированном ID, если вариация 1, то просто создает данный блок.

Каждая вариация в массиве имеет формат
<syntaxhighlight lang="Javascript">{
name: "имя вариации",
texture: [
["название1", индекс1], // bottom
["название2", индекс2], // top
["название3", индекс3], // back
["название4", индекс4], // front
["название5", индекс5], // left
["название6", индекс6] // right
],
inCreative: true/false //(добавлять ли данную вариацию блока в креатив)
}</syntaxhighlight>

Если текстур указано меньше, чем 6, то последняя из них будет дублирована несколько раз, чтобы дополнить их кол-во до 6.

'''Пример''':
<syntaxhighlight lang="Javascript">IDRegistry.genBlockID("testBlock"); // регистрация
Block.createBlock("testBlock", [
     {name: "test block", texture: [["planks", 0], ["planks", 0], ["planks", 0], ["planks", 0], ["planks", 0], ["planks", 0]], inCreative: true}
]); // создание простого блока на ID "testBlock" с текстурой досок на всех сторонах, будет добавлен в креатив</syntaxhighlight>

==== Создание блоков с поворотом ====

Метод Block.createBlockWithRotation -  принимает те же аргументы, что и Block.createBlock, но для каждой вариации блока создает 4 вариации, которые реализуют поворот, блок, созданный этим методом, автоматически будет ставиться с нужным поворотом. </div>
</div>

=== Создание предметов ===

После регистрации ID предмета, создается сам предмет на этом ID. Предметы могут быть разных типов: обычный, броня, еда и кидаемый, для каждого из них существует свой метод. Для создания предметов используется модуль Item. Каждый предмет имеет текстуру, которая задается в формате {name: "имя текстуры", meta: <номер текстуры>}, если номер текстуры 0, его можно не указывать.

Item.createItem("строковый ID", "имя предмета", текстура, параметры) - создает обычный предмет на ранее зарегистрированном строковом ID, с данным именем, текстурой и параметрами.

Параметры имеют формат, если вы не хотите изменять значения по-умолчанию, просто не пишите их:
<syntaxhighlight lang="Javascript">{
     isTech: false, // если true, не добавляет предмет в креатив
     stack: 64 // размер стака
} </syntaxhighlight>

==== Создание еды ====

Item.createFoodItem("строковый ID", "имя предмета", текстура, параметры) - создает съедобный предмет на ранее зарегистрированном строковом ID, с данным именем, текстурой и параметрами.

Параметры имеют формат, если вы не хотите изменять значения по-умолчанию, просто не пишите их:
<syntaxhighlight lang="Javascript">{
     isTech: false,// если true, не добавляет предмет в креатив
     stack: 64, // размер стака
     food: 1 // восполнение здоровья едой
}</syntaxhighlight>

==== Создание кидаемого предмета ====

Item.createThrowableItem("строковый ID", "имя предмета", текстура, параметры) - создает кидаемый предмет на ранее зарегистрированном строковом ID, с данным именем, текстурой и параметрами.

Параметры имеют формат, если вы не хотите изменять значения по-умолчанию, просто не пишите их:
<syntaxhighlight lang="Javascript">{
     isTech: false, // если true, не добавляет предмет в креатив
     stack: 64 // сколько предметов будет в одном стаке, максимум 64.
}</syntaxhighlight>
<div class="mw-parser-output">
<div class="mw-parser-output"><div class="mw-parser-output">
<div class="mw-parser-output">
<div class="mw-parser-output"><div class="mw-parser-output">
==== Пример кидаемого предмета. ====
<pre>IDRegistry.genItemID("throwableItem"); 
Item.createThrowableItem("throwableItem", "Throwable Item", { name: "throwable_item", meta: 0}, {})
</pre>
</div> </div>
</div> </div> </div>
</div>

==== Создание брони ====
<pre>Item.createArmorItem("строковый ID", "имя предмета", текстура, параметры) - создает предмет брони на ранее зарегистрированном строковом ID, с данным именем, текстурой и параметрами.</pre>

Параметры имеют формат, если вы не хотите изменять значения по-умолчанию, просто не пишите их:
<syntaxhighlight lang="Javascript">{
     isTech: false, // если true, не добавляет предмет в креатив
     armor: 1, // количество добавляемой брони в шкале защиты
     type: <обязательное значение>, // тип предмета "helmet"/"chestplate"/"leggings"/"boots"
     texture: <обязательное значение>, // текстура модели данной брони
     durability: 1 // прочность брони
}</syntaxhighlight>

=== Пример брони ===

 
<syntaxhighlight lang="Javascript">IDRegistry.genItemID("helmet");//создаем новый ID для шлема
IDRegistry.genItemID("chestplate");//создаем новый ID для нагрудника
IDRegistry.genItemID("leggings");//создаем новый ID для понож
IDRegistry.genItemID("boots");//создаем новый ID для ботинок

Item.createArmorItem("helmet", "Helmet", {name: "helmet"}, {type: "helmet", armor: 2, durability: 149, texture: "armor/lay_1.png"});//применяем наш ID helmet, добавляем имя Helmet, задаем текстуру предмета и объект описания.
Item.createArmorItem("chestplate", "Chestplate", {name: "chestplate"}, {type: "chestplate", armor: 6, durability: 216, texture: "armor/lay_1.png"});//применяем наш ID chestplate, добавляем имя ChestPlate, задаем текстуру предмета и объект описания.
Item.createArmorItem("leggings", "Leggings", {name: "leggings"}, {type: "leggings", armor: 5, durability: 203, texture: "armor/lay_2.png"});//применяем наш ID leggins, добавляем имя Leggins, задаем текстуру предмета и объект описания.
Item.createArmorItem("boots", "Boots", {name: "boots"}, {type: "boots", armor: 2, durability: 176, texture: "armor/lay_1.png"});//применяем наш ID boots, добавляем имя Boots, задаем текстуру предмета и объект описания.</syntaxhighlight>
<div class="mw-parser-output">
=== Пример предмета ===

 
<syntaxhighlight lang="Javascript">IDRegistry.genItemID("testItem");
Item.createItem("testItem", "test item", {name: "stick", meta: 0}, {}); // создаем обычный предмет на ID testItem с текстурой палки и стандартными параметрами
</syntaxhighlight>
</div> </div> </div> </div>