Эффекты состояния

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

Можно использовать команду /effect для применения эффектов к сущности.

Свои эффекты состояния

В этом руководстве мы добавим новый эффект под названием Tater, который даёт игроку одно очко опыта каждый игровой такт.

Расширение StatusEffect

Давайте создадим класс нашего эффекта, который будет наследовать основной класс всех эффектов — StatusEffect.

public class TaterEffect extends StatusEffect {
	protected TaterEffect() {
		// category: StatusEffectCategory - describes if the effect is helpful (BENEFICIAL), harmful (HARMFUL) or useless (NEUTRAL)
		// color: int - Color is the color assigned to the effect (in RGB)
		super(StatusEffectCategory.BENEFICIAL, 0xe9b8b3);
	}

	// Called every tick to check if the effect can be applied or not
	@Override
	public boolean canApplyUpdateEffect(int duration, int amplifier) {
		// In our case, we just make it return true so that it applies the effect every tick
		return true;
	}

	// Called when the effect is applied.
	@Override
	public boolean applyUpdateEffect(ServerWorld world, LivingEntity entity, int amplifier) {
		if (entity instanceof PlayerEntity) {
			((PlayerEntity) entity).addExperience(1 << amplifier); // Higher amplifier gives you experience faster
		}

		return super.applyUpdateEffect(world, entity, amplifier);
	}
}

Регистрация своего эффекта

Схожим с регистрацией блоков и предметов образом, мы используем Registry.register, чтобы зарегистрировать наш эффект в реестре STATUS_EFFECT. Это можно сделать в нашем инициализаторе.

public class FabricDocsReferenceEffects implements ModInitializer {
	public static final RegistryEntry<StatusEffect> TATER;

	static {
		TATER = Registry.registerReference(Registries.STATUS_EFFECT, Identifier.of("fabric-docs-reference", "tater"), new TaterEffect());
	}

	@Override
	public void onInitialize() {
		// ...
	}
}

Текстура

Иконка эффекта состояния представляет собой PNG-файл размером 18×18 пикселей. Поместите свою иконку в папку:

resources/assets/fabric-docs-reference/textures/mob_effect/tater.png

Переводы

Как и с любыми другими переводами, вы можете добавить запись формата "effect.mod-id.effect-identifier": "Значение" в языковой файл.

{
  "effect.fabric-docs-reference.tater": "Tater"
}

Применение эффекта

Стоит взглянуть на то, как вы обычно применяете эффект к объекту.

TIP

For a quick test, it might be a better idea to use the previously mentioned /effect command:

effect give @p fabric-docs-reference:tater

Чтобы применить эффект внутри, вам нужно использовать метод LivingEntity#addStatusEffect, который принимает StatusEffectInstance и возвращает логическое значение, указывающее, был ли эффект успешно применен.

var instance = new StatusEffectInstance(FabricDocsReferenceEffects.TATER, 5 * 20, 0, false, true, true);
entity.addStatusEffect(instance);

Аргумент	Тип	Описание
effect	RegistryEntry<StatusEffect>	Запись в реестре, представляющая этот эффект.
duration	int	Продолжительность эффекта в тиках; не секундах
amplifier	int	Усилитель соответствует уровню эффекта. Это не соответствует уровню эффекта, а скорее добавляется сверху. Следовательно, усилитель на уровне 4 => уровень 5
ambient	boolean	Это очень сложный вопрос. Это в основном указывает на то, что эффект был добавлен окружающей средой (например, Маяком) и не имеет прямой причины. Если установлено значение true, то на экране появится значок эффекта с аквамариновым наложением.
particles	boolean	Показывать ли частицы.
icon	boolean	Отображать ли значок эффекта в HUD. Эффект будет отображаться в инвентаре независимо от этого флага.

INFO

INFO

Чтобы узнать, как создать зелье, накладывающее этот эффект, ознакомьтесь с руководством по зельям.