Jump to content
Search In
  • More options...
Find results that contain...
Find results in...

New block Property backward compatibility


Recommended Posts

I have added a new property to my block, that is used by TESR to display the model in correct orientation. That all works very well, but before I release I wanted to make sure that the previously placed blocks will display correctly.

And that is not the case. They are basically gone. I don't get any notification in MC about missing blocks or anything in the logs. When I try debugging I don't see any code being triggered to get the tile entities or trying to load the block with preexisting meta (which would be -1 as there were no properties previously).

The way it seems to me is that in the block registry it registers the new blockstates with the facing values, but doesn't have anything in there for the previous no property state and then just skips putting those blocks in the world.

 

I guess there's something simple that I am missing here, but can't figure that out. Is there a way to make this backwards compatible so that the blocks without any property set would get a default facing set?

 

My block:

 

package xreliquary.blocks;


import net.minecraft.block.material.Material;
import net.minecraft.block.properties.IProperty;
import net.minecraft.block.properties.PropertyDirection;
import net.minecraft.block.state.BlockState;
import net.minecraft.block.state.IBlockState;
import net.minecraft.entity.Entity;
import net.minecraft.entity.EntityLivingBase;
import net.minecraft.entity.item.EntityItem;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.inventory.IInventory;
import net.minecraft.inventory.InventoryHelper;
import net.minecraft.item.Item;
import net.minecraft.item.ItemBlock;
import net.minecraft.item.ItemStack;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.AxisAlignedBB;
import net.minecraft.util.BlockPos;
import net.minecraft.util.EnumFacing;
import net.minecraft.world.World;
import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;
import xreliquary.Reliquary;
import xreliquary.blocks.tile.TileEntityMortar;
import xreliquary.init.ModBlocks;
import xreliquary.reference.Names;

import java.util.List;
import java.util.Random;

public class BlockApothecaryMortar extends BlockBase {
    public static final PropertyDirection FACING = PropertyDirection.create("facing", EnumFacing.Plane.HORIZONTAL);

    public BlockApothecaryMortar() {
        super(Material.rock, Names.apothecary_mortar);
        this.setDefaultState(this.blockState.getBaseState().withProperty(FACING, EnumFacing.NORTH));
        this.setHardness(1.5F);
        this.setResistance(2.0F);
        this.setCreativeTab(Reliquary.CREATIVE_TAB);
        this.setBlockBounds(0.25F, 0.0F, 0.25F, 0.75F, 0.3125F, 0.75F);
    }
    @Override
    public void addCollisionBoxesToList(World world, BlockPos pos, IBlockState state, AxisAlignedBB mask, List list, Entity collidingEntity) {
        this.setBlockBounds(0.25F, 0.0F, 0.25F, 0.75F, 0.3125F, 0.75F);

        super.addCollisionBoxesToList(world, pos, state, mask, list, collidingEntity);
        this.setBlockBoundsForItemRender();
    }

    @Override
    public void setBlockBoundsForItemRender() {
        this.setBlockBounds(0.25F, 0F, 0.25F, 0.75F, 0.3F, 0.75F);
    }
    @Override
    public boolean isOpaqueCube() {
        return false;
    }

    @Override
    public IBlockState getStateFromMeta(int meta) {
        EnumFacing enumfacing = EnumFacing.NORTH;
        if (meta > -1) {
            enumfacing = EnumFacing.getFront(meta);

            if (enumfacing.getAxis() == EnumFacing.Axis.Y)
            {
                enumfacing = EnumFacing.NORTH;
            }
        }

        return this.getDefaultState().withProperty(FACING, enumfacing);
    }

    @Override
    public int getMetaFromState(IBlockState state) {
        return state.getValue(FACING).getIndex();
    }

    protected BlockState createBlockState()
    {
        return new BlockState(this, new IProperty[] {FACING});
    }
    @Override
    public boolean isFullCube() {
        return false;
    }
    @Override
    public int getRenderType() {
        return 2;
    }

    //TODO move to inventory helper
    private void tryRemovingLastStack(IInventory inventory, World worldObj, BlockPos pos) {
        for (int i = inventory.getSizeInventory() - 1; i>=0; i--) {
            ItemStack stack = inventory.getStackInSlot(i);
            if (stack != null) {
                inventory.setInventorySlotContents(i, null);
                if (worldObj.isRemote)
                    return;
                inventory.markDirty();
                EntityItem itemEntity = new EntityItem(worldObj, pos.getX() + 0.5D, pos.getY() + 0.5D, pos.getZ() + 0.5D, stack);
                worldObj.spawnEntityInWorld(itemEntity);
                break;
            }
        }
    }

    @Override
    public boolean onBlockActivated(World world, BlockPos pos, IBlockState state, EntityPlayer player, EnumFacing side, float xOff, float yOff, float zOff) {
        TileEntity tileEntity = world.getTileEntity(pos);
        if (tileEntity == null || !(tileEntity instanceof TileEntityMortar))
            return false;
        TileEntityMortar mortar = (TileEntityMortar) tileEntity;
        ItemStack heldItem = player.getCurrentEquippedItem();
        if (heldItem == null) {
            if ( player.isSneaking()) {
                tryRemovingLastStack(mortar, world, mortar.getPos());
                return true;
            }
            boolean done = mortar.usePestle();
            world.playSoundEffect(pos.getX() + 0.5F, pos.getY() + 0.5F, pos.getZ() + 0.5F, this.stepSound.getStepSound(), (this.stepSound.getVolume() + 1.0F) / 2.0F, this.stepSound.getFrequency() * 0.8F);
            player.swingItem();
            if (done) {
                return true;
            }
            return false;
        }
        ItemStack[] mortarItems = mortar.getItemStacks();
        boolean putItemInSlot = false;
        for (int slot = 0; slot < mortarItems.length; slot++) {
            ItemStack item = new ItemStack(player.getCurrentEquippedItem().getItem(), 1, player.getCurrentEquippedItem().getItemDamage());
            item.setTagCompound(player.getCurrentEquippedItem().getTagCompound());
            if (mortarItems[slot] == null && mortar.isItemValidForSlot(slot, item)) {
                player.getCurrentEquippedItem().stackSize--;
                if (player.getCurrentEquippedItem().stackSize == 0)
                    player.inventory.setInventorySlotContents(player.inventory.currentItem, null);
                mortar.setInventorySlotContents(slot, item);
                putItemInSlot = true;
                break;
            }
        }
        if (!putItemInSlot) {
            mortar.usePestle();
            world.playSoundEffect(pos.getX() + 0.5F, pos.getY() + 0.5F, pos.getZ() + 0.5F, this.stepSound.getStepSound(), (this.stepSound.getVolume() + 1.0F) / 2.0F, this.stepSound.getFrequency() * 0.8F);
            return false;
        }
        else {
            //TODO: make sure to optimize markDirty calls
            mortar.markDirty();
        }
        return true;
    }

    @Override
    public IBlockState onBlockPlaced(World worldIn, BlockPos pos, EnumFacing facing, float hitX, float hitY, float hitZ, int meta, EntityLivingBase placer) {
        return this.getDefaultState().withProperty(FACING, placer.getHorizontalFacing());
    }

    @Override
    public Item getItemDropped(IBlockState state, Random rand, int fortune) {
        // this might destroy the universe
        return ItemBlock.getItemFromBlock(ModBlocks.apothecaryMortar);
    }

    @SideOnly(Side.CLIENT)
    public Item getItem(World world, int x, int y, int z) {
        return ItemBlock.getItemFromBlock(ModBlocks.apothecaryMortar);
    }

    @Override
    public void breakBlock(World world, BlockPos pos, IBlockState state) {
        TileEntity tileentity = world.getTileEntity(pos);

        if (tileentity instanceof TileEntityMortar)
        {
            InventoryHelper.dropInventoryItems(world, pos, (TileEntityMortar) tileentity);
        }

        super.breakBlock(world, pos, state);
    }

    @Override
    public TileEntity createNewTileEntity(World var1, int dunnoWhatThisIs) {
        return new TileEntityMortar();
    }

}

 

 

TESR

 

package xreliquary.client.render;


import net.minecraft.client.Minecraft;
import net.minecraft.client.renderer.GlStateManager;
import net.minecraft.client.renderer.tileentity.TileEntitySpecialRenderer;
import net.minecraft.entity.item.EntityItem;
import net.minecraft.item.ItemStack;
import net.minecraft.util.EnumFacing;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.fml.client.FMLClientHandler;
import org.lwjgl.opengl.GL11;
import xreliquary.blocks.tile.TileEntityMortar;
import xreliquary.client.model.ModelMortar;
import xreliquary.reference.ClientReference;

public class RenderApothecaryMortar extends TileEntitySpecialRenderer<TileEntityMortar> {

    private ModelMortar modelMortar = new ModelMortar();
    private final float modifier = 0.0625f;

    @Override
    public void renderTileEntityAt(TileEntityMortar tile, double x, double y, double z, float var8, int i) {
        if (tile instanceof TileEntityMortar) {
            EnumFacing facing = EnumFacing.getFront(tile.getBlockMetadata());
            GlStateManager.pushMatrix();
            GlStateManager.disableCull();
            GlStateManager.translate((float) x + 0.5F, (float) y + 1.5F, (float) z + 0.5F);
            ResourceLocation textureName = ClientReference.MORTAR_TEXTURE;

            FMLClientHandler.instance().getClient().renderEngine.bindTexture(textureName);

            float horizontalRotation = facing == EnumFacing.UP ? 0f : facing.getHorizontalIndex() * 90f;

            GlStateManager.rotate(180F, 0.0F, 0.0F, 1.0F);
            GlStateManager.rotate(horizontalRotation, 0.0F, 1.0F, 0.0F);

            this.modelMortar.render(null, 0.0F, 0.0F, 0.0F, 0.0F, 0.0f, modifier);
            // TODO: Paving the way for the model rendering.
            this.modelMortar.pestle.render(modifier);
            this.modelMortar.pestleKnob.render(modifier);

            TileEntityMortar tileEntityMortar = tile;
            ItemStack[] mortarItems = tileEntityMortar.getItemStacks();

            if (mortarItems[0] != null) {
                EntityItem item = new EntityItem(tile.getWorld(), 0.0D, 0.0D, 0.0D, mortarItems[0]);
                item.getEntityItem().stackSize = 1;
                item.hoverStart = 0.0F;
                GlStateManager.pushMatrix();
                GlStateManager.translate(-0.07F, 1.375F, 0.07F);
                GlStateManager.rotate(180F, 1.0F, 0F, 0F);
                GlStateManager.rotate(1F, 0F, 0F, 1.0F);
                GlStateManager.rotate(horizontalRotation - Minecraft.getMinecraft().getRenderManager().playerViewY + 3.0F, 0.0f, 1.0f, 0.0f);
                GlStateManager.scale(0.40d, 0.40d, 0.40d);
                Minecraft.getMinecraft().getRenderManager().renderEntityWithPosYaw(item, 0.0D, 0.0D, 0.0D, 0.0F, 0.0F);
                GlStateManager.popMatrix();
            }

            if (mortarItems[1] != null) {
                EntityItem item = new EntityItem(tile.getWorld(), 0.0D, 0.0D, 0.0D, mortarItems[1]);
                item.getEntityItem().stackSize = 1;
                item.hoverStart = 0.0F;
                GlStateManager.pushMatrix();
                GlStateManager.translate(0.07F, 1.375F, 0.07F);
                GlStateManager.rotate(180F, 1.0F, 0F, 0F);
                GlStateManager.rotate(-1F, 0F, 0F, 1.0F);
                GlStateManager.rotate(horizontalRotation - Minecraft.getMinecraft().getRenderManager().playerViewY - 2.0F, 0.0f, 1.0f, 0.0f);
                GlStateManager.scale(0.40d, 0.40d, 0.40d);
                Minecraft.getMinecraft().getRenderManager().renderEntityWithPosYaw(item, 0.0D, 0.0D, 0.0D, 0.0F, 0.0F);
                GlStateManager.popMatrix();
            }

            if (mortarItems[2] != null) {
                EntityItem item = new EntityItem(tile.getWorld(), 0.0D, 0.0D, 0.0D, mortarItems[2]);
                item.getEntityItem().stackSize = 1;
                item.hoverStart = 0.0F;
                GlStateManager.pushMatrix();
                GlStateManager.translate(-0.07F, 1.375F, -0.07F);
                GlStateManager.rotate(180F, 1.0F, 0F, 0F);
                GlStateManager.rotate(-1F, 0F, 0F, 1.0F);
                GlStateManager.rotate(horizontalRotation - Minecraft.getMinecraft().getRenderManager().playerViewY - 2.0F, 0.0f, 1.0f, 0.0f);
                GlStateManager.scale(0.40d, 0.40d, 0.40d);
                Minecraft.getMinecraft().getRenderManager().renderEntityWithPosYaw(item, 0.0D, 0.0D, 0.0D, 0.0F, 0.0F);
                GlStateManager.popMatrix();
            }

            GlStateManager.popMatrix();
        }
    }
}

 

 

blockstates json (I know that normal shouldn't be required here, was just trying it with it as well, just in case it would help)

 

{
    "forge_marker": 1,
    "variants": {
        "normal": { "model": "xreliquary:apothecary_mortar" },
        "facing=north": { "model": "xreliquary:apothecary_mortar" },
        "facing=south": { "model": "xreliquary:apothecary_mortar", "y": 180 },
        "facing=west":  { "model": "xreliquary:apothecary_mortar", "y": 270 },
        "facing=east":  { "model": "xreliquary:apothecary_mortar", "y": 90 }
    }
}

 

 

If you wanted to check more this code is on github at https://github.com/P3pp3rF1y/Reliquary/tree/1.3.0

Link to post
Share on other sites
with preexisting meta (which would be -1 as there were no properties previously).
It would be 0 then, since that is what the default implementation of getMetaFromState does. -1 is not a possible metadata value.

The way it seems to me is that in the block registry it registers the new blockstates with the facing values, but doesn't have anything in there for the previous no property state and then just skips putting those blocks in the world.
The block registry has nothing to do with block states.

About the world save, all that is happening is that it stores the metadata (as produced by getMetaFromState) and then when it loads it again translates it using getStateFromMeta.

Block states are no fancy magic that get saved into the world save, only metadata is saved.

Your current

getStateFromMeta

uses

EnumFacing.getFront

. Since the previous metadata is 0 this will produce

DOWN

, which then (since it has axis Y) get's changed to

NORTH

. So all your old blocks will load with the facing north.

However, the current code never produces metadata 0 from a valid block state, since the facings on the horizontal plane have indices 2-5. This causes the current metadata 0 to not be mapped to any block state. So you need to make sure that NORTH still is saved as 0, not as 2. Easiest way would be to just getHorizontalIndex and EnumFacing.getHorizontal. This would mean however that existing blocks load facing south, not north.

 

Other comments on your code:

  • Do not just implement
    ITileEntityProvider

    on your base block. In fact, do not implement it at all. If you need a TileEntity override

    hasTileEntity

    and

    createTileEntity

    .

  • The
    breakBlock

    method in your base block is useless.

  • The explicit new array creation in your
    createBlockState

    is useless. You are calling a varargs method.

  • These checks are pointless.

Link to post
Share on other sites

Thanks a lot. That did the trick. I am still not sure why I haven't seen the meta 0 in the debug previously, but who cares now that it works :)

 

As for the code comments. The array in createBlockState is on me (copy paste from vanilla).

 

The others not so much as they are from the code I have inherited and still need to do more clean up. But thanks for pointing them out anyway. At least the pointless checks were not on my radar.

Link to post
Share on other sites
As for the code comments. The array in createBlockState is on me (copy paste from vanilla).
Varargs calls get compiled into an explicit array creation. So when we decompile the code from mojang the decompiler places it there.
Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...

Important Information

By using this site, you agree to our Privacy Policy.