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

<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"><p><span style="font-size:large;"><b>!Поддержка библиотеки прекращена, используйте <a href="InnerCore%2FLibs%2FEnergyNet">EnergyNet</a>!</b></span>
</p><p>Данная библиотека для Core Engine представляет собой инструмент для быстрого создания новых типов энергии и работы с ними. &#160;
</p>
<h2> Подключение </h2>
<p>Для добавления библиотеки в мод ее файл (<a href="https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/energylib.js" alt="https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/energylib.js" title="https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/energylib.js"><i>energylib.js</i></a>) нужно добавить в директорию <i>lib/</i> в директории мода (если таковой нету, то ее нужно создать).
</p><p>Для импорта библиотеки в мод в заголовочном файле (или если он остутвует в первом файле кода) следует добавить строку <i>importLib("energylib.js", "*") .</i>
</p>
<h1> Модули </h1>
<ol><li><i>EnergyLibCore</i> - модуль для технической работы с библиотекой, осуществляет доступ к объекту ее конфигурации.<b> </b></li>
<li><i>EnergyTypeRegistry - </i>модуль для регистрации новых типов энергии. </li>
<li><i>EnergyTileRegistry - </i>модуль для привязки типов энергии к Tile Entity. </li></ol>
<div class="mw-parser-output"><h1> Создание новых типов энергии </h1><p><i>EnergyTypeRegistry.assureEnergyType("name", value)</i> - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
</p><p><span style="line-height:107%"><u style="text-underline:black">Параметры:</u></span>
</p>
<ul><li>name - уникальное название энергии, обычно используется сокращение ("Eu" - energy units, "RF" - redstone flux и т.п.) </li></ul>
<p><span style="line-height:108%"><span style="font-family:">•</span></span>value - сколько Eu (единиц энергии industrial craft) содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. Энергия Eu принята за эталон.
</p><p>Возвращает функция тип с данным именем (созданный или импортированый), который обладает следующими методами и значениями:
</p>
<ul><li>&lt;energyType&gt;.name - имя данного типа энергии. </li>
<li><span style="line-height:109%">&lt;energyType&gt;.<span style="font-size:11.0pt"><span style="line-height:109%">getWireSpecialType() - возвращает специальный тип блока, который будет являться проводником данного типа энергии.</span></span></span> </li></ul>
<p><span style="line-height:107%"><b><span style="font-size:11.0pt"><span style="line-height:107%">Пример:</span></span></b></span>
<pre class="fck_mw_syntaxhighlight">&lt;syntaxhighlight lang=&quot;Javascript&quot;&gt;// в начале мода импортируем библиотеку (она должна находиться в lib/)
importLib(&amp;quot;energylib.js&amp;quot;, &amp;quot;*&amp;quot;);

// создаем тип энергии redstone flux var energyRedstoneFlux = EnergyTypeRegistry.assureEnergyType(&amp;quot;RF&amp;quot;, 0.25);
// создаем блок-проводник для данного типа энергии
IDRegistry.genBlockID(&amp;quot;RFconduct&amp;quot;);
Block.createBlock(&amp;quot;RFconduct&amp;quot;, [
{name: &amp;quot;RF Conduct&amp;quot;, texture: [[&amp;quot;rf_conduct&amp;quot;, 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода&#160; ], energyRestroneFlux.getWireSpecialType());&#160;&lt;/syntaxhighlight&gt;</pre>
</p><p>&#160;
</p></div>
<h1> Привязка типов энергии к&#160;TileEntity </h1>
<p>Для того, чтобы привязать тип энергии к tile entity используется метод
</p><p><i>EnergyTileRegistry.addEnergyTypeForId(tileEntityId, energyType)</i> - добавляет tile entity&#160; с данным id дополнительные события, которые позволяют ему работать с данным типом энергии. К одному tile entity можно привязать несколько разных типов энергии.
</p><p><span style="line-height:107%"><u style="text-underline:black">Параметры:</u></span>
</p>
<ul><li>tileEntityId – id блока, на который был зарегистрирован нужный tile entity. </li>
<li>energyType - тип энергии, который требуется к нему привязать. </li></ul>
<p><span style="line-height:107%"><u style="text-underline:black">Новые</u><u style="text-underline:black">события</u><u style="text-underline:black">:</u></span>
</p><p>energyTick: function(type, src) { /* … */ } - вызывается каждый тик для каждого типа энергии, привязанного к данному tile entity. Параметры:
</p>
<ul><li>type - название типа энергии, для которого вызвано это событие </li>
<li><span style="line-height:107%">src - объект типа energy source для работы с энергией, о нем речь пойдет позже.</span> </li></ul>
<p>energyReceive: function(type, src) { /* … */ } - аналогична energyTick, но вызывается только если в сети есть энергия.
</p><p>isGenerator: function() {return true;} - данный метод нужно только если tile entity в основном генерирует энергию, а не забирает ее (является генератором), нужна для более точного расчёта.
</p>
<div class="mw-parser-output">
<h1> Механика энергии </h1>
<p>Несколько tile entity поддерживающих одинаковый тип энергии и соединенные подходящим проводником объединяются в энергетическую сеть. Tile entity имеют возможность забирать энергию из сети и передавать ее туда, при этом вся переданная энергия распределяется равномерно по потребителям.
</p>
</div>
<h1> Объект EnergySource </h1>
<p>Данный объект является интерфейсом для работы с энергией в сети, который передается в события для работы с энергией (src).
</p><p><span style="line-height:107%"><u style="text-underline:black">Методы:</u></span>
</p>
<ul><li>src.add(amount) - добавляет в сеть данное кол-во энергии (amount), возвращает, какое кол-во энергии добавить не удалось из-за переполнения (0, если вся энергия добавлена). Обычно данный метод используется в генераторах. &#160; </li>
<li>src.get(amount) - забирает из сети данное кол-во энергии (amount), возвращает, какое кол-во энергии удалось забрать. </li>
<li>src.getAll(amount) - аналогичен методу get, но игнорирует равномерное распределение по всем tile entity в сети, в большинстве случаев лучше использовать get. </li>
<li>src.free() - возвращает, сколько в сети есть свободного места для энергии. </li>
<li>src.amount() - возвращает, сколько энергии есть в сети. </li></ul>
<p><span style="line-height:108%"><span style="font-family:">•</span></span>src.storage(receive, retreive) - данный метод является функцией хранилищ энергии. Как параметры принимает то, сколько энергии он максимально может принять (reveive) и сколько максимально может отдать (retreive) за данный тик. Возвращает изменение энергии (отрицательное, если энергия была отдана, положительное, если принята). &#160;
</p><p><span style="line-height:107%"><b>Пример 1 - генератор:</b></span>
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">// требуется создать блок с id &quot;RFgenerator&quot;
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></pre>
</p><p>&#160;
</p><p><span style="line-height:107%"><i>&#160;</i></span>
</p><p><span style="line-height:107%"><b>Пример 2 - потребитель:</b></span>
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">// требуется создать блок с id &quot;RFconsumer&quot;
TileEntity.registerPrototype(BlockID.RFconsumer, {
    energyTick: function(type, src) {
        var energy = Math.floor(src.get(10)); // получить от 0 до 10 энергии, Math.floor используется в данном случае для устранения ошибки вычислений, в большинстве случаев это не нужно
        for (var i = 0; i &lt; 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></pre>
</p><p><span style="line-height:107%"><i>&#160;</i></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>
</p><p><span style="line-height:107%"><b>Пример 3 - хранилище:</b></span>
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">// требуется создать блок с id &quot;RFstorage&quot;
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></pre>
</p><p><span style="line-height:107%"><u style="text-underline:black">Для проверки хранилища, можно сначала подзаряжать его от генератора, а потом</u> <u style="text-underline:black">отключать генератор и подключать потребитель, который будет работать от него</u> <u style="text-underline:black">ограниченное время.</u></span>
</p>
</div> </div> </div> </div> </div>
</div>
@@ Строка 16: / Строка 16: @@
 #''EnergyTileRegistry - ''модуль для привязки типов энергии к Tile Entity.
-= Создание новых типов энергии =
+<div class="mw-parser-output"><h1> Создание новых типов энергии </h1><p><i>EnergyTypeRegistry.assureEnergyType("name", value)</i> - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
+</p><p><span style="line-height:107%"><u style="text-underline:black">Параметры:</u></span>
+</p>
+<ul><li>name - уникальное название энергии, обычно используется сокращение ("Eu" - energy units, "RF" - redstone flux и т.п.) </li></ul>
+<p><span style="line-height:108%"><span style="font-family:">•</span></span>value - сколько Eu (единиц энергии industrial craft) содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. Энергия Eu принята за эталон.
+</p><p>Возвращает функция тип с данным именем (созданный или импортированый), который обладает следующими методами и значениями:
+</p>
+<ul><li>&lt;energyType&gt;.name - имя данного типа энергии. </li>
+<li><span style="line-height:109%">&lt;energyType&gt;.<span style="font-size:11.0pt"><span style="line-height:109%">getWireSpecialType() - возвращает специальный тип блока, который будет являться проводником данного типа энергии.</span></span></span> </li></ul>
+<p><span style="line-height:107%"><b><span style="font-size:11.0pt"><span style="line-height:107%">Пример:</span></span></b></span>
+<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">// в начале мода импортируем библиотеку (она должна находиться в lib/)
+importLib(&quot;energylib.js&quot;, &quot;*&quot;);
-''EnergyTypeRegistry.assureEnergyType("name", value)'' - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
+// создаем тип энергии redstone flux var energyRedstoneFlux = EnergyTypeRegistry.assureEnergyType(&quot;RF&quot;, 0.25);
-<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");
+IDRegistry.genBlockID(&quot;RFconduct&quot;);
-Block.createBlock("RFconduct", [
+Block.createBlock(&quot;RFconduct&quot;, [
-{name: "RF Conduct", texture: [["rf_conduct", 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода  ], energyRestroneFlux.getWireSpecialType()); </syntaxhighlight>
+{name: &quot;RF Conduct&quot;, texture: [[&quot;rf_conduct&quot;, 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода  ], energyRestroneFlux.getWireSpecialType()); </syntaxhighlight></pre>
+</p><p>&#160;
-&nbsp;
+</p></div>
 = Привязка типов энергии к&nbsp;TileEntity =