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"><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"><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;Библиотека, предоставляющая универсальные типы инструментов и упрощающая создание инструментов.
-ToolAPI - API позваляющий&nbsp;регистрировать инструменты.<br/> ToolLib -&nbsp;Библиотека, предоставляющая универсальные типы инструментов и содержащая несколько вспомогательных методов для работы с инструментами и блоками.
 == Загрузка ==
@@ Строка 26: / Строка 24: @@
 | style="width: 100px; text-align: center;" | 11.07.20
 |}
-<div class="mw-parser-output">
 == <br/> Документация ==
@@ Строка 36: / Строка 34: @@
 После этого вам станет доступен весь функционал библиотеки.
-<div class="mw-parser-output">
 === Добавление инструмента ===
@@ Строка 45: / Строка 42: @@
 Так же вместо названия материала может напрямую быть передан объект с его свойствами.
-Для регистрации нового материала инструментов используется метод&nbsp;ToolAPI.addToolMaterial(toolMaterial, params)
+Материалы инструментов регистрируются методом&nbsp;ToolAPI.addToolMaterial(toolMaterial, params), но библиотека добавляет поддержку свойства зачаровываемости.
 <syntaxhighlight lang="JavaScript">ToolAPI.addToolMaterial("dirt", {
-    durability: 15, // Прочность (Сколько блоков можно сломать)
+    durability: 15, // Прочность (сколько блоков можно сломать)
     level: 1, // Уровень инструмента - определяет, какие блоки инструмент может добыть.
     efficiency: 10, // Эффективность - модификатор скорости ломания блока
@@ Строка 54: / Строка 51: @@
 });
 </syntaxhighlight>
-<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">&nbsp;</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>
-<div class="mw-parser-output"><div class="mw-parser-output">
-=== Регистрация блоков ===
-Для регистрации блока используется метод&nbsp;ToolAPI.registerBlockMaterial(BlockID, blockMaterial, level);<br/> ''blockMaterial ''- материал блока.<br/> ''level ''- уровень добычи
+=== Уровни добычи ===
-Уровни добычи блоков можно задавать числами или используя константы из списка MiningLevel, добавляемого библиотекой:
+Библиотека позволяет вместо чисел использовать константы для уровней блоков и инструментов:
 MiningLevel.STONE&nbsp;=&nbsp;1 - камень<br/> MiningLevel.IRON&nbsp;=&nbsp;2 - железная руда<br/> MiningLevel.DIAMOND&nbsp;=&nbsp;3 - алмазная руда<br/> MiningLevel.OBSIDIAN&nbsp;=&nbsp;4 - обсидиан
-Пример:
+=== Стандартные типы инструментов ===
-<syntaxhighlight lang="JavaScript">ToolAPI.registerBlockMaterial(BlockID.myBlock, "stone", 1);
-ToolAPI.registerBlockMaterial(BlockID.myBlock2, "stone", MiningLevel.STONE);
-</syntaxhighlight>
-По умолчанию доступны следующие материалы:<br/> "stone" - каменные блоки,<br/> "wood" - деревянные,<br/> "dirt" - земляные,<br/> "plant" - растения,<br/> "fibre" - паутина,<br/> "unbreaking" - неломаемые
+ToolType.sword - меч<br/> ToolType.shovel - лопата<br/> ToolType.pickaxe - кирка<br/> ToolType.axe - топор<br/> ToolType.hoe - мотыга
-Для регистрации материала блока используется метод&nbsp;ToolAPI.addBlockMaterial(blockMaterial, breakingMultiplier);<br/> ''blockMaterial ''- название материала.<br/> ''breakingMultiplier ''- модификатор времени ломания блока при добыче без подходящего инструмента.
+=== Создание своего типа инструментов ===
-Пример:
+Тип инструмента - это объект, содержащий свойства&nbsp;и функции&nbsp;инструмента. Библиотека поддерживает все параметры инструмента, указываемые&nbsp;ToolAPI.registerTool, а также добавляет новые.&nbsp;
-<syntaxhighlight lang="JavaScript">ToolAPI.addBlockMaterial("test", 3);</syntaxhighlight>
-</div> </div>
-=== Типы инструментов ===
-Cтандартные типы:
-ToolType.sword - меч<br/> ToolType.shovel - лопата<br/> ToolType.pickaxe - кирка<br/> ToolType.axe - топор<br/> ToolType.hoe - мотыга
-Создание своего типа инструментов
 <syntaxhighlight lang="JavaScript">ToolType.myType = {
     enchantType: Native.EnchantType.pickaxe, //Тип чар для инструмента
     damage: 2, // Базовый урон инструмента
     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>
-</div> </div> </div> </div>
 === Все методы ===
 // Скоро будут добавлены
-</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>
+</div> </div> </div> </div>