Плагин [DEV/RPG] BukkitMimic v1.1.1 - API для работы с RPG плагинами [1.7.10+]

Версия: v1.1.1
Скачать | GitHub | JavaDoc​

Некоторое время назад я описывал проблему, которая сподвигла меня написать этот API. И теперь представляю готовую реализацию (правда, пока с небольшим функционалом).

MimicAPI - это API для абстракции таких RPG концепций, как уровень, класс, мана игрока и т.д. BukkitMimic - это реализация MimicAPI для Bukkit.

Что это даст?
Если коротко, то это а-ля Vault для RPG статов.
Если подробнее, то отсутствие привязки плагинов к определенной реализации той или иной RPG концепции позволит добиться более простой совместимости RPG плагинов друг с другом и поможет избавиться от конфликтов их между собой.

Коротко о структуре
Каждая концепция - это система, а реализация концепции - подсистема.
В API есть реестр систем, в который записаны все подсистемы для каждой системы.
Вы в любой момент можете зарегистрировать новую или получить существующую реализации системы, чтобы с ней работать.

Какие системы существуют?
На данный момент (v1.0) существует всего две системы и по одной подсистеме для каждой из них:
- LevelSystem - система уровня и опыта игрока
----- VanillaLevelSystem - подсистема ванильного опыта и уровня
- ClassSystem - система классов игрока
----- PermissionsClassSystem - подсистема классов, основанных на пермишенах (например, чтобы назначить игроку класс Mage, нужно дать ему пермишен "mimic.class.mage").

Как использовать?
Если вы используете систему сборки (Gradle, Maven и т. д.) для того чтобы подключить библиотеку к своему проекту, используйте репозиторий JitPack.
Если не используете, то подключите скомпилированный jar (доступный по ссылке выше).

Код:

// Получаем реестр
SystemRegistry registry = BukkitMimic.getSystemRegistry();

// Получаем фабрику для системы уровней, которуюу после мы сможем 
// хранить для получения систем определенных игроков
SystemFactory<LevelSystem> levelSystemFactory;
try {
    levelSystemFactory = registry.getSystemFactory(LevelSystem.class);
} catch(SystemNotFoundException e) {
    // Возникает, если в реестре нет ни одной подсистемы для данной системы
}
       
// Теперь получим систему уровней определённого игрока
Player player = somePlayer;
LevelSystem levelSystem = levelSystemFactory.get(player);

// Работаем с полученной системой
int level = levelSystem.getLevel();
int exp = levelSystem.getExp();
int totalExp = levelSystem.getTotalExp();
// и т.д. Все методы с описанием на английском можно найти в JavaDoc[FONT=Tahoma]

Важно!
Для хранения объекта игрока внутри системы используется слабая ссылка, что позволяет нам не беспокоиться о том, что наличие инициализированной системы помешает выгрузке игрока из памяти, если он выйдет с сервера. Но из-за этого возникает риск получить IllegalStateException, если мы попытаемся воспользоваться системой после того, как игрок вышел с сервера, поэтому старайтесь, чтобы время жизни инициализированной системой было небольшим, тогда появление исключений будет сведено к нулю.​

Пример регистрации новой подсистемы:

Код:

// Получаем реестр систем
BukkitSystemRegistry registry = BukkitMimic.getSystemRegistry();

// Регистрируем подсистему
try {
    registry.registerSubsystem(MySubsystem.class);
} catch(SystemNotNeededException e) {
    // Это исключение возникает, если система не зарегистрирована из-за того, 
    // что требования для ее существования не выполнены (а именно, не 
    // существуют необходимые классы
} catch(SystemNotRegisteredException e) {
    // Это исключение вызывается, если система не зарегистрирована из-за 
    // возникшей ошибки. Это происходит, если неверно реализована подсистема
}

Конечно, это неполная документация. Если хотите посмотреть примеры создания систем и подсистем, то смотрите исходники существующих систем (ru.endlesscode.mimic.api.system.ClassSystem) и подсистем (ru.endlesscode.mimic.bukkit.system.PermissionsClassSystem).

Лог изменений

v1.1.1
- API обновлён до 1.1.0
- Исправлена ошибка из-за которой невозможно было использовать плагин
- Количество возможных исключений уменьшено, теперь использовать API удобнее

v1.0
- Первый релиз

 

Резерв

 

[DOUBLEPOST=1491982875,1491982797][/DOUBLEPOST]Вау[DOUBLEPOST=1491982929][/DOUBLEPOST]Сделай систему магии

 

Добавил это в голосование. Можно переголосовать

 

Всё!!!

 

В голосовании последние 3 пункта однозначно нужно внедрять

 

Они все будут реализованы. Вопрос в том, что сделать раньше.

 

чего больше того и делай

 

Ну да. Только когда я это писал, было равное количество голосов за все варианты.

 

Почему нельзя использовать new вместо clone?

 

Потому что при регистрации подсистемы создаётся её неинициализированный экземпляр, а потом, когда надо получить систему для конкретного игрока, то он клонируется и вызывается метод инициализации. На самом деле я уже понял, что это плохое решение и лучше тут использовать абстрактную фабрику, тогда можно будет один раз получить фабрику, а потом из нее сколько угодно инициализированных систем получать.[DOUBLEPOST=1492954562,1492087183][/DOUBLEPOST]v1.1.0
- API обновлён до 1.1.0
- Исправлена ошибка из-за которой невозможно было использовать плагин
- Количество возможных исключений уменьшено, теперь использовать API удобнее[DOUBLEPOST=1492956136][/DOUBLEPOST]v1.1.1
- Убрал из jar-ника аннотации JetBrains

 

Хорошая вещь. Буду ждать пока функционал увеличится, тогда напишу себе замену BattleLevels.