ParticleAnimationLib

Хотите создавать впечатляющие эффекты частиц в виде конусов, кубов, сфер и вихрей, но не знаете как? Этот мод станет вашим идеальным решением! Хотя он в первую очередь предназначен для разработчиков, обычные игроки также могут экспериментировать с эффектами через команды, чтобы оценить их возможности перед программной реализацией. Мод полностью серверный, поэтому клиентская установка не требуется. Вдохновением для создания послужил плагин EffectLib.

Доступные эффекты

На текущий момент доступны следующие анимации частиц:

• 3D-эффекты: Анимированная сфера, обычная сфера, параллелепипед, вихрь, конус, тор
• 2D-эффекты: Дуга, линия, анимированный круг, цветные и черно-белые изображения, текст

Внимание: Мод находится в стадии бета-тестирования, поэтому возможны незначительные изменения и ошибки. Некоторые эффекты еще находятся в разработке. Версия для Forge/NeoForge может появиться в будущем, но сначала планируется завершить версию для Fabric/Quilt.

Демонстрация некоторых эффектов из версии 0.0.1

Использование для игроков

Для работы с эффектами через команды необходимо установить дополнительный мод ParticleAnimationLibCommands. Команды могут показаться сложными, поэтому рекомендуется ознакомиться с вики для лучшего понимания.

Создание эффектов для разработчиков

Все эффекты находятся в пакете effects. Вы можете создавать новые эффекты либо через конструктор, либо используя метод построителя, аналогично свойствам блоков.

Пример использования:

// Псевдокод конструктора с методом runFor
Effect effect = new Effect(ServerWorld world, ParticleEffect effect, Vec3d originPos, int particles, Другие параметры...)
effect.runFor(5);

// Псевдокод построителя с методами run и setIterations (20 тиков = 1 секунда)
Effect effect = Effect.builder(ServerWorld world, ParticleEffect effect, Vec3d originPos).particles(10).anotherOption(true).build;
effect.setIterations(5*20);
effect.run();

Важно: При использовании построителя необходимо всегда указывать мир, эффект частиц и исходную позицию, так как все анимационные эффекты требуют этих параметров для корректной работы.

Управление анимационными эффектами

Каждый эффект имеет собственные геттеры и сеттеры, позволяющие изменять настройки перед запуском. Также можно передавать лямбда-выражение, которое будет выполняться каждый тик активности эффекта. Подробную информацию о параметрах смотрите в javadoc конструктора соответствующего эффекта.

Команды

Для использования команд необходимо установить дополнительный мод ParticleAnimationLibCommands. Используйте команды pal или particleanimationlib с автодополнением для создания эффектов. Для предварительного просмотра эффектов используйте /pal <effect> demo <particle> <pos>.

Для разработчиков

Добавьте библиотеку как зависимость в ваш build.gradle:

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    modImplementation "maven.modrinth:particleanimationlib:"
}

Номер версии можно найти на странице версий Modrinth.

Благодарности

Этот мод основан на плагине EffectLib от команды elBukkit. Эффекты взяты оттуда и адаптированы для моддинга с добавлением дополнительного функционала.

Лицензия

Библиотека распространяется под лицензией MIT