Состояния блока 1.21.1

Узнать почему состояния блока — это отличный способ добавить визуальной функциональности вашим блокам.

WARNING

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

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

• Rotation: В основном используется для древесины и других природных блоков.
• Activated: Широко используется в редстоун-устройствах, а также в таких блоках, как печь или коптильня.
• Age: Используется для культур, растений, саженцев, водорослей и т.п.

Вы, вероятно, понимаете, почему они полезны — они позволяют избежать необходимости хранения данных NBT в сущности блока, что уменьшает размер мира и предотвращает проблемы с TPS!

Определения состояний блока можно найти в папке assets/example-mod/blockstates.

Пример: Блок Колонна

Minecraft уже имеет несколько пользовательских классов, которые позволяют быстро создавать определенные типы блоков. Этот пример демонстрирует создание блока со свойством axis на примере блока "Обтёсанная дубовая древесина".

Стандартный класс PillarBlock позволяет размещать блоки вдоль осей X, Y или Z.

public static final Block CONDENSED_OAK_LOG = register(
		new RotatedPillarBlock(
				BlockBehaviour.Properties.of()
						.sound(SoundType.WOOD)
		), "condensed_oak_log", true
);
	ItemGroupEvents.modifyEntriesEvent(ModItems.CUSTOM_ITEM_GROUP_KEY).register((itemGroup) -> {
		itemGroup.accept(ModBlocks.CONDENSED_DIRT.asItem());
	});

Колоновые блоки имеют две текстуры: верхнюю и боковую. Они используют модель block/cube_column.

Как всегда, со всеми текстурами блоков, файлы текстур могут быть найдены в assets/example-mod/textures/block

Скачать Текстуры

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

• condensed_oak_log_horizontal.json, который дополняет модель block/cube_column_horizontal.
• condensed_oak_log.json, который дополняет модель block/cube_column.

Пример файла condensed_oak_log_horizontal.json:

{
  "parent": "block/cube_column_horizontal",
  "textures": {
    "end": "example-mod:block/condensed_oak_log_top",
    "side": "example-mod:block/condensed_oak_log"
  }
}

INFO

Remember, blockstate files can be found in the assets/example-mod/blockstates folder, the name of the blockstate file should match the block ID used when registering your block in the ModBlocks class. For instance, if the block ID is condensed_oak_log, the file should be named condensed_oak_log.json.

Для более подробного изучения всех доступных модификаторов в файле состояний блоков, ознакомьтесь со страницей Minecraft Wiki - Models (Block States).

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

• axis=x - Когда блок помещён вдоль оси X, мы повернём модель так, чтобы она была ориентирована в положительном направлении оси X.
• axis=y - Когда блок помещён вдоль оси Y, мы будем использовать нормальную вертикальную модель.
• axis=z - Когда блок помещён вдоль оси Z, мы повернём модель так, чтобы она была ориентирована в положительном направлении оси X.

{
  "variants": {
    "axis=x": {
      "model": "example-mod:block/condensed_oak_log_horizontal",
      "x": 90,
      "y": 90
    },
    "axis=y": {
      "model": "example-mod:block/condensed_oak_log"
    },
    "axis=z": {
      "model": "example-mod:block/condensed_oak_log_horizontal",
      "x": 90
    }
  }
}

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

Пользовательские состояния блока

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

Этот пример создаст уникальное boolean-свойство под названием activated - когда игрок нажимает ПКМ на блок, состояние блока меняется с activated=false на activated=true - соответствующим образом меняя его текстуру.

Создаём свойство

Сначала вам нужно создать свойство — так как это булево значение, мы будем использовать метод BooleanProperty.create.

public class PrismarineLampBlock extends Block {
	public static final BooleanProperty ACTIVATED = BooleanProperty.create("activated");

}

Далее нам необходимо добавить свойство к менеджеру состояний блока в методе createBlockStateDefinition. Вам необходимо переопределить метод для доступа к конструктору:

@Override
protected void createBlockStateDefinition(StateDefinition.Builder<Block, BlockState> builder) {
	builder.add(ACTIVATED);
}

Вам также придется установить состояние по умолчанию для свойства activated в конструкторе вашего пользовательского блока.

public PrismarineLampBlock(Properties settings) {
	super(settings);

	// Set the default state of the block to be deactivated.
	registerDefaultState(defaultBlockState().setValue(ACTIVATED, false));
}

WARNING

Не забудьте зарегистрировать свой блок, используя пользовательский класс вместо Block!

Использование свойства

В этом примере булево свойство activated инвертируется, когда игрок взаимодействует с блоком. Для этого мы можем переопределить метод onUse:

@Override
protected InteractionResult useWithoutItem(BlockState state, Level world, BlockPos pos, Player player, BlockHitResult hit) {
	if (!player.getAbilities().mayBuild) {
		// Skip if the player isn't allowed to modify the world.
		return InteractionResult.PASS;
	} else {
		// Get the current value of the "activated" property
		boolean activated = state.getValue(ACTIVATED);

		// Flip the value of activated and save the new blockstate.
		world.setBlockAndUpdate(pos, state.setValue(ACTIVATED, !activated));

		// Play a click sound to emphasise the interaction.
		world.playSound(player, pos, SoundEvents.COMPARATOR_CLICK, SoundSource.BLOCKS, 1.0F, 1.0F);

		return InteractionResult.SUCCESS;
	}
}

Визуализация недвижимости

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

Скачать Текстуры

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

Поскольку вы создали новое свойство, вам необходимо обновить файл blockstate для блока, чтобы учесть это свойство.

Если в блоке имеется несколько свой блока, вам необходимо учитывать все возможные комбинации. Например, «activated» и «axis» приведут к 6 комбинациям (два возможных значения для «activated» и три возможных значения для «axis»).

Поскольку этот блок имеет только два возможных варианта, поскольку у него есть только одно свойство (activated), JSON-код состояния блока будет выглядеть примерно так:

{
  "variants": {
    "activated=false": {
      "model": "example-mod:block/prismarine_lamp"
    },
    "activated=true": {
      "model": "example-mod:block/prismarine_lamp_on"
    }
  }
}

Поскольку пример блока представляет собой лампу, нам также необходимо заставить ее излучать свет, когда свойство activated имеет значение true. Это можно сделать с помощью настроек блока, передаваемых конструктору при регистрации блока.

Вы можете использовать метод luminance для установки уровня освещенности, излучаемой блоком. Мы можем создать статический метод в классе PrismarineLampBlock для возврата уровня освещенности на основе свойства activated и передать его как ссылку на метод luminance:

public static int getLuminance(BlockState currentBlockState) {
	// Get the value of the "activated" property.
	boolean activated = currentBlockState.getValue(PrismarineLampBlock.ACTIVATED);

	// Return a light level if activated = true
	return activated ? 15 : 0;
}

public static final Block PRISMARINE_LAMP = register(
		new PrismarineLampBlock(
				BlockBehaviour.Properties.of()
						.sound(SoundType.LANTERN)
						.lightLevel(PrismarineLampBlock::getLuminance)
		), "prismarine_lamp", true
);

После того как вы все завершите, конечный результат должен выглядеть примерно так: