ToolLib — различия между версиями

Текущая версия на 00:23, 6 декабря 2021

ToolLib - Библиотека, предоставляющая универсальные типы инструментов и упрощающая создание инструментов.

Содержание

1 Загрузка
2 Документация

Загрузка[править]

Версия	Скачать	Изменения	Дата выхода
23	Скачать	- Поддержка мультиплеера	27.12.20
22	-	- Топоры могут делать обтёсанную древесину - Исправления ошибок	24.08.20
21	-	- Добавлен enum MiningLevel	11.07.20

Документация[править]

Подключение[править]

Чтобы подключить библиотеку, необходимо расположить файл библиотеки в папку lib в корне мода написать следующее в начале вашего кода:

IMPORT("ToolLib");

После этого вам станет доступен весь функционал библиотеки.

Добавление инструмента[править]

Для регистрации инструмента используется метод ToolLib.setTool(ItemID, toolMaterial, toolType)

ToolLib.setTool(ItemID.myTool, "wood", ToolType.axe);

Так же вместо названия материала может напрямую быть передан объект с его свойствами.

Материалы инструментов регистрируются методом ToolAPI.addToolMaterial(toolMaterial, params), но библиотека добавляет поддержку свойства зачаровываемости.

ToolAPI.addToolMaterial("dirt", {
    durability: 15, // Прочность (сколько блоков можно сломать)
    level: 1, // Уровень инструмента - определяет, какие блоки инструмент может добыть.
    efficiency: 10, // Эффективность - модификатор скорости ломания блока
    damage: 1, // Увеличение базового урона инструмента данным материалом
    enchantability: 14 // Зачаровываемость, чем выше, тем более хорошие чары будут при зачаровании
});

Уровни добычи[править]

Библиотека позволяет вместо чисел использовать константы для уровней блоков и инструментов:

MiningLevel.STONE = 1 - камень
MiningLevel.IRON = 2 - железная руда
MiningLevel.DIAMOND = 3 - алмазная руда
MiningLevel.OBSIDIAN = 4 - обсидиан

Стандартные типы инструментов[править]

ToolType.sword - меч
ToolType.shovel - лопата
ToolType.pickaxe - кирка
ToolType.axe - топор
ToolType.hoe - мотыга

Создание своего типа инструментов[править]

Тип инструмента - это объект, содержащий свойства и функции инструмента. Библиотека поддерживает все параметры инструмента, указываемые ToolAPI.registerTool, а также добавляет новые.

ToolType.myType = {
    enchantType: Native.EnchantType.pickaxe, //Тип чар для инструмента
    damage: 2, // Базовый урон инструмента
    blockTypes: ["dirt", "stone", "test"], // Материалы блоков, которые может ломать инструмент
    useItem: function(coords, item, block, player) { // Функция клика по блоку
        if (item.data > 0) {
            Entity.setCarriedItem(player, item.id, 1, item.data - 1, item.extra); // Починить инструмент на 1
        }
    }
}

Все методы[править]

// Скоро будут добавлены

@@ Строка 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"><div class="mw-parser-output">ToolLib -&nbsp;Библиотека, предоставляющая универсальные типы инструментов и упрощающая создание инструментов.
-<u>'''''Ожидает заполнения, Волк там где-то спит, скоро закончит.'''''</u><br/> ToolAPI - API позваляющая регистрировать инструменты.<br/> ToolType -&nbsp;Библиотека, предоставляющая универсальные типы инструментов и содержащая некоторые доработки и фиксы ошибок в ToolAPI.
+== Загрузка ==
-{| border="1" cellpadding="1" cellspacing="1" style="width: 223px;"
+{| border="1" cellpadding="1" cellspacing="1" style="width: 579px;"
 |-
-| style="width: 83px; text-align: center;" | '''Версия'''
+| style="width: 68px; text-align: center;" | '''Версия'''
-| style="width: 127px; text-align: center;" | '''Скачать'''
+| style="width: 81px; text-align: center;" | '''Скачать'''
+| style="width: 305px; text-align: center;" | '''Изменения'''
+| style="width: 100px; text-align: center;" | '''Дата выхода'''
 |-
-| style="width: 83px; text-align: center;" | '''3'''
+| style="width: 68px; text-align: center;" | '''23'''
-| style="width: 127px; text-align: center;" | [https://vk.com/doc-80513593_486896691 Скачать]
+| style="width: 81px; text-align: center;" | [https://github.com/MineExplorer/IC_Libraries/releases/tag/toollib-v23 Скачать]
+| style="width: 305px;" | - Поддержка мультиплеера
+| style="width: 100px; text-align: center;" | 27.12.20
+|-
+| style="width: 68px; text-align: center;" | '''22'''
+| style="width: 81px; text-align: center;" | -
+| style="width: 305px;" | - Топоры могут делать обтёсанную древесину<br/> -&nbsp;Исправления ошибок
+| style="width: 100px; text-align: center;" | 24.08.20
+|-
+| style="width: 68px; text-align: center;" | '''21'''
+| style="width: 81px; text-align: center;" | -
+| style="width: 305px;" | - Добавлен enum&nbsp;MiningLevel
+| style="width: 100px; text-align: center;" | 11.07.20
 |}
-&nbsp;
+== <br/> Документация ==
-== Документация ==
 === Подключение ===
 Чтобы подключить библиотеку, необходимо расположить файл библиотеки в папку lib в корне мода&nbsp;написать следующее в начале вашего кода:
-<syntaxhighlight lang="JavaScript">IMPORT("ToolType");</syntaxhighlight>
+<syntaxhighlight lang="JavaScript">IMPORT("ToolLib");</syntaxhighlight>
 После этого вам станет доступен весь функционал библиотеки.
-=== Основные команды ===
+=== Добавление инструмента ===
+Для регистрации инструмента используется метод ToolLib.setTool(ItemID, toolMaterial, toolType)
+<syntaxhighlight lang="JavaScript">ToolLib.setTool(ItemID.myTool, "wood", ToolType.axe);
+</syntaxhighlight>
-Для регистрации инструмента используется метод ToolAPI.setTool(ItemID, materialTool, toolType)
+Так же вместо названия материала может напрямую быть передан объект с его свойствами.
-<syntaxhighlight lang="JavaScript">ToolAPI.setTool(ItemID["myTool"], "wood", ToolType.axe);</syntaxhighlight>
-Для регистрации нового материала инструментов используется метод&nbsp;ToolAPI.addToolMaterial(materialTool, params)
+Материалы инструментов регистрируются методом&nbsp;ToolAPI.addToolMaterial(toolMaterial, params), но библиотека добавляет поддержку свойства зачаровываемости.
 <syntaxhighlight lang="JavaScript">ToolAPI.addToolMaterial("dirt", {
-    durability: 3,//Долговечность(Сколько блоков можно сломать)
+    durability: 15, // Прочность (сколько блоков можно сломать)
-    level: 1,//Уровень инструмента, влияет на блоки которые инструмент может ломать
+    level: 1, // Уровень инструмента - определяет, какие блоки инструмент может добыть.
-    efficiency: 10,//Эффективность, чем больше эффективность, тем быстрее ломается нужный блок
+    efficiency: 10, // Эффективность - модификатор скорости ломания блока
-    damage: 1,//Урон наносимый инструментами данного материала
+    damage: 1, // Увеличение базового урона инструмента данным материалом
-    enchantability: 14
+    enchantability: 14 // Зачаровываемость, чем выше, тем более хорошие чары будут при зачаровании
-});</syntaxhighlight>
+});
+</syntaxhighlight>
+=== Уровни добычи ===
+Библиотека позволяет вместо чисел использовать константы для уровней блоков и инструментов:
+MiningLevel.STONE&nbsp;=&nbsp;1 - камень<br/> MiningLevel.IRON&nbsp;=&nbsp;2 - железная руда<br/> MiningLevel.DIAMOND&nbsp;=&nbsp;3 - алмазная руда<br/> MiningLevel.OBSIDIAN&nbsp;=&nbsp;4 - обсидиан
-Для регистрации блока используется метод&nbsp;ToolAPI.registerBlockMaterial(BlockID, materialBlock, level);
+=== Стандартные типы инструментов ===
-<syntaxhighlight lang="JavaScript">ToolAPI.registerBlockMaterial(BlockID["myBlock"], "stone", 1);</syntaxhighlight>
-Для регистрации материала блока используется метод&nbsp;ToolAPI.addBlockMaterial(materialBlock, breakingMultiplier);
+ToolType.sword - меч<br/> ToolType.shovel - лопата<br/> ToolType.pickaxe - кирка<br/> ToolType.axe - топор<br/> ToolType.hoe - мотыга
-<syntaxhighlight lang="JavaScript">ToolAPI.addBlockMaterial("test", 3);</syntaxhighlight>
-=== Создание своего типа инструмента ===
+=== Создание своего типа инструментов ===
-&nbsp;
+Тип инструмента - это объект, содержащий свойства&nbsp;и функции&nbsp;инструмента. Библиотека поддерживает все параметры инструмента, указываемые&nbsp;ToolAPI.registerTool, а также добавляет новые.&nbsp;
 <syntaxhighlight lang="JavaScript">ToolType.myType = {
-    enchantType: Native.EnchantType.pickaxe,//ТИп чар для инстумента
+    enchantType: Native.EnchantType.pickaxe, //Тип чар для инструмента
-    damage: 2,//Урон инструмента
+    damage: 2, // Базовый урон инструмента
-    blockTypes: ["dirt", "stone", "test"], //Материалы блоков, которые может ломать инструмент
+    blockTypes: ["dirt", "stone", "test"], // Материалы блоков, которые может ломать инструмент
-    onAttack: function(item){
+    useItem: function(coords, item, block, player) { // Функция клика по блоку
-        if(item.data > Item.getMaxDamage(item.id)){
+        if (item.data > 0) {
-            item.id = item.data = item.count = 0;
+            Entity.setCarriedItem(player, item.id, 1, item.data - 1, item.extra); // Починить инструмент на 1
         }
     }
-}</syntaxhighlight>
+} </syntaxhighlight>
+=== Все методы ===
-&nbsp;
+// Скоро будут добавлены
-</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>
+</div> </div> </div> </div>