StructuresAPI
StructuresAPI - библиотека, упрощающая работу со структурами.
Содержание
Загрузка[править]
| Библиотека | ||
|---|---|---|
| Версия | Ссылка | Изменения |
| 1 | Скачать |
Первая версия |
| 1.1 | Подробнее |
|
| 1.2 | Подробнее |
|
| 1.3 | Подробнее |
|
| 1.4 | Подробнее |
|
| GitHub | GitHub | |
Условия использования[править]
- Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
- Запрещено изменение кода библиотеки
- Запрещено явное копирование кода в другие библиотеки или моды
Используя данный продукт вы автоматически соглашаетесь с этими правилами
Документация[править]
Сохранение структур[править]
Для сохранения структур есть два способа:
Через 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")
}
});
Полный перечень методов и констант[править]
Structure[править]
Добавлен с версии 1.2
Методы[править]
| Версия | Метод | Аргументы | Описание |
|---|---|---|---|
| 1.2 | init(string path) |
|
Устанавливает место хранения структур, относительно мода |
| 1.2 | get(string name) |
|
Возвращает экземпляр объекта Structure с именем name |
| 1.3 | setInWorld(string name, int x, int y, int z, array rotate, bool progressively, int time) |
|
Установить структуру name в мире по координатам x,y,z, с выбраным рандомно поворотм из массива rotate |
| 1.3 | destroyInWorld(string name, int x, int y, int z, array rotates, bool progressively, int time) |
|
Установить структуру name в мире по координатам x,y,z, с возможными поворотами rotates |
Константы[править]
| Версия | Константа | Описание |
| 1.2 | ROTATE_NONE | |
| 1.2 | ROTATE_90Y | Матрица поворота по оси Y на 90о |
| 1.2 | ROTATE_180Y | Матрица поворота по оси Y на 180о |
| 1.2 | ROTATE_270Y | Матрица поворота по оси Y на 270о |
| 1.2 | ROTATE_90X | Матрица поворота по оси X на 90о |
| 1.2 | ROTATE_180X | Матрица поворота по оси X на 180о |
| 1.2 | ROTATE_270X | Матрица поворота по оси X на 270о |
| 1.2 | ROTATE_90Z | Матрица поворота по оси Z на 90о |
| 1.2 | ROTATE_180Z | Матрица поворота по оси Z на 180о |
| 1.2 | ROTATE_270Z | Матрица поворота по оси Z на 270о |
| 1.2 | ROTATE_RANDOM | Рандомный поворот |
| 1.2 | ROTATE_ALL | Поворот по всем осям |
| 1.2 | ROTATE_Y | Поворот по оси Y |
| 1.3 | PROGRESSIVELY | Установка/уничтожение постройки постепенное |
| 1.3 | NOT_PROGRESSIVELY | Установка/уничтожение постройки не постепенное |
| 1.3 | MIRROR_X | Отражение по оси X |
| 1.3 | MIRROR_Y | Отражение по оси Y |
| 1.3 | MIRROR_Z | Отражение по оси Z |
Экземпляр Structure[править]
| Версия | Метод | Аргументы | Описание |
| Только 1.2 | get(int x, int y, int z, bool rotate_y) |
|
Вернет true, если на координатах данная структура, иначе false |
| 1.3 | get(int x, int y, int z, array rotates, bool return_index) |
|
Вернет true, если на координатах данная структура, иначе false |
| check(int x, int y, int z, array rotates, bool return_index) | |||
| 1.2 | getName() | Вернет имя структуры | |
| 1.2 | save() | Сохранить структуру в файл | |
| Только 1.2 | set(int x, int y, int z, array rotate, bool destroy, bool progressively, int time) |
|
Установить структурув мире по координатам x,y,z, с выбраным рандомно поворотм из массива rotate |
| 1.3 | set(int x, int y, int z, array rotate, bool progressively, int time) |
|
Установить структурув мире по координатам x,y,z, с выбраным рандомно поворотм из массива rotate |
| 1.3 | destroy(int x, int y, int z, array rotates, bool progressively, int time) |
|
Уничтожить структуру в мире по координатам x,y,z, с возможными поворотами rotates |
| 1.2 | addBlock(x, y, z, block) |
|
Добавить блок в структуру |
Rotate[править]
Добавлен с версии 1.3
Объект Rotate позволяет задовать сложные повороты, которые будут выполнятся при поиске/уничтожении/установке структуры.
var rotate = new Rotate();
rotate.addRotate(Structure.ROTATE_90Y);
rotate.addRotate(Structure.ROTATE_90X);
Данный код позволит повернуть структуру сначала на 90 градусов по оси Y, затем по оси X.
экземпляр Rotate[править]
| Версия | Метод | Аргументы | Описание |
|---|---|---|---|
| 1.3 | addRotate(array rotate) |
|
Добавить поворот |
| 1.3 | add(array rotate) | ||
| 1.3 | addRotates(array rotates) |
|
Добавить повороты в указанном порядке |
| 1.3 | adds(array rotates) |
StructuresAPI[править]
Считается устаревшим с версии 1.2
Удален в версии 1.3
Методы[править]
| Версия | Метод | Аргументы | Описание |
| 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 |