Перейти к содержанию

Tile Entity#

В Майнкрафте класс Block используется для представления не просто единичного блока в мире, а блока как типа. Экземпляр Block содержит свойства для каждого экземпляра блока в мире. Если мы хотим, что бы наш блок содержал уникальные данные/свойстава/GUI для каждого экземпляра, нужно использовать TileEntity.

Тайлы бывают двух типов: обновляющиеся и не обновляющиеся. Не обновляющиеся тайлы просто хранят какую-то информацию и практически не нагружают игровую систему. А вот обновляющиеся тайлы обновляются каждый игровой тик (обычно 20 раз в секунду). Последние влияют на производительность сильнее и требуют очень аккуратной реализации.

Блок#

Создадим CounterBlock, расширяющий Block.

public class CounterBlock extends Block
{
    public CounterBlock()
    {
        super(Properties.create(Material.ROCK));
    }

    @Override
    public ActionResultType onBlockActivated(BlockState state, World world, BlockPos position, PlayerEntity playerEntity, Hand hand, BlockRayTraceResult result)
    {

        if (!world.isRemote)
        {
            CounterTile tileEntity = (CounterTile) world.getTileEntity(position);
            tileEntity.incCount();
            playerEntity.sendMessage(new StringTextComponent("Count: " + tileEntity.getCount()));
        }

        return ActionResultType.SUCCESS;
    }

    @Override public boolean hasTileEntity(BlockState state){ return true;  }
    @Override public TileEntity createTileEntity(BlockState state, IBlockReader world) { return new CounterTile(); }
}

В конструкторе мы просто вызываем конструктор суперкласса super(Properties.create(Material.ROCK)) и передаём туда все пропертисы.

В методе hasTileEntity мы говорим игре, что блок имеет тайл. В createTileEntity мы возвращаем новый экземпляр тайла.

Ну и в конце концов в onBlockActivated, который вызывается при правом клике по блоку мы делаем следующее: * Проверяем, что действия производятся на сервере (это очень важно при работе с TileEntity!). * Достаём экземпляр CounterTile. * Отправляем в чат сообщение, содержащее значение счётчика. * Возвращаем true.

Разделение: клиент и сервер#

Как было подмечено выше, перед тем как работать со счётчиком тайла, мы должны удостовериться, что действия происходят на сервере. Делаем мы это потому, что в Майнкрафте клиент и сервер полностью разделены и некоторые методы вызываются для обеих сторон.

В многопользовательской игре множество клиентов подключены к одному серверу. В этом случае разделение между сторонами очевидно. Сервер, к которому происходит подключение, отражает физический сервер и все отдельные подключенные клиенты являются физическими клиентами. Но в одиночной игре всё немного сложнее.

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

Поле World.isRemote используется для проверки стороны, на которой происходит выполнение (будь она логической или физической). Оно равно true для физического клиента в многопользовательской игре и для логического клиента в одиночной игре. Это поле равно false для физического сервера в многопользовательской игре и для логического сервера в одиночной.

Делая проверку в условии !world.isRemote, мы обеспечиваем уверенность что действия будут производится на сервере (физическом или логическом).

Создание тайла#

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

public abstract class TutTile extends TileEntity
{
    public TutTile(TileEntityType<?> tileEntityTypeIn)
    {
        super(tileEntityTypeIn);
    }

    public CompoundNBT getUpdateTag()
    {
        return write(new CompoundNBT());
    }

    public abstract SUpdateTileEntityPacket getUpdatePacket();

    public abstract void onDataPacket(NetworkManager net, SUpdateTileEntityPacket pkt);
}
* getUpdatePacket возвращает объект пакета синхронизации (уже с данными). Фактически - это аналог write. * onDataPacket - чтение из пакета синхронизации.

Создадим класс CounterTile:

public class CounterTile extends TutTile
{
    private int count = 0;
    public CounterTile()
    {
        super(PhoenixTiles.COUNTER.get());
    }

    public void incCount()
    {
        count++;
    }

    public int getCount()
    {
        return count;
    }

    @Override
    public void read(CompoundNBT nbt)
    {
        count = nbt.getInt("count");
        super.read(nbt);
    }

    @Override
    public CompoundNBT write(CompoundNBT nbt)
    {
        nbt.putInt("count", count);
        return super.write(nbt);
    }

    @Override
    public SUpdateTileEntityPacket getUpdatePacket()
    {
        return new UpdatePacket(count);
    }

    @Override
    public void onDataPacket(NetworkManager net, SUpdateTileEntityPacket pkt)
    {
        count = ((UpdatePacket) pkt).count;
    }

    static class UpdatePacket extends SUpdateTileEntityPacket
    {
        public int count;

        public UpdatePacket(int countIn)
        {
            this.count = countIn;
        }

        @Override
        public void readPacketData(PacketBuffer buffer) throws IOException
        {
            buffer.writeInt(count);
            super.readPacketData(buffer);
        }

        @Override
        public void writePacketData(PacketBuffer buffer) throws IOException
        {
            count = buffer.readInt();
            super.writePacketData(buffer);
        }
    }
}

Разбор: * count - количество кликов. * В конструктор суперкласса super(PhoenixTiles.COUNTER.get()) передается зарегистрированный тип тайла. Регистрацию мы сделаем далее. * incCount и getCount - методы работы с кол-вом кликов. * write - сохранение информации в NBT. * read - чтение информации, сохраненной в NBT. * getUpdatePacket - возвращает объект пакета синхронизации(уже с данными). Фактически это аналог write. * onDataPacket - чтение из пакета синхронизации. * UpdatePacket - класс пакета. Далее его разбор: * count хранит кол-во прыжков * readPacketData - чтение из пакета * writePacketData - запись в пакет

NBT формат#

Данный формат используется для хранения данных в виде пар ключ-значение, которые легко сериализуются в байты и сохраняются на диск. Вы можете ознакомиться с классом CompoundNBT для представления о типах данных, которые он может хранить. Ванильный код содержит множество хороших примеров по сохранению и чтению сложных структур данных.

В нашем случае мы сохраняем значение поля count как целочисленный тип Integer с ключём в виде строки "count" в NBT в методе write() и читаем его в read().

Формат пакетов#

Пакеты используются для синхронизации информации между клиентом и сервером. В отличие от NBT значение получается не по ключу, а читается в той же последовательности, что и пишется. Т. е. если записывается int int BlockPos int, то и читается int int BlockPos int, причём порядок строго сохраняется, независимо от типа данных. Если нарушить порядок - скорее всего вылетит исключение.

Регистрация#

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

public class TutTiles
{
    public static final DeferredRegister<TileEntityType<?>> TILE_ENTITIES = new DeferredRegister(ForgeRegistries.TILE_ENTITIES, Tut.MOD_ID);

    public static final RegistryObject<TileEntityType<CounterTile>> COUNTER = TILE_ENTITIES.register("counter", () -> TileEntityType.Builder.create(CounterTile::new, TutBlocks.COUNTER.get()).build(null));

    public static void register()
    {
        TILE_ENTITIES.register(FMLJavaModLoadingContext.get().getModEventBus());
    }
}
Не забудем вызвать TutTiles.register() в конструкторе главного класса.

Финал#

Теперь, кликнув на блок, мы увидем какое число содержится в TileEntity.

Увеличение значения счетчика