InnerCore/Libs/ScalesRPG

Материал из mineprogramming wiki
Перейти к: навигация, поиск

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

Библиотека является частью мода с открытым исходным кодом A.P.O. Craft. Последняя версия библиотеки находится по этому адресу.

Условия использования[править]

  • Разрешено неограниченное использование данной библиотеки в собственных модификациях
  • Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
  • Запрещено изменение кода библиотеки
  • Запрещено явное копирование кода в другие библиотеки или моды 

Используя данный продукт вы автоматически соглашаетесь с этими правилами

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

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

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

IMPORT("ScalesRPG");

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

Основные команды класса ScalesRPG[править]

  • resetAll - сбрасывает значение всех шкал до 20 (полностю заполнено). 
  • showAll - делает все зарегистрированные шкалы видимыми
  • hideAll - прячет все зарегистрированные шкалы (происходит автоматически при выходе из экрана игры)

Описание конструктора Scale[править]

Конструктор ScalesRPG.Scale принимает единственный параметр - объект описания шкалы:

{ 
    bitmaps: { //Объекты android.graphics.Bitmap, представляющие собой иконки шкалы
        full: BitmapFactory.decodeFile(__dir__ + "gui/scale_biological_0.png"), //Заполненная иконка
        half: BitmapFactory.decodeFile(__dir__ + "gui/scale_biological_1.png"), //Половина иконки
        empty: BitmapFactory.decodeFile(__dir__ + "gui/scale_biological_2.png") //Пустая иконка
    }, 
    value: 3, //Начальное значение (необязательно, по умолчанию 20)
    right: false //Выравнивание по правому краю (необязательно, по умолчанию false)
}

Даный конструктор возвращает объект Scale, обладающий следующими параметрами методами:

  • right - свойство, позволяющее узнать, является ли данная шкала правосторонней. Только для чтения.
  • setValue(value) - устанавливает значение шкалы на value (от 0 до 20)
  • getValue() - получает значение value данной шкалы
  • increase() - увеличивает значение value на 1 (упрощенный способ)
  • decrease() - уменьшает значение value на 1 (упрощенный способ)
  • reset() - сбрасывает значение шкалы до 20 (упрощенный способ)
  • show() - показывает шкалу
  • hide() - прячет шкалу, если она не была спрятана ранее
  • isShown() - показывает, открыта ли даная шкала