StructuresAPI — различия между версиями
80LK (обсуждение | вклад) м |
80LK (обсуждение | вклад) м |
||
| Строка 102: | Строка 102: | ||
</div> | </div> | ||
| + | <div class="mw-parser-output"> | ||
=== Проверка структур === | === Проверка структур === | ||
| + | |||
| + | Для проверки структур используется функция ''get экземпляра объекта Structure'' | ||
| + | |||
| + | ''struct.get(x,y,z,)'' | ||
| + | <syntaxhighlight lang="JavaScript">stuct.get(x, y, z, rotate_y)</syntaxhighlight> | ||
| + | |||
| + | Где: | ||
| + | |||
| + | *''x'' - Начальная координата структуры по X | ||
| + | *''y'' - Начальная координата структуры по Y | ||
| + | *''z'' - Начальная координата структуры по Z | ||
| + | *''rotate_y'' - Вращение только по оси Y | ||
| + | |||
| + | Вернет ''true'' если это нужная структура, иначе ''false.'' | ||
| + | |||
| + | '''Пример:''' | ||
| + | <syntaxhighlight lang="JavaScript">var struct = Structure.get("myStructure"); | ||
| + | Callback.addCallback("ItemUse", function(coords, item){ | ||
| + | if(item.id == 280 && struct.get(coords.x, coords.y, coords.z)){ | ||
| + | alert("It's my structure"); | ||
| + | } | ||
| + | });</syntaxhighlight> | ||
| + | |||
| + | ==== Устаревший способ ==== | ||
Для проверки структур используется функция ''getStructures()'' | Для проверки структур используется функция ''getStructures()'' | ||
| Строка 125: | Строка 150: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | </div> | + | </div> |
| + | |||
=== Полный перечень методов и констант === | === Полный перечень методов и констант === | ||
<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"> | ||
Версия 16:44, 16 февраля 2020
StructuresAPI - библиотека, упрощающая работу со структурами.
ВАЖНО!: Документация по версии 1.2 не полная
Содержание
Загрузка
| Библиотека | ||
|---|---|---|
| Версия | Ссылка | Изменения |
| 1 | Скачать |
Первая версия |
| 1.1 | Подробнее |
|
| 1.2 | Подробнее |
|
| GitHub | GitHub | |
Условия использования
- Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
- Запрещено изменение кода библиотеки
- Запрещено явное копирование кода в другие библиотеки или моды
Используя данный продукт вы автоматически соглашаетесь с этими правилами
Документация
Инициализация
Для начала работы импортируйте библиотеку.
IMPORT("StructuresAPI");
Сохранение структур
Для сохранения структур есть два способа:
Через WorldEdit
Для начала выделите вашу структуру топориком(1 точка - тап по блоку, 2 точка - ломание блока), затем выделите с помощью деревянного меча начальную точку структуры(Она может быть вне области структуры).
После введите в чат команду /save <name> [-a] [-x n] [-y n] [-z n] со следующими параметрами
- name - Имя структуры(Без пробелов)
- -a - Сохранить структуру с воздухом
- -x n - Установить центр структуры в координате n по X
- -y n - Установить центр структуры в координате n по Y
- -z n - Установить центр структуры в координате n по Z
Через код
!Не рекомендуется
1. Создать или получить объект структуры
var struct = Structure.get(name)
Где
- name - Имя структуры
2. Добавить блоки
3. Сохранить структуру
struct.save()
Устаревший способ
StructuresAPI.save(name, structures)
Где:
- name - Имя структуры
- structures - Массив данных о блоках
Проверка структур
Для проверки структур используется функция get экземпляра объекта Structure
struct.get(x,y,z,)
stuct.get(x, y, z, rotate_y)
Где:
- x - Начальная координата структуры по X
- y - Начальная координата структуры по Y
- z - Начальная координата структуры по Z
- rotate_y - Вращение только по оси Y
Вернет true если это нужная структура, иначе false.
Пример:
var struct = Structure.get("myStructure");
Callback.addCallback("ItemUse", function(coords, item){
if(item.id == 280 && struct.get(coords.x, coords.y, coords.z)){
alert("It's my structure");
}
});
Устаревший способ
Для проверки структур используется функция getStructures()
StructuresAPI.getStructures(name, x, y, z, rotate_y)
Где:
- name - Имя структуры
- x - Начальная координата структуры по X
- y - Начальная координата структуры по Y
- z - Начальная координата структуры по Z
- rotate_y - Вращение только по оси Y
Вернет true если это структура name, иначе false
Пример:
Callback.addCallback("ItemUse", function(coords, item){
if(item.id == 280 && StructuresAPI.getStructures("myStructure", coords.x, coords.y, coords.z)){
alert("It's my structure")
}
});
Полный перечень методов и констант
Методы
| Версия | Метод | Аргументы | Описание |
| 1.1 | init(string path) |
|
Устанавливает место хранения структур, относительно мода |
| 1.0 | get(string name) |
|
Возвращает объект структуры, иначе false |
| 1.0 |
getStructures(string name, int x, int y, int z, bool rotate_y) |
|
Вернет true, если на координатах структура name, иначе false |
| 1.0 | save(string name, array structures) |
|
Сохраняет струкутуру name |
| 1.0 | set(string name, int x, int y, int z, array rotate) |
|
Установить структуру name в мире по координатам x,y,z, с выбраным рандомно поворотм из массива rotate |
| 1.1 | set(string name, int x, int y, int z, array rotate, bool destroy, bool progressively, int time) |
|
Установить структуру name в мире по координатам x,y,z, с выбраным рандомно поворотм из массива rotate |
Константы
| Константа | Описание |
| ROTATE_NONE | |
| ROTATE_90Y | Матрица поворота по оси Y на 90о |
| ROTATE_180Y | Матрица поворота по оси Y на 180о |
| ROTATE_270Y | Матрица поворота по оси Y на 270о |
| ROTATE_90X | Матрица поворота по оси X на 90о |
| ROTATE_180X | Матрица поворота по оси X на 180о |
| ROTATE_270X | Матрица поворота по оси X на 270о |
| ROTATE_90Z | Матрица поворота по оси Z на 90о |
| ROTATE_180Z | Матрица поворота по оси Z на 180о |
| ROTATE_270Z | Матрица поворота по оси Z на 270о |
| ROTATE_RANDOM | Рандомный поворот |
| ROTATE_ALL | Поворот по всем осям |
| ROTATE_Y | Поворот по оси Y |