InnerCore/Libs/EnergyNet - История изменений

MineExplorer в 00:27, 6 декабря 2021

2021-12-06T00:27:51Z

MineExplorer: удалены лишние переносы строк

2021-12-06T00:17:34Z

удалены лишние переносы строк

MineExplorer в 00:11, 6 декабря 2021

2021-12-06T00:11:28Z

MineExplorer в 00:10, 6 декабря 2021

2021-12-06T00:10:32Z

MineExplorer в 00:03, 6 декабря 2021

2021-12-06T00:03:12Z

MineExplorer в 23:58, 5 декабря 2021

2021-12-05T23:58:38Z

MineExplorer: Обновлена документация под последнюю версию

2021-12-05T23:57:03Z

Обновлена документация под последнюю версию

MineExplorer: обновлены примеры

2021-12-05T23:22:07Z

обновлены примеры

MineExplorer: удалён ненужный код

2021-12-05T23:18:57Z

удалён ненужный код

MineExplorer в 23:09, 5 декабря 2021

2021-12-05T23:09:26Z

@@ Строка 14: / Строка 14: @@
 #''EnergyTypeRegistry'' - модуль для регистрации новых типов энергии
 #''EnergyTileRegistry'' - модуль для привязки типов энергии к TileEntity
-#''EnergyGridBuilder'' - модуль построения энергосетей и взаимодействия с ними
+#''EnergyGridBuilder'' - модуль построения энергосетей
-#''EnergyNet'' - модуль для хранения и получения энергосетей
+#''EnergyNet'' - модуль, хранящий энергосети
 #''EnergyNode'' - базовый класс энергоузла
 #''EnergyGrid'' - класс узла блока-проводника
@@ Строка 89: / Строка 89: @@
 === Генератор ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
 TileEntity.registerPrototype(BlockID.RFgenerator, {
@@ Строка 103: / Строка 105: @@
 === Потребитель ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFconsumer", который будет потреблять энергию для производства алмазов.
 TileEntity.registerPrototype(BlockID.RFconsumer, {

@@ Строка 89: / Строка 89: @@
 === Генератор ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
 TileEntity.registerPrototype(BlockID.RFgenerator, {
@@ Строка 105: / Строка 103: @@
 === Потребитель ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFconsumer", который будет потреблять энергию для производства алмазов.
 TileEntity.registerPrototype(BlockID.RFconsumer, {

@@ Строка 42: / Строка 42: @@
 '''Пример:'''
-<syntaxhighlight lang="JavaScript">// в начале мода импортируем библиотеку (она должна находиться в lib/) importLib("energylib.js", "*");
+<syntaxhighlight lang="JavaScript">// в начале мода импортируем библиотеку (см. выше)
 // создаем тип энергии redstone flux
@@ Строка 89: / Строка 89: @@
 === Генератор ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
 TileEntity.registerPrototype(BlockID.RFgenerator, {
@@ Строка 103: / Строка 105: @@
 === Потребитель ===
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFconsumer", который будет потреблять энергию для производства алмазов.
 TileEntity.registerPrototype(BlockID.RFconsumer, {

@@ Строка 2: / Строка 2: @@
 == Загрузка ==
-Последняя версия (v9) - [https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9 скачать]<br/> Файлы:<br/> energy-net.js&nbsp;- сама библиотека<br/> energy-net.d.ts&nbsp;- заголовочный файл (API)
+Последняя версия (v9) - [https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9 скачать]<br/> Файлы:<br/> energy-net.js - сама библиотека<br/> energy-net.d.ts - заголовочный файл (API)
 == Импорт ==
-Для добавления библиотеки в мод ее файл ''(energy-net.js)''&nbsp;нужно добавить в папку&nbsp;''lib/'' в директории мода (если таковой нету, то ее нужно создать).Для импорта библиотеки в мод в заголовочном файле (или если он отсутствует в первом файле кода) следует добавить строку:
+Для добавления библиотеки в мод ее файл ''(energy-net.js)'' нужно добавить в папку ''lib/'' в директории мода (если таковой нету, то ее нужно создать).Для импорта библиотеки в мод в заголовочном файле (или если он отсутствует в первом файле кода) следует добавить строку:
 <syntaxhighlight lang="JavaScript">IMPORT("EnergyNet");
 </syntaxhighlight>
@@ Строка 15: / Строка 15: @@
 #''EnergyTileRegistry'' - модуль для привязки типов энергии к TileEntity
 #''EnergyGridBuilder'' - модуль построения энергосетей и взаимодействия с ними
-#''EnergyNet ''- модуль для хранения и получения энергосетей
+#''EnergyNet'' - модуль для хранения и получения энергосетей
-#''EnergyNode ''- базовый класс энергоузла
+#''EnergyNode'' - базовый класс энергоузла
-#''EnergyGrid ''- класс узла блока-проводника
+#''EnergyGrid'' - класс узла блока-проводника
 == Механика передачи энергии ==
-Энергия может передаваться как по проводам, так и напрямую от генератора к соседним механизмам. Для этого строится граф (энергосеть), в которым механизмы и блоки-проводники являются узлами.&nbsp;Энергия передаётся пакетами от блока-источника по всем узлам, с которыми он соединён. Каждый пакет&nbsp;имеет определённое количество&nbsp;энергии и напряжение (количество энергии, которое в нём было изначально).
+Энергия может передаваться как по проводам, так и напрямую от генератора к соседним механизмам. Для этого строится граф (энергосеть), в которым механизмы и блоки-проводники являются узлами. Энергия передаётся пакетами от блока-источника по всем узлам, с которыми он соединён. Каждый пакет имеет определённое количество энергии и напряжение (количество энергии, которое в нём было изначально).
 В целях оптимизации провода одного типа, соединенные друг с другом, объединяются в один энергоузел, в то время как каждый блок-механизм имеет свой энергоузел.
@@ Строка 38: / Строка 38: @@
 *<''energyType''>''.name'' - имя данного типа энергии.
 *<''energyType''>''.registerWire(id, value, energyGridClass?)'' – регистрирует провод с данным id. Параметры:
-**''value ''-&nbsp;лимит на размер пакета энергии (напряжение), который блок&nbsp;может проводить. При превышении максимального напряжения размер пакета уменьшается до лимита провода и вызывается функция onOverload в классе провода.
+**''value'' - лимит на размер пакета энергии (напряжение), который блок может проводить. При превышении максимального напряжения размер пакета уменьшается до лимита провода и вызывается функция onOverload в классе провода.
-**''energyGridClass''&nbsp;- опционально, позволяет задать свой класс провода, который должен быть наследован от класса&nbsp;''EnergyGrid''.
+**''energyGridClass'' - опционально, позволяет задать свой класс провода, который должен быть наследован от класса ''EnergyGrid''.
 '''Пример:'''
@@ Строка 52: / Строка 52: @@
 == Привязка типов энергии к TileEntity ==
-''EnergyTileRegistry.addEnergyTypeForId(blockId, energyType)'' - добавляет в tile entity&nbsp;объект класса&nbsp;[[InnerCore/Libs/EnergyNet#Объект_EnergyNode|EnergyNode]], который&nbsp;может быть получен через ''this.energyNode''&nbsp;в функциях tile entity, а так же дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
+''EnergyTileRegistry.addEnergyTypeForId(blockId, energyType)'' - добавляет в tile entity объект класса [[InnerCore/Libs/EnergyNet#Объект_EnergyNode|EnergyNode]], который может быть получен через ''this.energyNode'' в функциях tile entity, а так же дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
-*''blockId&nbsp;''– id блока, на который был зарегистрирован нужный tile entity.
+*''blockId'' – id блока, на который был зарегистрирован нужный tile entity.
 *''energyType'' - тип энергии, который требуется к нему привязать.
 Новые события:
-*''energyTick: function(type, node) { /* … */ }'' - вызывается каждый тик для энергоузла&nbsp;tile entity.<br/> Параметры:
+*''energyTick: function(type, node) { /* … */ }'' - вызывается каждый тик для энергоузла tile entity.<br/> Параметры:
 **''type'' - название типа энергии, для которого вызвано это событие.
-**''node ''- энергоузел механизма, позволяет добавлять энергию
+**''node'' - энергоузел механизма, позволяет добавлять энергию
 *''energyReceive: function(type, amount, voltage) { /* … */ }'' – вызывается при приёме пакета энергии данным tile entity. Должна возвращать количество энергии, которое удалось добавить.<br/> Параметры:
 **''type'' - название типа энергии
 **''amount'' – количество энергии
 **''voltage'' – напряжение энергии
-*''canReceiveEnergy: function(side, type) {return boolean;}'' – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети.&nbsp;По умолчанию возвращает ''true''.
+*''canReceiveEnergy: function(side, type) {return boolean;}'' – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети. По умолчанию возвращает ''true''.
 *''canExtractEnergy: function(side, type) {return boolean;}'' – определяет, с каких сторон tile entity может выдавать энергию. По умолчанию возвращает ''true''.
-*''isConductor': function(type) {return boolean;}'' – определяет, может ли tile entity проводить&nbsp;энергию&nbsp;данного типа.&nbsp;По умолчанию возвращает ''false''.
+*''isConductor': function(type) {return boolean;}'' – определяет, может ли tile entity проводить энергию данного типа. По умолчанию возвращает ''false''.
 == Объект EnergyNode ==
@@ Строка 75: / Строка 75: @@
 *''add(amount, voltage)'' - добавляет в сеть данное кол-во энергии ''(amount)'', возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Если значение ''voltage'' (напряжение) не указано, то оно будет равно ''amount''.
-*''addCoords(x, y, z)&nbsp;''- добавляет блок на координатах x, y, z в список блоков энергоузла (позволяет, например, сделать проводящим энергию блоки обшивки в многоблочном механизме)
+*''addCoords(x, y, z)'' - добавляет блок на координатах x, y, z в список блоков энергоузла (позволяет, например, сделать проводящим энергию блоки обшивки в многоблочном механизме)
-*''removeCoords(x, y, z)''&nbsp;- удаляет блок из энергоузла
+*''removeCoords(x, y, z)'' - удаляет блок из энергоузла
 *''addConnection(node)'' - добавляет выходящее соединение с другим узлом
 *''removeConnection(node) ''- удаляет соединение с узлом
@@ Строка 84: / Строка 84: @@
 == Работа с энергетическими сетями ==
-''EnergyNet.getNodeOnCoords(blockSource, x, y, z)'' – возвращает узел на&nbsp;данных координатах, если он существует. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра.&nbsp;
+''EnergyNet.getNodeOnCoords(blockSource, x, y, z)'' – возвращает узел на данных координатах, если он существует. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра.
 == Примеры ==
@@ Строка 129: / Строка 129: @@
 === Хранилище ===
-Стороны приёма и отправки энергии для хранилища должны быть разделены. Иначе энергия между двумя&nbsp;связанных друг с другом механизмами могут бесконечно обмениваться энергией друг с другом, игнорируя другие tile enity.
+Стороны приёма и отправки энергии для хранилища должны быть разделены. Иначе два хранилища будут бесконечно обмениваться энергией друг с другом, уменьшая количество энергии, отдаваемое другим tile enity.
 <syntaxhighlight lang="JavaScript">//Cоздадим блок с id "RFstorage" и настроим его так, чтобы он отдавал энергию снизу, а принимал сбоку или сверху.
 TileEntity.registerPrototype(BlockID.RFstorage, {

@@ Строка 52: / Строка 52: @@
 == Привязка типов энергии к TileEntity ==
-''EnergyTileRegistry.addEnergyTypeForId(blockId, energyType)'' - добавляет в tile entity&nbsp;объект класса&nbsp;[[EnergyNode|EnergyNode]], который&nbsp;может быть получен через ''this.energyNode''&nbsp;в функциях tile entity, а так же дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
+''EnergyTileRegistry.addEnergyTypeForId(blockId, energyType)'' - добавляет в tile entity&nbsp;объект класса&nbsp;[[InnerCore/Libs/EnergyNet#Объект_EnergyNode|EnergyNode]], который&nbsp;может быть получен через ''this.energyNode''&nbsp;в функциях tile entity, а так же дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
 *''blockId&nbsp;''– id блока, на который был зарегистрирован нужный tile entity.

@@ Строка 88: / Строка 88: @@
 === Генератор ===
 &nbsp;
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
 TileEntity.registerPrototype(BlockID.RFgenerator, {
     canReceiveEnergy: function(){
         return false; // не может получать энергию
     },
     energyTick: function(type, src) {
-        src.addAll(10); // генерирует 10 RF за тик. Так как сразу отдаёт всю энергию, используется более быстрый метод.
+        src.add(10); // генерирует 10 RF за тик.
+    }
 });
@@ Строка 107: / Строка 103: @@
 === Потребитель ===
 &nbsp;
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFconsumer", который будет потреблять энергию для производства алмазов.
@@ Строка 113: / Строка 108: @@
     defaultValues: {
         progress: 0 // сохраняемое значение прогресса работы
     },
     energyReceive: function(type, amount, voltage) {

@@ Строка 1: / Строка 1: @@
-<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 представляет собой инструмент для быстрого создания новых типов энергии и имеет большой функционал для работы с ними.
 == Загрузка ==
 Последняя версия (v9) - [https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9 скачать]<br/> Файлы:<br/> energy-net.js&nbsp;- сама библиотека<br/> energy-net.d.ts&nbsp;- заголовочный файл (API)
-<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
 == Импорт ==
-<div class="mw-parser-output">Для добавления библиотеки в мод ее файл ''(energy-net.js)''&nbsp;нужно добавить в папку&nbsp;''lib/'' в директории мода (если таковой нету, то ее нужно создать).</div> <div class="mw-parser-output">Для импорта библиотеки в мод в заголовочном файле (или если он остутвует в первом файле кода) следует добавить строку:</div> <div class="mw-parser-output"><syntaxhighlight lang="JavaScript">IMPORT("EnergyNet");
 </syntaxhighlight>
-</div> </div> </div> </div>
 == Модули и классы ==
@@ Строка 18: / Строка 18: @@
 #''EnergyNode ''- базовый класс энергоузла
 #''EnergyGrid ''- класс узла блока-проводника
-</div> <div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
 == Механика передачи энергии ==
@@ Строка 34: / Строка 34: @@
 *''value'' - сколько ''Eu'' (единиц энергии ''IndustrialCraft'') содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. ''Энергия Eu принята за эталон.''
-Возвращает функция тип с данным именем (созданный или импортированый), который обладает следующими методами и значениями:
+Возвращает функция тип с данным именем (созданный или импортированный), который обладает следующими методами и значениями:
 *<''energyType''>''.name'' - имя данного типа энергии.
@@ Строка 49: / Строка 49: @@
 energyRF.registerWire(BlockID.RFconduct, 2000);
 </syntaxhighlight>
-</div> </div> </div> </div> </div> </div>
 == Привязка типов энергии к TileEntity ==
@@ Строка 67: / Строка 67: @@
 **''voltage'' – напряжение энергии
 *''isEnergySource: function(type) {return true;}'' – определяет, может ли tile entity вырабатывать энергию данного типа. Если да, то для него строится энергосеть.
-*''canReceiveEnergy: function(side, type) {return true/false;}'' – определяет, может ли tile entity получать энергию даного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети.
+*''canReceiveEnergy: function(side, type) {return true/false;}'' – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети.
 *''canExtractEnergy: function(side, type) {return true/false;}'' – определяет, с каких сторон tile entity может выдавать энергию.
-</div>
 == Объект EnergySource ==
@@ Строка 76: / Строка 76: @@
 *''src.add(amount, voltage)'' - добавляет в сеть данное кол-во энергии ''(amount)'', возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Если значение ''voltage'' (напряжение) не указано, то оно будет равно ''amount''.
 *''src.addAll(amount, voltage)'' - аналогичен методу ''add'', но ничего не возвращает и работает быстрее, потому что добавляет энергию в буфер сети, позволяя объединять в один пакет множество пакетов, созданных генераторами.
-</div> <div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
-== Работа с энегергетическими сетями ==
+== Работа с энергетическими сетями ==
 Большая часть методов из модуля EnergyNetBuilder технические и используются только внутри библиотеки. Однако некоторые из них могут быть полезны и в модах:
@@ Строка 83: / Строка 83: @@
 ''EnergyNetBuilder.rebuildTileNet(объект tile entity)'' – удаляет все энергосети механизма и перестраивает все его соединения с другими сетями. Необходимо вызвать при изменении сторон, через которые tile entity может получать или передавать энергию.
-''EnergyNetBuilder.getNetOnCoords(x, y, z)'' – возвращает сеть, если на данных координатах есть её провод. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра.
+''EnergyNetBuilder.getNetOnCoords(x, y, z)'' – возвращает сеть, если на данных координатах есть её провод. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра. ''EnergyNetBuilder.getNetByBlock(x, y, z, wireId)'' – возвращает сеть, если блок на данных координатах имеет ид, указанное в параметре wireId.
-''EnergyNetBuilder.getNetByBlock(x, y, z, wireId)'' – возвращает сеть, если блок на данных координатах имеет ид, указанное в параметре wireId.</div> </div> </div>
 == Примеры ==
@@ Строка 90: / Строка 90: @@
 &nbsp;
-<syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет выробатывать энергию.
+<syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
 TileEntity.registerPrototype(BlockID.RFgenerator, {
     isEnergySource: function() {
@@ Строка 105: / Строка 105: @@
 // привяжем к этому tile entity наш тип энергии
 EnergyTileRegistry.addEnergyTypeForId(BlockID.RFgenerator, energyRF);</syntaxhighlight>
-<div class="mw-parser-output">
 === Потребитель ===
@@ Строка 129: / Строка 129: @@
 EnergyTileRegistry.addEnergyTypeForId(BlockID.RFconsumer, energyRF);
 </syntaxhighlight>
-</div> <div class="mw-parser-output">
 === Хранилище ===
@@ Строка 148: / Строка 148: @@
     },
     energyReceive: function(type, amount, voltage) {
-        amount = Math.min(amount, 1000); // устанавлимаем максимальное количество энергии, которое может принять механизм равным 1000.
+        amount = Math.min(amount, 1000); // устанавливаем максимальное количество энергии, которое может принять механизм равным 1000.
         var add = Math.min(amount, this.getCapacity() - this.data.energy); // уменьшаем количество энергии, так, чтобы хранилище не переполнялось;
         this.data.energy += add; // добавляем энергию в хранилище
@@ Строка 161: / Строка 161: @@
 // привяжем к этому tile entity наш тип энергии
 EnergyTileRegistry.addEnergyTypeForId(BlockID.RFstorage, energyRF);</syntaxhighlight>