Промальовування блоку-сутності 1.21.8

Дізнайтеся, як покращити промальовування за допомогою промальовування блоку-сутності.

WARNING

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

Іноді використання формату моделі Minecraft недостатньо. Якщо вам потрібно додати динамічне промальовування до візуальних елементів вашого блоку, вам потрібно буде використовувати BlockEntityRenderer.

Наприклад, нумо зробимо так, щоб блок лічильника зі статті про блокові-сутностей показував кількість натискань у зверху.

Створення BlockEntityRenderer

Для початку, нам треба створити BlockEntityRenderer для CounterBlockEntity.

Створюючи BlockEntityRenderer для CounterBlockEntity, важливо помістити клас у відповідний вихідний набір, наприклад src/client/, якщо ваш проєкт використовує розділені вихідні набори для клієнта та сервера. Доступ до пов’язаних із промальовуванням класів безпосередньо у вихідному наборі src/main/ небезпечний, оскільки ці класи можуть бути завантажені на сервер.

public class CounterBlockEntityRenderer implements BlockEntityRenderer<CounterBlockEntity> {
	public CounterBlockEntityRenderer(BlockEntityRendererProvider.Context context) {
	}

	@Override
	public void render(CounterBlockEntity entity, float tickProgress, PoseStack matrices, MultiBufferSource vertexConsumers, int light, int overlay, Vec3 cameraPos) {
	}
}

Новий клас має конструктор із BlockEntityRendererProvider.Context як параметр. У Context є кілька корисних штук промальовування, наприклад ItemRenderer або Font. Крім того, включивши такий конструктор, стає можливим використовувати конструктор як сам функціональний інтерфейс BlockEntityRendererProvider:

public class FabricDocsBlockEntityRenderer implements ClientModInitializer {
	@Override
	public void onInitializeClient() {
		BlockEntityRenderers.register(ModBlockEntities.COUNTER_BLOCK_ENTITY, CounterBlockEntityRenderer::new);
	}
}

Ви маєте зареєструвати промальовування блокових сутностей у своєму класі ClientModInitializer.

BlockEntityRendererProvider — це реєстр, який зіставляє кожен BlockEntityType зі спеціальним кодом відтворення на відповідний BlockEntityRenderer.

Малювання на блоках

Тепер, коли у нас є промальовування, ми можемо малювати. Метод render викликається кожним кадром, і саме в ньому відбувається магія промальовування.

Пересування

По-перше, нам потрібно змістити та повернути текст так, щоб він знаходився вище блоку.

INFO

Як випливає з назви, PoseStack є стосом, що означає, що ви можете надсилати та витягувати перетворення. Гарне емпіричне правило полягає в тому, щоб додати новий блок на початку методу render і відкрити його в кінці, щоб промальовування одного блоку не впливав на інші.

Більше інформації про PoseStack можна знайти в статті про базові концепції промальовування.

Щоб полегшити розуміння необхідних перекладів і поворотів, візуалізуємо їх. На цьому зображенні зелений блок – це місце, де буде намальовано текст, за замовчуванням у найдальшій нижній лівій точці блоку:

Отже, спочатку нам потрібно перемістити текст наполовину блоку по осях X і Z, а потім перемістити його вгору до верхньої частини блоку по осі Y:

Це робиться за допомогою одного виклику translate:

matrices.translate(0.5, 1, 0.5);

Ось і переклад зроблено, обертання і масштаб залишаються.

За замовчуванням текст малюється на площині X-Y, тому нам потрібно повернути його на 90 градусів навколо осі X, щоб він був спрямований вгору на площині X-Z:

![Зелений блок у верхній центральній точці, спрямований догори] (/assets/develop/blocks/block_entity_renderer_3.png)

PoseStack не має функції rotate, натомість нам потрібно використовувати multiply і Axis.XP:

matrices.mulPose(Axis.XP.rotationDegrees(90));

Тепер текст у правильному положенні, але він завеликий. BlockEntityRenderer промальовує весь блок на куб [-0.5, 0.5], тоді як Font використовує координати Y [0, 9]. Таким чином, нам потрібно зменшити його в 18 разів:

matrices.scale(1/18f, 1/18f, 1/18f);

Тепер усе перетворення виглядає так:

matrices.pushPose();
matrices.translate(0.5, 1, 0.5);
matrices.mulPose(Axis.XP.rotationDegrees(90));
matrices.scale(1/18f, 1/18f, 1/18f);

Малювання тексту

Як згадувалося раніше, Context, переданий у конструктор нашого промальовування, має Font, який ми можемо використовувати для малювання тексту. Для цього прикладу ми збережемо його в полі.

Font має методи для вимірювання тексту (width), що корисно для центрування, і для його малювання (drawInBatch).

String text = entity.getClicks() + "";
float width = textRenderer.width(text);

// draw the text. params:
// text, x, y, color, shadow, matrix, vertexConsumers, layerType, backgroundColor, light
textRenderer.drawInBatch(
		text,
		-width/2, -4f,
		0xffffffff,
		false,
		matrices.last().pose(),
		vertexConsumers,
		Font.DisplayMode.SEE_THROUGH,
		0,
		light
);

Метод drawInBatch приймає багато параметрів, але найважливіші з них:

• Component (або String) для малювання;
• його координати x і y;
• значення 'кольору' RGB;
• Matrix4f, що описує, як його слід трансформувати (щоб отримати один із PoseStack, ми можемо використати last().pose(), щоб отримати Matrix4f для самого верхнього запису).

І після всієї цієї роботи ось результат: