Редактирование:EnergyNet

<div class="mw-parser-output">Данная библиотека для Inner Core представляет собой инструмент для быстрого создания новых типов энергии и имеет большой функционал для работы с ними. <h2> Загрузка </h2>
<p>Последняя версия (v9) - <a href="https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9" alt="https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9" title="https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9">скачать</a><br /> Файлы:<br /> energy-net.js&#160;- сама библиотека<br /> energy-net.d.ts&#160;- заголовочный файл (API)
</p>
<h2> Импорт </h2>
<p>Для добавления библиотеки в мод ее файл <i>(energy-net.js)</i>&#160;нужно добавить в папку&#160;<i>lib/</i> в директории мода (если таковой нету, то ее нужно создать).Для импорта библиотеки в мод в заголовочном файле (или если он отсутствует в первом файле кода) следует добавить строку:
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">IMPORT(&quot;EnergyNet&quot;);
</syntaxhighlight></pre>
</p>
<h2> Модули и классы </h2>
<ol><li><i>EnergyTypeRegistry</i> - модуль для регистрации новых типов энергии </li>
<li><i>EnergyTileRegistry</i> - модуль для привязки типов энергии к TileEntity </li>
<li><i>EnergyGridBuilder</i> - модуль построения энергосетей и взаимодействия с ними </li>
<li><i>EnergyNet </i>- модуль для хранения и получения энергосетей </li>
<li><i>EnergyNode </i>- базовый класс энергоузла </li>
<li><i>EnergyGrid </i>- класс узла блока-проводника </li></ol>
<h2> Механика передачи энергии </h2>
<p>Энергия может передаваться как по проводам, так и напрямую от генератора к соседним механизмам. Для этого строится граф (энергосеть), в которым механизмы и блоки-проводники являются узлами.&#160;Энергия передаётся пакетами от блока-источника по всем узлам, с которыми он соединён. Каждый пакет&#160;имеет определённое количество&#160;энергии и напряжение (количество энергии, которое в нём было изначально).
</p><p>В целях оптимизации провода одного типа, соединенные друг с другом, объединяются в один энергоузел, в то время как каждый блок-механизм имеет свой энергоузел.
</p>
<h2> Создание нового типа энергии </h2>
<p><i>EnergyTypeRegistry.assureEnergyType("name", value)</i> - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
</p><p><u>Параметры:</u>
</p>
<ul><li><i>name</i> - уникальное название энергии, обычно используется сокращение (<i>"Eu" - energy units, "RF" - redstone flux</i> и т.п.) </li>
<li><i>value</i> - сколько <i>Eu</i> (единиц энергии <i>IndustrialCraft</i>) содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. <i>Энергия Eu принята за эталон.</i> </li></ul>
<p>Возвращает функция тип с данным именем (созданный или импортированный), который обладает следующими методами и значениями:
</p>
<ul><li>&lt;<i>energyType</i>&gt;<i>.name</i> - имя данного типа энергии. </li>
<li>&lt;<i>energyType</i>&gt;<i>.registerWire(id, value, energyGridClass?)</i> – регистрирует провод с данным id. Параметры: 
<ul><li><i>value </i>-&#160;лимит на размер пакета энергии (напряжение), который блок&#160;может проводить. При превышении максимального напряжения размер пакета уменьшается до лимита провода и вызывается функция onOverload в классе провода. </li>
<li><i>energyGridClass</i>&#160;- опционально, позволяет задать свой класс провода, который должен быть наследован от класса&#160;<i>EnergyGrid</i>.   </li></ul></li></ul>
<p><b>Пример:</b>
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">// в начале мода импортируем библиотеку (она должна находиться в lib/) importLib(&quot;energylib.js&quot;, &quot;*&quot;);

// создаем тип энергии redstone flux
var energyRF = EnergyTypeRegistry.assureEnergyType(&quot;RF&quot;, 0.25);
// регистрируем блок-проводник для данного типа энергии
energyRF.registerWire(BlockID.RFconduct, 2000);
</syntaxhighlight></pre>
</p>
<h2> Привязка типов энергии к TileEntity </h2>
<p><i>EnergyTileRegistry.addEnergyTypeForId(tileEntityId, energyType)</i> - добавляет tile entity с данным id дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br /> <u>Параметры:</u>
</p>
<ul><li><i>tileEntityId</i> – id блока, на который был зарегистрирован нужный tile entity. </li>
<li><i>energyType</i> - тип энергии, который требуется к нему привязать. </li></ul>
<p>Новые события:
</p>
<ul><li><i>energyTick: function(type, src) { /* … */ }</i> - вызывается каждый тик после функции tick для каждой энергосети, привязанной к данному tile entity.<br /> Параметры: 
<ul><li><i>type</i> - название типа энергии, для которого вызвано это событие. </li>
<li>src - объект типа <a href="InnerCore%2FLibs%2FEnergyNet%23%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%20EnergySource">EnergySource</a> для добавления энергии   </li></ul></li>
<li><i>energyReceive: function(type, amount, voltage) { /* … */ }</i> – вызывается при приёме пакета энергии данным tile entity. Должна возвращать количество энергии, которое удалось добавить.<br /> Параметры: 
<ul><li><i>type</i> - название типа энергии </li>
<li><i>amount</i> – количество энергии </li>
<li><i>voltage</i> – напряжение энергии   </li></ul></li>
<li><i>isEnergySource: function(type) {return true;}</i> – определяет, может ли tile entity вырабатывать энергию данного типа. Если да, то для него строится энергосеть. </li>
<li><i>canReceiveEnergy: function(side, type) {return true/false;}</i> – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети. </li>
<li><i>canExtractEnergy: function(side, type) {return true/false;}</i> – определяет, с каких сторон tile entity может выдавать энергию. </li></ul>
<h2> Объект EnergySource </h2>
<p>Данный объект является интерфейсом для добавления энергии в сеть, который передается в события для работы с энергией (src).<br /> <u>Методы:</u>
</p>
<ul><li><i>src.add(amount, voltage)</i> - добавляет в сеть данное кол-во энергии <i>(amount)</i>, возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Если значение <i>voltage</i> (напряжение) не указано, то оно будет равно <i>amount</i>. </li>
<li><i>src.addAll(amount, voltage)</i> - аналогичен методу <i>add</i>, но ничего не возвращает и работает быстрее, потому что добавляет энергию в буфер сети, позволяя объединять в один пакет множество пакетов, созданных генераторами. </li></ul>
<h2> Работа с энергетическими сетями </h2>
<p>Большая часть методов из модуля EnergyNetBuilder технические и используются только внутри библиотеки. Однако некоторые из них могут быть полезны и в модах:
</p><p><i>EnergyNetBuilder.rebuildTileNet(объект tile entity)</i> – удаляет все энергосети механизма и перестраивает все его соединения с другими сетями. Необходимо вызвать при изменении сторон, через которые tile entity может получать или передавать энергию.
</p><p><i>EnergyNetBuilder.getNetOnCoords(x, y, z)</i> – возвращает сеть, если на данных координатах есть её провод. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра. <i>EnergyNetBuilder.getNetByBlock(x, y, z, wireId)</i> – возвращает сеть, если блок на данных координатах имеет ид, указанное в параметре wireId.
</p>
<h2> Примеры </h2>
<h3> Генератор </h3>
<p>&#160;
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">// Cоздадим блок с id &quot;RFgenerator&quot;, который будет вырабатывать энергию.
TileEntity.registerPrototype(BlockID.RFgenerator, {
    canReceiveEnergy: function(){
        return false; // не может получать энергию
    },
    energyTick: function(type, src) {
        src.add(10); // генерирует 10 RF за тик.
    }
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFgenerator, energyRF);</syntaxhighlight></pre>
</p>
<h3> Потребитель </h3>
<p>&#160;
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">// Cоздадим блок с id &quot;RFconsumer&quot;, который будет потреблять энергию для производства алмазов.
TileEntity.registerPrototype(BlockID.RFconsumer, {
    defaultValues: {
        progress: 0 // сохраняемое значение прогресса работы
    },
    canExtractEnergy: function(side, type) {
        return false; // не может отдавать энергию
    },
    energyReceive: function(type, amount, voltage) {
        this.data.progress += amount; // увеличиваем прогресс производства алмаза.
        return amount; // и возвращаем сколько забрали энергии
    },
    tick: function(){
        if(this.data.progress &gt;= 10000){
            this.data.progress = 0;
            World.drop(this.x, this.y +1, this.z, 264, 1); // дропнуть алмаз на координатах tile entity.
        }
    }
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFconsumer, energyRF);
</syntaxhighlight></pre>
</p>
<h3> Хранилище </h3>
<p>Стороны приёма и отправки энергии для хранилища должны быть разделены. Иначе энергия между двумя&#160;связанных друг с другом механизмами могут бесконечно обмениваться энергией друг с другом, игнорируя другие tile enity.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">//Cоздадим блок с id &quot;RFstorage&quot; и настроим его так, чтобы он отдавал энергию снизу, а принимал сбоку или сверху.
TileEntity.registerPrototype(BlockID.RFstorage, {
    defaultValues: {
        energy: 0 // сохраняемое значение, обозначающее запасенную энергию
    },
    canReceiveEnergy: function(side, type) {
        return side != 0; // side != 0 выведет true, если сторона любая, кроме нижней.
    } ,
    canExtractEnergy: function(side, type) {
        return side == 0; // выведет true при подключении блока для выхода энергии с нижней стороны.
    },
    getCapacity: function(){
        return 2e6; // установим лимит хранилища энергии в 2 миллиона (2e6 - это способ записи числа 2000000)
    },
    energyReceive: function(type, amount, voltage) {
        amount = Math.min(amount, 1000); // устанавливаем максимальное количество энергии, которое может принять механизм равным 1000.
        var add = Math.min(amount, this.getCapacity() - this.data.energy); // уменьшаем количество энергии, так, чтобы хранилище не переполнялось;
        this.data.energy += add; // добавляем энергию в хранилище
        return add; // и возвращаем сколько забрали энергии
    },
    energyTick: function(type, src){
        var output = Math.min(1000, this.data.energy); // определяем, сколько энергии блок может отдать
        this.data.energy += src.add(output) - output; // прибавляем к хранилищу количество энергии, которое осталось после отправки пакета, и вычитаем сколько отправляли.
    },
});

// привяжем к этому tile entity наш тип энергии
EnergyTileRegistry.addEnergyTypeForId(BlockID.RFstorage, energyRF);</syntaxhighlight></pre>
</p></div>
@@ Строка 2: / Строка 2: @@
 == Загрузка ==
-Последняя версия (v9) - [https://github.com/MineExplorer/IC_Libraries/releases/tag/energy-net-v9 скачать]<br/> Файлы:<br/> energy-net.js - сама библиотека<br/> energy-net.d.ts - заголовочный файл (API)
+Последняя версия (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)
 == Импорт ==
-Для добавления библиотеки в мод ее файл ''(energy-net.js)'' нужно добавить в папку ''lib/'' в директории мода (если таковой нету, то ее нужно создать).Для импорта библиотеки в мод в заголовочном файле (или если он отсутствует в первом файле кода) следует добавить строку:
+Для добавления библиотеки в мод ее файл ''(energy-net.js)''&nbsp;нужно добавить в папку&nbsp;''lib/'' в директории мода (если таковой нету, то ее нужно создать).Для импорта библиотеки в мод в заголовочном файле (или если он отсутствует в первом файле кода) следует добавить строку:
 <syntaxhighlight lang="JavaScript">IMPORT("EnergyNet");
 </syntaxhighlight>
@@ Строка 14: / Строка 14: @@
 #''EnergyTypeRegistry'' - модуль для регистрации новых типов энергии
 #''EnergyTileRegistry'' - модуль для привязки типов энергии к TileEntity
-#''EnergyGridBuilder'' - модуль построения энергосетей
+#''EnergyGridBuilder'' - модуль построения энергосетей и взаимодействия с ними
-#''EnergyNet'' - модуль, хранящий энергосети
+#''EnergyNet ''- модуль для хранения и получения энергосетей
-#''EnergyNode'' - базовый класс энергоузла
+#''EnergyNode ''- базовый класс энергоузла
-#''EnergyGrid'' - класс узла блока-проводника
+#''EnergyGrid ''- класс узла блока-проводника
 == Механика передачи энергии ==
-Энергия может передаваться как по проводам, так и напрямую от генератора к соседним механизмам. Для этого строится граф (энергосеть), в которым механизмы и блоки-проводники являются узлами. Энергия передаётся пакетами от блока-источника по всем узлам, с которыми он соединён. Каждый пакет имеет определённое количество энергии и напряжение (количество энергии, которое в нём было изначально).
+Энергия может передаваться как по проводам, так и напрямую от генератора к соседним механизмам. Для этого строится граф (энергосеть), в которым механизмы и блоки-проводники являются узлами.&nbsp;Энергия передаётся пакетами от блока-источника по всем узлам, с которыми он соединён. Каждый пакет&nbsp;имеет определённое количество&nbsp;энергии и напряжение (количество энергии, которое в нём было изначально).
 В целях оптимизации провода одного типа, соединенные друг с другом, объединяются в один энергоузел, в то время как каждый блок-механизм имеет свой энергоузел.
@@ Строка 38: / Строка 38: @@
 *<''energyType''>''.name'' - имя данного типа энергии.
 *<''energyType''>''.registerWire(id, value, energyGridClass?)'' – регистрирует провод с данным id. Параметры:
-**''value'' - лимит на размер пакета энергии (напряжение), который блок может проводить. При превышении максимального напряжения размер пакета уменьшается до лимита провода и вызывается функция onOverload в классе провода.
+**''value ''-&nbsp;лимит на размер пакета энергии (напряжение), который блок&nbsp;может проводить. При превышении максимального напряжения размер пакета уменьшается до лимита провода и вызывается функция onOverload в классе провода.
-**''energyGridClass'' - опционально, позволяет задать свой класс провода, который должен быть наследован от класса ''EnergyGrid''.
+**''energyGridClass''&nbsp;- опционально, позволяет задать свой класс провода, который должен быть наследован от класса&nbsp;''EnergyGrid''.
 '''Пример:'''
-<syntaxhighlight lang="JavaScript">// в начале мода импортируем библиотеку (см. выше)
+<syntaxhighlight lang="JavaScript">// в начале мода импортируем библиотеку (она должна находиться в lib/) importLib("energylib.js", "*");
 // создаем тип энергии redstone flux
@@ Строка 52: / Строка 52: @@
 == Привязка типов энергии к TileEntity ==
-''EnergyTileRegistry.addEnergyTypeForId(blockId, energyType)'' - добавляет в tile entity объект класса [[InnerCore/Libs/EnergyNet#Объект_EnergyNode|EnergyNode]], который может быть получен через ''this.energyNode'' в функциях tile entity, а так же дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
+''EnergyTileRegistry.addEnergyTypeForId(tileEntityId, energyType)'' - добавляет tile entity с данным id дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.<br/> <u>Параметры:</u>
-*''blockId'' – id блока, на который был зарегистрирован нужный tile entity.
+*''tileEntityId'' – id блока, на который был зарегистрирован нужный tile entity.
 *''energyType'' - тип энергии, который требуется к нему привязать.
 Новые события:
-*''energyTick: function(type, node) { /* … */ }'' - вызывается каждый тик для энергоузла tile entity.<br/> Параметры:
+*''energyTick: function(type, src) { /* … */ }'' - вызывается каждый тик после функции tick для каждой энергосети, привязанной к данному tile entity.<br/> Параметры:
 **''type'' - название типа энергии, для которого вызвано это событие.
-**''node'' - энергоузел механизма, позволяет добавлять энергию
+**src - объект типа [[InnerCore/Libs/EnergyNet#Объект_EnergySource|EnergySource]] для добавления энергии
 *''energyReceive: function(type, amount, voltage) { /* … */ }'' – вызывается при приёме пакета энергии данным tile entity. Должна возвращать количество энергии, которое удалось добавить.<br/> Параметры:
 **''type'' - название типа энергии
 **''amount'' – количество энергии
 **''voltage'' – напряжение энергии
-*''canReceiveEnergy: function(side, type) {return boolean;}'' – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети. По умолчанию возвращает ''true''.
+*''isEnergySource: function(type) {return true;}'' – определяет, может ли tile entity вырабатывать энергию данного типа. Если да, то для него строится энергосеть.
-*''canExtractEnergy: function(side, type) {return boolean;}'' – определяет, с каких сторон tile entity может выдавать энергию. По умолчанию возвращает ''true''.
+*''canReceiveEnergy: function(side, type) {return true/false;}'' – определяет, может ли tile entity получать энергию данного типа и с каких сторон. Вызывается при попытке соединения tile entity к энергосети.
-*''isConductor': function(type) {return boolean;}'' – определяет, может ли tile entity проводить энергию данного типа. По умолчанию возвращает ''false''.
+*''canExtractEnergy: function(side, type) {return true/false;}'' – определяет, с каких сторон tile entity может выдавать энергию.
-== Объект EnergyNode ==
+== Объект EnergySource ==
-Данный объект представляет собой узел энергосети.<br/> <u>Основные методы:</u>
+Данный объект является интерфейсом для добавления энергии в сеть, который передается в события для работы с энергией (src).<br/> <u>Методы:</u>
-*''add(amount, voltage)'' - добавляет в сеть данное кол-во энергии ''(amount)'', возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Если значение ''voltage'' (напряжение) не указано, то оно будет равно ''amount''.
+*''src.add(amount, voltage)'' - добавляет в сеть данное кол-во энергии ''(amount)'', возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Если значение ''voltage'' (напряжение) не указано, то оно будет равно ''amount''.
-*''addCoords(x, y, z)'' - добавляет блок на координатах x, y, z в список блоков энергоузла (позволяет, например, сделать проводящим энергию блоки обшивки в многоблочном механизме)
+*''src.addAll(amount, voltage)'' - аналогичен методу ''add'', но ничего не возвращает и работает быстрее, потому что добавляет энергию в буфер сети, позволяя объединять в один пакет множество пакетов, созданных генераторами.
-*''removeCoords(x, y, z)'' - удаляет блок из энергоузла
-*''addConnection(node)'' - добавляет выходящее соединение с другим узлом
-*''removeConnection(node) ''- удаляет соединение с узлом
-*''resetConnections()'' - удаляет все соединения с другими узлами
-*''destroy()'' - удаляет энергоузел.
 == Работа с энергетическими сетями ==
-''EnergyNet.getNodeOnCoords(blockSource, x, y, z)'' – возвращает узел на данных координатах, если он существует. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра.
+Большая часть методов из модуля EnergyNetBuilder технические и используются только внутри библиотеки. Однако некоторые из них могут быть полезны и в модах:
+''EnergyNetBuilder.rebuildTileNet(объект tile entity)'' – удаляет все энергосети механизма и перестраивает все его соединения с другими сетями. Необходимо вызвать при изменении сторон, через которые tile entity может получать или передавать энергию.
+''EnergyNetBuilder.getNetOnCoords(x, y, z)'' – возвращает сеть, если на данных координатах есть её провод. Используется в IndustrialCraft для нанесения урона от оголённых проводов и для мультиметра. ''EnergyNetBuilder.getNetByBlock(x, y, z, wireId)'' – возвращает сеть, если блок на данных координатах имеет ид, указанное в параметре wireId.
 == Примеры ==
 === Генератор ===
 &nbsp;
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFgenerator", который будет вырабатывать энергию.
@@ Строка 105: / Строка 103: @@
 === Потребитель ===
 &nbsp;
 <syntaxhighlight lang="JavaScript">// Cоздадим блок с id "RFconsumer", который будет потреблять энергию для производства алмазов.
@@ Строка 133: / Строка 130: @@
 === Хранилище ===
-Стороны приёма и отправки энергии для хранилища должны быть разделены. Иначе два хранилища будут бесконечно обмениваться энергией друг с другом, уменьшая количество энергии, отдаваемое другим tile enity.
+Стороны приёма и отправки энергии для хранилища должны быть разделены. Иначе энергия между двумя&nbsp;связанных друг с другом механизмами могут бесконечно обмениваться энергией друг с другом, игнорируя другие tile enity.
 <syntaxhighlight lang="JavaScript">//Cоздадим блок с id "RFstorage" и настроим его так, чтобы он отдавал энергию снизу, а принимал сбоку или сверху.
 TileEntity.registerPrototype(BlockID.RFstorage, {