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

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

2019-07-18T21:24:31Z

Крег:

<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], // низ
["название2", индекс2], // вверх
["название3", индекс3], // зад
["название4", индекс4], // перед
["название5", индекс5], // левая сторона
["название6", индекс6] // правая сторона
],
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">
<h4>Пример кидаемого предмета.</h4>

<p> </p>

<pre class="fck_mw_syntaxhighlight">
<syntaxhighlight lang="Javascript">//TODO</syntaxhighlight></pre>
</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>

InnerCore/Рендер блоков

2019-07-18T21:23:01Z

Крег:

<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">
<div class="mw-parser-output">
= Введение в рендер блоков =

Кроме формы из одного параллелепипеда, которой обладает большинство блоков, Inner Core позволяет задать им почти любой внешний вид.  
</div>

<div class="mw-parser-output">
== Формат описания текстуры и ее наложение на блок ==

Хоть наложение текстур и было описано ранее, оно имеет непосредственное отношение к дальнейшему описанию.

Ссылка на каждую отдельную текстуру блока состоит из двух элементов - ее названия и индекса, напомню, что название и индекс задаются для файла текстуры в ресурсах в формате "имя_индекс.png", где имя - произвольная строка, а индекс - неотрицательное целое число.

Текстура целого блока может быть описана либо двумя параметрами - именем и индексом текстуры, в таком случае весь блок будет иметь одну и ту же текстуру, либо массивом текстур, формат которого приведен ниже.
<syntaxhighlight lang="Javascript">[
["название1", индекс1], // низ
["название2", индекс2], // вверх
["название3", индекс3], // зад
["название4", индекс4], // перед
["название5", индекс5], // левая сторона
["название6", индекс6] // правая сторона
]</syntaxhighlight>
Каждый из элементов массива отвечает за одну текстуру, если элементов меньше 6, то текстуры недостающих сторон скопируют последний элемент массива.</div> </div> </div> </div></div>

== Статичная модель блока ==

Статичная модель является самым простым типом рендера блока и представляет из себя набор различных элементов внешнего вида блока, которые могут быть отрисованы на произвольных координатах. Внешний вид статичной модели не зависит от того, что ее окружает.

Основной, хоть и не единственный элемент модели - бокс - является текстурированным параллелепипедом с заданными начальными и конечными координатами x1, y1, z1, x2, y2, z2 в пространстве конкретного блока (0 означает начало блока, 1 - конец по данной координате, координаты могут выходить за пределы 0-1).  

Пустая статичная модель создается с помощью конструктора ''new BlockRenderer.Model()'' и обладает следующими методами:

<span style="line-height:108%">model.addBox(x1, y1, z1, x2, y2, z2, id, data) - добавляет бокс с текстурой блока с данными id, data</span>

<span style="line-height:108%">model.addBox(x1, y1, z1, x2, y2, z2, "name", index) - добавляет бокс с текстурой с именем name и индексом index на всех сторонах</span>

<span style="line-height:108%">model.addBox(x1, y1, z1, x2, y2, z2, [… texture set ...]) - добавляет бокс с заданным массивом текстур (формат см. выше)</span>

<span style="line-height:108%">model.addMesh(mesh) - добавляет в модель объект RenderMesh - произвольную полигональную 3D модель, о которых будет рассказано позднее</span>

Существуют так же другие конструкторы, упрощающие быстрое создание простых моделей:

<span style="line-height:108%">new BlockRenderer.Model(mesh) - создает модель, которая содержит в себе данный объект RenderMesh</span>

<span style="line-height:108%">new BlockRenderer.Model(x1, y1, z1, x2, y2, z2, [… texture set ...]) - создает модель, которая является одним боксом с данным массивом текстур</span>

<span style="line-height:108%">new BlockRenderer.Model([… texture set ...]) - создает модель, которая является полным блоком с данным массивом текстур</span>

<span style="line-height:108%">new BlockRenderer.Model(x1, y1, z1, x2, y2, z2, "name", index) - создает модель, которая является одним боксом с данной текстурой на всех сторонах</span>

<span style="line-height:108%">new BlockRenderer.Model("name", index) - создает модель, которая является полным блоком с данной текстурой на всех сторонах</span>

<span style="line-height:108%">new BlockRenderer.Model(x1, y1, z1, x2, y2, z2, id, data) - создает модель, которая является одним боксом, копирующим текстуру из блока с данными id, data</span>

<span style="line-height:108%">new BlockRenderer.Model(id, data) -  создает модель, которая является полным блоком, копирующим текстуру из блока с данными id, data</span>

== Основы ICRender ==

ICRender является системой, позволяющей заранее задать блоку внешний вид в зависимости от внешних условий. Основным объектом для рендера блоков является модель ICRender, которая является набором статических моделей и условий, при которых они будут отрисовываться.

Для создания модели ICRender используется конструктор ''new ICRender.Model(), ''для добавления статичной модели в модель ICRender используется метод ''addEntry(model)'':
<syntaxhighlight lang="Javascript">var staticModel = new BlockRenderer.Model(); // модификация модели staticModel
var icRenderModel = new ICRender.Model();
icRenderModel.addEntry(staticModel); </syntaxhighlight>

Чтобы установить блоку модель ICRender используется метод
<p style="margin-top:0cm; margin-right:3.2pt; margin-bottom:7.85pt; margin-left:0cm; text-align:justify"><span style="text-justify:inter-ideograph"><span style="line-height:108%">''BlockRenderer.setStaticICRender(id, data, model) - ''где id и data - целевой блок (если надо установить для любого значения data, вместо него нужно передать -1), а model - модель ICRender.</span></span></p>
Пример:
<syntaxhighlight lang="Javascript">BlockRenderer.setStaticICRender(BlockID.testRenderBlock, -1, icRenderModel); // после этого требуемый блок будет иметь созданную ранее модель</syntaxhighlight>
<div class="mw-parser-output"><div class="mw-parser-output">
<div class="mw-parser-output">
== Маппинг рендера'' ==

Кроме обычной установки ICRender блокам, им можно так же включить режим ''маппинга рендера''. Он позволяет устанавливать любые модели ICRender конкретным блокам в мире, для которых маппинг включен, не затрагивая остальные блоки.

Для включения маппинга используется метод ''BlockRenderer.enableCoordMapping(id, data, model) - ''где id и data - целевой блок, а model - модель ICRender, которая будет использована для данного блока по умолчанию.

Без дополнительных действий такой вызов ничем не будет отличаться по действию от вызова ''BlockRenderer.setStaticICRender. ''Для маппинга используются следующие методы:

<span style="line-height:108%">BlockRenderer.mapAtCoords(x, y, z, model) - устанавливает данную модель ICRender на данные координаты, любой блок, для которого включен маппинг и который стоит на этих координатах, будет иметь эту модель.</span>

<span style="line-height:108%">BlockRender.unmapAtCoords(x, y, z) - отменяет действие предыдущей функции на данных координатах, возвращая стандартную модель любого блока.</span>

<u style="text-underline:black">Важно отметить:</u> '' ''

#Все установленные на координатах модели очищаются при выходе из мира.
#Наличие блока никак не связано с тем, что на данных координатах установлена модель, это значит, что если сломать блок, подверженный маппингу, у которого была изменена модель и поставить на его место другой блок, тоже подверженный маппингу, то модель сохранится. Потому важно следить, на какой именно блок вызывается mapAtCoords и обязательно вызывать unmapAtCoords при уничтожении блока.
</div>