Создание пользовательских частиц 1.21.1

Узнайте, как создать пользовательскую частицу с помощью Fabric API.

WARNING

Эта страница написана для версии 1.21.1. Документация для более старых версий может быть неполной.

Частицы — мощный инструмент. Они могут добавить атомосферность красивой сцене или добавить напряжения в битву с боссом. Давайте добавим еще один!

Регистрация пользовательской частицы

Мы добавим новую блестящую частицу, которая будет имитировать движение конечной стержневой частицы.

Сначала нам нужно зарегистрировать ParticleType в классе инициализатора вашего мода, используя идентификатор вашего мода.

// This DefaultParticleType gets called when you want to use your particle in code.
public static final SimpleParticleType SPARKLE_PARTICLE = FabricParticleTypes.simple();

	// Register our custom particle type in the mod initializer.
	Registry.register(BuiltInRegistries.PARTICLE_TYPE, ResourceLocation.fromNamespaceAndPath(MOD_ID, "sparkle_particle"), SPARKLE_PARTICLE);

«sparkle_particle» строчными буквами — это путь JSON к текстуре частицы. Позже вы создадите новый JSON-файл с таким же именем.

Регистрация на стороне клиента

После регистрации частицы в точке входа ModInitializer вам также необходимо зарегистрировать частицу в точке входа ClientModInitializer.

// For this example, we will use the end rod particle behaviour.
ParticleFactoryRegistry.getInstance().register(ExampleMod.SPARKLE_PARTICLE, EndRodParticle.Provider::new);

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

TIP

You can see all the particle factories by looking at all the implementations of the ParticleProvider interface. This is helpful if you want to use another particle's behaviour for your own particle.

• Горячая клавиша IntelliJ: Ctrl+Alt+B
• Горячая клавиша Visual Studio Code: Ctrl+F12

Создание JSON-файла и добавление текстур

Вам нужно будет создать 2 папки в папке resources/assets/example-mod/.

Путь к папке	Обьяснение
/textures/particle	Папка particle будет содержать все текстуры для всех ваших частиц.
/particles	Папка particles будет содержать все json-файлы для всех ваших частиц.

В этом примере у нас будет только одна текстура в textures/particle с названием "sparkle_particle_texture.png".

Затем создайте новый JSON-файл в particles с тем же именем, что и путь JSON, который вы использовали при регистрации ParticleType. Для этого примера нам потребуется создать sparkle_particle.json. Этот файл важен, поскольку он сообщает Minecraft, какие текстуры должна использовать наша частица.

{
  "textures": ["example-mod:sparkle_particle_texture"]
}

TIP

Вы можете добавить больше текстур в массив textures, чтобы создать анимацию частиц. Частица будет циклически проходить по текстурам в массиве, начиная с первой текстуры.

Тестирование новой частицы

После того как вы завершите работу над файлом JSON и сохраните ее, вы можете загрузить Minecraft и все протестировать!

Проверить, все ли работает, можно, введя следующую команду:

/particle example-mod:sparkle_particle ~ ~1 ~

INFO

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

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