Стан блоку 1.21.1

Дізнайтеся, чому стан блоку це чудовий спосіб додати візуальну функціональність для ваших блоків.

WARNING

Ця сторінка написана для версії 1.21.1. Документація для старіших версій може бути неповною.

Стан блоку — це частина даних, що прикріплюється до окремого блоку у світі Minecraft та містить інформацію про блок у вигляді властивостей. Ось кілька прикладів властивостей, які в стандартній версії гри зберігаються в станах блоків:

• Обертання: Зазвичай використовується для колод та інших природних блоків.
• Активний: Широко використовується у пристроях з редстоуном і блоках, таких як піч або коптильня.
• Вік: Використовується в посівах, траві, саджанцях, ламінарії тощо.

Ви, напевно, розумієте чому вони корисні - вони уникають необхідності зберігати дані NBT дані у блоковій сутності - зменшуючи розмір світу, та запобігаючи проблемам із TPS!

Визначення станів блоку знаходиться у теці assets/example-mod/blockstates.

Наприклад: Блок колонна

Minecraft має деякі користувальницькі класи, які дозволять вам швидко створити певні типи блоків - в цьому прикладі розглядається створення блоку з властивістю axios шляхом створення блоку "Condensed Oak Log".

Ванільний клас 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 — Моделі (Стани блоків).

Далі, ми повинні створити файл стану блоку У файлі blockstate відбувається магія — стовпові блоки мають три осі, тому ми використовуватимемо спеціальні моделі для таких ситуацій:

• 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
    }
  }
}

Як завжди, вам потрібно буде створити переклад для свого блоку та модель предмета, яка є батьками будь-якої з двох моделей.

Власні стани блоків

Спеціальні стани блоку чудові, якщо ваш блок має унікальні властивості - іноді ви можете виявити, що ваш блок може повторно використовувати ванілльні властивості.

У цьому прикладі буде створено унікальну логічну властивість під назвою 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;
	}
}

Візуалізація власності

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

Завантажити Текстури

Використовуйте свої знання про моделі блоків, щоб створити дві моделі для блоку: одну для активованого стану та одну для деактивованого стану. Зробивши це, ви можете розпочати створення файлу стану блоку.

Оскільки ви створили нову властивість, вам потрібно буде оновити файл стану блоку для врахування цієї властивості.

Якщо у вас є кілька властивостей у блоці, вам потрібно врахувати всі можливі комбінації. Наприклад, activated і axis призведе до 6 комбінацій (два можливі значення для activated і три можливі значення для axis).

Оскільки цей блок має лише два можливі варіанти, оскільки він має лише одну властивість («активовано»), стан блоку 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
);

Коли ви все завершите, кінцевий результат має виглядати приблизно так: