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

128.73.195.44 в 17:44, 29 мая 2020

2020-05-29T17:44:06Z

Admin: Откат правок 117.141.15.115 (обсуждение) к версии 80LK

2019-11-26T15:37:49Z

Откат правок 117.141.15.115 (обсуждение) к версии 80LK

117.141.15.115 в 11:36, 7 ноября 2019

2019-11-07T11:36:50Z

80LK в 11:20, 27 июля 2019

2019-07-27T11:20:02Z

Admin в 18:02, 12 декабря 2018

2018-12-12T18:02:38Z

Admin: Новая страница: «
Данная библиотека для Core Engine представл…»

2018-12-12T14:57:35Z

Новая страница: «<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"> Данная библиотека для Core Engine представл…»

Новая страница

<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
Данная библиотека для Core Engine представляет собой инструмент для быстрого создания новых типов энергии и работы с ними.  

== Импорт ==

Для добавления библиотеки в мод ее файл (''energylib.js'') нужно добавить в директорию ''lib/'' в директории мода (если таковой нету, то ее нужно создать).

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

= Модули =

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

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

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

Параметры:

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

•value - сколько Eu (единиц энергии industrial craft) содержится в 1 единице данного типа энергии, данное значение используется для конвертации из одного вида энергии в другой. Энергия Eu принята за эталон.

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

*<energyType>.name - имя данного типа энергии.
*<energyType>.getWireSpecialType() - возвращает специальный тип блока, который будет являться проводником данного типа энергии.

'''Пример:'''

 
<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 можно привязать несколько разных типов энергии.

Параметры:

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

Новыесобытия:

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

*type - название типа энергии, для которого вызвано это событие
*src - объект типа energy source для работы с энергией, о нем речь пойдет позже.

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

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

= Механика энергии =

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

= Объект EnergySource =

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

Методы:

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

•src.storage(receive, retreive) - данный метод является функцией хранилищ энергии. Как параметры принимает то, сколько энергии он максимально может принять (reveive) и сколько максимально может отдать (retreive) за данный тик. Возвращает изменение энергии (отрицательное, если энергия была отдана, положительное, если принята).  

'''Пример 1 - генератор:'''
<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>

 

'' ''

'''Пример 2 - потребитель:'''
<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>

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

'''Пример 3 - хранилище:'''
<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>

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

@@ Строка 16: / Строка 16: @@
 #''EnergyTileRegistry - ''модуль для привязки типов энергии к Tile Entity.
-<div class="mw-parser-output"><h1> Создание новых типов энергии </h1><p><i>EnergyTypeRegistry.assureEnergyType("name", value)</i> - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
+= Создание новых типов энергии =
-// создаем тип энергии redstone flux var energyRedstoneFlux = EnergyTypeRegistry.assureEnergyType(&quot;RF&quot;, 0.25);
+''EnergyTypeRegistry.assureEnergyType("name", value)'' - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
 // создаем блок-проводник для данного типа энергии
-IDRegistry.genBlockID(&quot;RFconduct&quot;);
+IDRegistry.genBlockID("RFconduct");
-Block.createBlock(&quot;RFconduct&quot;, [
+Block.createBlock("RFconduct", [
-{name: &quot;RF Conduct&quot;, texture: [[&quot;rf_conduct&quot;, 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода  ], energyRestroneFlux.getWireSpecialType()); </syntaxhighlight></pre>
+{name: "RF Conduct", texture: [["rf_conduct", 0]], inCreative: true} // текстура images/terrain-atlas/rf_conduct_0.png должна находиться в ресурсах мода  ], energyRestroneFlux.getWireSpecialType()); </syntaxhighlight>
-</p><p>&#160;
-</p></div>
+&nbsp;
 = Привязка типов энергии к&nbsp;TileEntity =

@@ Строка 16: / Строка 16: @@
 #''EnergyTileRegistry - ''модуль для привязки типов энергии к Tile Entity.
-= Создание новых типов энергии =
+<div class="mw-parser-output"><h1> Создание новых типов энергии </h1><p><i>EnergyTypeRegistry.assureEnergyType("name", value)</i> - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
-''EnergyTypeRegistry.assureEnergyType("name", value)'' - создает новый тип энергии и возвращает его, если такой тип энергии уже существует, новый создан не будет, а вернется уже существующий, таким образом если 2 мода создают один тип энергии, он будет общий.
+// создаем тип энергии redstone flux var energyRedstoneFlux = EnergyTypeRegistry.assureEnergyType(&quot;RF&quot;, 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 =

@@ Строка 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">
 Данная библиотека для Core Engine представляет собой инструмент для быстрого создания новых типов энергии и работы с ними. &nbsp;
@@ Строка 133: / Строка 135: @@
 <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> </div> </div> </div> </div>

@@ Строка 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">
 Данная библиотека для Core Engine представляет собой инструмент для быстрого создания новых типов энергии и работы с ними. &nbsp;
-== Импорт ==
+== Подключение ==
-Для добавления библиотеки в мод ее файл (''energylib.js'') нужно добавить в директорию ''lib/'' в директории мода (если таковой нету, то ее нужно создать).
+Для добавления библиотеки в мод ее файл ([https://github.com/MineExplorer/IndustrialCraft_2/blob/master/IndustrialCraft²/lib/energylib.js ''energylib.js'']) нужно добавить в директорию ''lib/'' в директории мода (если таковой нету, то ее нужно создать).
 Для импорта библиотеки в мод в заголовочном файле (или если он остутвует в первом файле кода) следует добавить строку ''importLib("energylib.js", "*") .''
@@ Строка 30: / Строка 30: @@
 <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", "*");
@@ Строка 135: / Строка 133: @@
 <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> </div> </div>

@@ Строка 65: / Строка 65: @@
 isGenerator: function() {return true;} - данный метод нужно только если tile entity в основном генерирует энергию, а не забирает ее (является генератором), нужна для более точного расчёта.
 = Механика энергии =
-Несколько tile entity поддерживающих одинаковый тип энергии и соединенные нужным проводником объединяются в энергетическую сеть. Tile entity имеют возможность забирать энергию из сети и передавать ее туда, при этом вся переданная энергия распределяется равномерно по потребителям.
+Несколько tile entity поддерживающих одинаковый тип энергии и соединенные подходящим проводником объединяются в энергетическую сеть. Tile entity имеют возможность забирать энергию из сети и передавать ее туда, при этом вся переданная энергия распределяется равномерно по потребителям.
 = Объект EnergySource =