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

InnerCore/Libs/ToolLib

2020-05-29T18:31:27Z

128.73.195.44:

InnerCore/Libs/StorageInterface

2020-05-29T17:55:41Z

128.73.195.44:

<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"><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"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
Данная библиотека для Inner Core позволяет описать взаимодействие блоков с трубами, воронками и прочими предметами для транспортировки предметов и жидкостей с помощью интерфейсов хранилищ, а так же добавляет методы для извлечения и загрузки предметов и жидкостей.
<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">
== Загрузка ==

{| border="1" cellpadding="1" cellspacing="1"
|-
| Версия
| Ссылка
| style="width: 280px;" | Список изменений
| style="width: 350px;" | Дата релиза
|-
| '''6'''
| [https://yadi.sk/d/TITakdpdsjIGug Скачать]
| style="width: 280px;" | - Библиотека обновлена на InnerCore для Horizon: добавлена поддержка новых ванильных контейнеров.
| style="width: 350px;" | 18.04.2020
|-
| '''5'''
| [https://yadi.sk/d/Om5TRGdlhylfQA Скачать]
| style="width: 280px;" | - Исправлена ошибка взаимодействия с tile entity без интерфейса хранилища в методе StorageInterface.transportLiquid
| style="width: 350px;" | 09.03.2020
|-
| '''4'''
| [https://yadi.sk/d/1gBu4a-fEme-jA Скачать]
| style="width: 280px;" |
- Улучшена работа с жидкостями<br/> - В интерфейс добавлено поле liquidStorage

| style="width: 350px;" | 05.03.2020
|-
| '''3'''
| [https://drive.google.com/file/d/1Hsp2nLIER0wF-ZzDvdsy1btxWFhnebv1/view?usp=sharing Скачать]
| style="width: 280px;" | релиз библиотеки
| style="width: 350px;" | 02.02.2020
|}
</div> </div> </div> </div> </div> </div>
== Импорт ==

Для добавления библиотеки в мод ее файл ''([https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/StorageInterface.js StorageInterface.js])'' нужно добавить в директорию ''lib/'' в директории мода (если таковой нету, то ее нужно создать).

Для импорта библиотеки в мод в заголовочном файле (или если он остутвует в первом файле кода) следует добавить строку:
<pre>IMPORT("StorageInterface");</pre>
<div class="mw-parser-output"><div class="mw-parser-output">
== Интерфейсы хранилищ блоков ==

На данный момент интерфейсы привязываются только к tile entity, но в будущем по умолчанию интерфейсы будут прописаны у контейнеров из Майнкрафта, прежде всего печки.

Интерфейс для хранилища добавляется с помощью метода ''StorageInterface.createInterface(id блока, объект интерфейса).''<br/> Регистрация слотов в интерфейсе выглядит так:
<syntaxhighlight lang="JavaScript">StorageInterface.createInterface(id блока, {
slots: {
"slot1": {
input: true/false, // может ли слот принимать предметы
output: true/false, // может ли слот отдавать предметы
isValid: function(item, side, tileEntity){ // может ли слот принять предмет item со стороны side
return true/false;
},
canOutput: function(item, side, tileEntity){ // можно ли извлечь предмет из слота (item - предмет в слоте)
return true/false;
}
},
"slot2": {
...
},
...
}
});</syntaxhighlight>

<br/> Так же интерфейс хранилища обладает следующими функциями, которые могут быть перезаписаны в объекте интерфейса:

{| border="1" cellpadding="1" cellspacing="1"
|-
| Название
| Аргументы
| Описание
|-
| '''isValidInput'''
| item, side, tileEntity
| Аналогична функции isValid слота, но действует на все слоты контейнера. По умолчанию возвращает true.
|-
| '''addItem'''
| item, side, maxCount
| Функция добавления предмета, может быть перезаписана. Возвращает количество добавленных предметов.
|-
| '''getOutputSlots'''
| side
| Возвращяет слоты выхода, с которыми возможна работа с определённой стороны.
|-
| '''canReceiveLiquid'''
| liquid, side
| Может ли tile entity принять жидкость с именем ''liquid ''со стороны ''side''. По умолчанию возвращает false.
|-
| '''canTransportLiquid'''
| liquid, side
| Может ли tile entity отдать жидкость с именем ''liquid ''со стороны ''side''. По умолчанию возвращает false.
|-
| '''addLiquid'''
| liquid, amount
| Функция добавление жидкости. По умолчанию работает с liquidStorage.
|-
| '''getLiquid'''
| liquid, amount
| Функция извлечения жидкости. По умолчанию работает с liquidStorage. В функциях StorageInterface для передачи жидкости сначала извлекается весь возможный объём жидкости, а потом функция вызывается повторно с отрицательным ''amount ''для возвращения жидкости, которую не удалось передать.
|-
| '''getLiquidStored'''
| storage, side
| Функция получения жидкости, хранящейся в tile entity. В функциях StorageInterface аргумент ''storage ''равен ''"input" ''если проверяется жидкость для добавления, и''"output"'' если для извлечения.
|}
<div class="mw-parser-output"> </div> <div class="mw-parser-output">Интерфейс хранилища сохраняется в поле ''interface ''объекта tile entity. В экземпляре интерфейса есть следующие указатели:</div> <div class="mw-parser-output">''tileEntity ''- на tile entity, к которому он привязан;</div> <div class="mw-parser-output">''container ''- на контейнер tile entity;</div> <div class="mw-parser-output">''liquidStorage ''- на хранилище жидкости tileEntity.</div> <div class="mw-parser-output"> </div> <div class="mw-parser-output">Добавление интерфейса для tile entity на примере железной печки из мода IndustrialCraft 2</div> <syntaxhighlight lang="JavaScript">StorageInterface.createInterface(BlockID.ironFurnace, {
slots: {
"slotSource": {
input: true,
isValid: function(item, side){
return side != 0 && Recipes.getFurnaceRecipeResult(item.id, "iron");
}
},
"slotFuel": {
input: true,
isValid: function(item, side){
return side != 1 && Recipes.getFuelBurnDuration(item.id, item.data) > 0;
}
},
"slotResult": {output: true}
}
});</syntaxhighlight>
</div> <div class="mw-parser-output"><div class="mw-parser-output"> </div> </div> </div>
<div class="mw-parser-output">
== Методы для передачи предметов и жидкостей ==

{| border="1" cellpadding="1" cellspacing="1"
|-
| Название
| Аргументы
| Описание
|-
| '''getNearestContainers'''
| coords, side, sideExcluded
| Возвращает соседние с блоком на координатах ''coords ''контейнеры в виде массива. Если указан параметр ''side'', то вернёт контейнер с этой стороны. Если ''sideExcluded ''равен ''true'', то наоборот, все контейнеры кроме контейнера с указанной стороны.
|-
| '''getNearestLiquidStorages'''
| coords, side, sideExcluded
| Аналогична предыдущей, но возвращает все соседние tile entity, имеющие хранилища жидкостей.
|-
| '''putItems'''
| items, containers
| Добавляет предметы из массива items в контейнеры из массива containers. Удобно использовать в связке с методом ''getNearestContainers'''''.'''
|-
| '''putItemToContainer'''
| item, container, side, maxCount
| Метод более низкого уровня, на котором основана работа предыдущего метода. Добавляет стак предметов в контейнер, но позволяет также указать максимальное количество предметов, которое может быть передано за раз.
|-
| '''extractItemsFromContainer'''
| inputTile, container, side, maxCount, oneStack
|
Позволяет извлечь предмет из контейнера и добавить его в tile entity.<br/> '''inputTile '''- tile entity, в который будут добавлены предметы<br/> '''container '''- контейнер, из которого будут извлечены предметы<br/> '''maxCount '''- сколько предметов может быть извлечено (по умолчанию не ограничено)<br/> '''oneStack '''- если true, то будет извлечён только один стак предметов.

|-
| '''transportLiquid'''
| liquid, maxAmount, outputTile, inputTile, outputSide
|
Передаёт жидкость из одного tile entity в другой.<br/> '''liquid '''- название жидкости<br/> '''maxAmount '''- максимальное количество, которое будет передано<br/> '''outputTile '''- tile entity, из которого будет передана жидкость<br/> '''inputTile '''- tile entity, в который будет передана жидкость<br/> '''outputSide '''- сторона, через которую передаётся жидкость

|-
| '''extractLiquid'''
| liquid, maxAmount, inputTile, outputTile, inputSide
|
Похож на предыдущий, но позволяет извлечь жидкость из tile entity<br/> '''liquid '''- в отличие от предыдущего метода жидкость может быть не указана, тогда извлечёт жидкость, которая хранится в ''outputTile''.<br/> '''inputSide '''- сторона, в которую будет поступать жидкость

|-
| '''checkHoppers'''
| tileEntity
| Позволяет tile entity взаимодействовать с воронками. Для этого должна выполняться в функции тика tile entity. Требует интерфейса хранилища у tile entity для работы.
|-
| '''addItemToSlot'''
| item, slot, count
| Внутренний метод библиотеки для добавления предмета в слот. При использовании на нативном контейнере нужно также установить слот, используя ''container.setSlot.''
|}
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"> </div> </div> </div> </div> </div></div>

== Обратная совместимость ==

Данная библиотека совместима с модами, использующими старый стандарт описания слотов tile entity через функцию ''getTransportSlots'', а так же добавляет эту функцию и функцию ''addTransportedItem ''для tile entity при создании его интерфейса.
</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>

InnerCore/Libs/EnergyLib

2020-05-29T17:44:06Z

128.73.195.44:

<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">
<span style="font-size:large;">'''!Поддержка библиотеки прекращена, используйте [[InnerCore/Libs/EnergyNet|EnergyNet]]!'''</span>

Данная библиотека для Core Engine представляет собой инструмент для быстрого создания новых типов энергии и работы с ними.  

== Подключение ==

Для добавления библиотеки в мод ее файл ([https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/energylib.js ''energylib.js'']) нужно добавить в директорию ''lib/'' в директории мода (если таковой нету, то ее нужно создать).

Для импорта библиотеки в мод в заголовочном файле (или если он остутвует в первом файле кода) следует добавить строку ''importLib("energylib.js", "*") .''

= Модули =

#''EnergyLibCore'' - модуль для технической работы с библиотекой, осуществляет доступ к объекту ее конфигурации.'''
#''EnergyTypeRegistry - ''модуль для регистрации новых типов энергии.
#''EnergyTileRegistry - ''модуль для привязки типов энергии к Tile Entity.

= Создание новых типов энергии =

''EnergyTypeRegistry.assureEnergyType("name", value)'' - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.

<span style="line-height:107%"><u style="text-underline:black">Параметры:</u></span>

*name - уникальное название энергии, обычно используется сокращение ("Eu" - energy units, "RF" - redstone flux и т.п.)

<span style="line-height:108%"><span style="font-family:">•</span></span>value - сколько Eu (единиц энергии industrial craft) содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. Энергия Eu принята за эталон.

Возвращает функция тип с данным именем (созданный или импортированый), который обладает следующими методами и значениями:

*<energyType>.name - имя данного типа энергии.
*<span style="line-height:109%"><energyType>.<span style="font-size:11.0pt"><span style="line-height:109%">getWireSpecialType() - возвращает специальный тип блока, который будет являться проводником данного типа энергии.</span></span></span>

<span style="line-height:107%">'''<span style="font-size:11.0pt"><span style="line-height:107%">Пример:</span></span>'''</span>
<syntaxhighlight lang="Javascript">// в начале мода импортируем библиотеку (она должна находиться в lib/)
importLib("energylib.js", "*");

// создаем тип энергии redstone flux var energyRedstoneFlux = EnergyTypeRegistry.assureEnergyType("RF", 0.25);
// создаем блок-проводник для данного типа энергии
IDRegistry.genBlockID("RFconduct");
Block.createBlock("RFconduct", [
{name: "RF Conduct", texture: [["rf_conduct", 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода ], energyRestroneFlux.getWireSpecialType()); </syntaxhighlight>

 

= Привязка типов энергии к TileEntity =

Для того, чтобы привязать тип энергии к tile entity используется метод

''EnergyTileRegistry.addEnergyTypeForId(tileEntityId, energyType)'' - добавляет tile entity  с данным id дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.

<span style="line-height:107%"><u style="text-underline:black">Параметры:</u></span>

*tileEntityId – id блока, на который был зарегистрирован нужный tile entity.
*energyType - тип энергии, который требуется к нему привязать.

<span style="line-height:107%"><u style="text-underline:black">Новые</u><u style="text-underline:black">события</u><u style="text-underline:black">:</u></span>

energyTick: function(type, src) { /* … */ } - вызывается каждый тик для каждого типа энергии, привязанного к данному tile entity. Параметры:

*type - название типа энергии, для которого вызвано это событие
*<span style="line-height:107%">src - объект типа energy source для работы с энергией, о нем речь пойдет позже.</span>

energyReceive: function(type, src) { /* … */ } - аналогична energyTick, но вызывается только если в сети есть энергия.

isGenerator: function() {return true;} - данный метод нужно только если tile entity в основном генерирует энергию, а не забирает ее (является генератором), нужна для более точного расчёта.

<div class="mw-parser-output">
= Механика энергии =

Несколько tile entity поддерживающих одинаковый тип энергии и соединенные подходящим проводником объединяются в энергетическую сеть. Tile entity имеют возможность забирать энергию из сети и передавать ее туда, при этом вся переданная энергия распределяется равномерно по потребителям.
</div>

= Объект EnergySource =

Данный объект является интерфейсом для работы с энергией в сети, который передается в события для работы с энергией (src).

<span style="line-height:107%"><u style="text-underline:black">Методы:</u></span>

*src.add(amount) - добавляет в сеть данное кол-во энергии (amount), возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Обычно данный метод используется в генераторах.  
*src.get(amount) - забирает из сети данное кол-во энергии (amount), возвращает, какое кол-во энергии удалось забрать.
*src.getAll(amount) - аналогичен методу get, но игнорирует равномерное распределение по всем tile entity в сети, в большинстве случаев лучше использовать get.
*src.free() - возвращает, сколько в сети есть свободного места для энергии.
*src.amount() - возвращает, сколько энергии есть в сети.

<span style="line-height:108%"><span style="font-family:">•</span></span>src.storage(receive, retreive) - данный метод является функцией хранилищ энергии. Как параметры принимает то, сколько энергии он максимально может принять (reveive) и сколько максимально может отдать (retreive) за данный тик. Возвращает изменение энергии (отрицательное, если энергия была отдана, положительное, если принята).  

<span style="line-height:107%">'''Пример 1 - генератор:'''</span>
<syntaxhighlight lang="Javascript">// требуется создать блок с id "RFgenerator"
TileEntity.registerPrototype(BlockID.RFgenerator, {
isGenerator: function() {
return true;
},

energyTick: function(type, src) {
src.add(10); // генерирует 10 RF за тик
}
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFgenerator, energyRedstoneFlux);</syntaxhighlight>

 

<span style="line-height:107%">'' ''</span>

<span style="line-height:107%">'''Пример 2 - потребитель:'''</span>
<syntaxhighlight lang="Javascript">// требуется создать блок с id "RFconsumer"
TileEntity.registerPrototype(BlockID.RFconsumer, {
energyTick: function(type, src) {
var energy = Math.floor(src.get(10)); // получить от 0 до 10 энергии, Math.floor используется в данном случае для устранения ошибки вычислений, в большинстве случаев это не нужно
for (var i = 0; i < energy; i++) { // чем больше энергии, тем больше частиц
Particles.addParticle(this.x + Math.random(), this.y + 1, this.z +
Math.random(), 6, 0, .07, 0); // создать частицу над блоком
}
}
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFconsumer, energyRedstoneFlux);</syntaxhighlight>

<span style="line-height:107%">'' ''</span><span style="line-height:107%"><u style="text-underline:black">При соединении 2х этих блоков проводом, созданным ранее один из них будет</u> <u style="text-underline:black">испускать частицы, если потребителей будет несколько, а генератор один, то частиц на</u> <u style="text-underline:black">каждом по отдельности будет меньше, а суммарно столько же.</u></span>

<span style="line-height:107%">'''Пример 3 - хранилище:'''</span>
<syntaxhighlight lang="Javascript">// требуется создать блок с id "RFstorage"
TileEntity.registerPrototype(BlockID.RFstorage, {
defaultValues: {
energy: 0 // сохраняемое значение, обозначающее запасенную энергию
},

energyTick: function(type, src) {
this.data.energy += src.storage(Math.min(20, 1000 - this.data.energy), Math.min(20, this.data.energy)); // вызовем функцию хранилища: передаем не более 20 энергии в тик, при этом отдаем так, чтобы энергии не стало меньше 0, а принимаем так, чтобы не было больше 1000
}
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFstorage, energyRedstoneFlux);</syntaxhighlight>

<span style="line-height:107%"><u style="text-underline:black">Для проверки хранилища, можно сначала подзаряжать его от генератора, а потом</u> <u style="text-underline:black">отключать генератор и подключать потребитель, который будет работать от него</u> <u style="text-underline:black">ограниченное время.</u></span>
</div> </div> </div> </div> </div>