DimDoors/StevenDimDoors/mod_pocketDim/ticking/LimboDecay.java

package StevenDimDoors.mod_pocketDim.ticking;

import java.util.Random;

import net.minecraft.block.Block;
import net.minecraft.block.BlockContainer;
import net.minecraft.world.ChunkCoordIntPair;
import net.minecraft.world.World;
import net.minecraftforge.common.DimensionManager;
import StevenDimDoors.mod_pocketDim.DDProperties;

/**
 * Provides methods for applying Limbo decay. Limbo decay refers to the effect that most blocks placed in Limbo
 * naturally change into stone, then cobble, then gravel, and finally Unraveled Fabric as time passes.
 */
public class LimboDecay implements IRegularTickReceiver {

	private static final int MAX_DECAY_SPREAD_CHANCE = 100;
	private static final int DECAY_SPREAD_CHANCE = 50;
	private static final int CHUNK_SIZE = 16;
	private static final int SECTION_HEIGHT = 16;
	private static final int LIMBO_DECAY_INTERVAL = 10; //Apply spread decay every 10 ticks
	
	//Provides a reversed list of the block IDs that blocks cycle through during decay.
	private final int[] decaySequence;
	
	private final Random random;
	private final DDProperties properties;
	private final int[] blocksImmuneToDecay;
	
	public LimboDecay(IRegularTickSender tickSender, DDProperties properties)
	{
		decaySequence = new int[] {
			properties.LimboBlockID,
			Block.gravel.blockID,
			Block.cobblestone.blockID,
			Block.stone.blockID
		};
		
		blocksImmuneToDecay = new int[] {
			properties.LimboBlockID,
			properties.PermaFabricBlockID,
			properties.TransientDoorID,
			properties.DimensionalDoorID,
			properties.WarpDoorID,
			properties.RiftBlockID,
			properties.UnstableDoorID
		};
		
		this.properties = properties;
		this.random = new Random();
		tickSender.registerForTicking(this, LIMBO_DECAY_INTERVAL, false);
	}

	/**
	 * Applies fast Limbo decay periodically.
	 */
	@Override
	public void notifyTick()
	{
		applyRandomFastDecay();
	}

	/**
	 * Checks the blocks orthogonally around a given location (presumably the location of an Unraveled Fabric block)
	 * and applies Limbo decay to them. This gives the impression that decay spreads outward from Unraveled Fabric.
	 */
	public void applySpreadDecay(World world, int x, int y, int z)
	{		
		//Check if we randomly apply decay spread or not. This can be used to moderate the frequency of
		//full spread decay checks, which can also shift its performance impact on the game.
		if (random.nextInt(MAX_DECAY_SPREAD_CHANCE) < DECAY_SPREAD_CHANCE)
		{
			//Apply decay to the blocks above, below, and on all four sides.
			//World.getBlockId() implements bounds checking, so we don't have to worry about reaching out of the world
			decayBlock(world, x - 1, y, z);
			decayBlock(world, x + 1, y, z);
			decayBlock(world, x, y, z - 1);
			decayBlock(world, x, y, z + 1);
			decayBlock(world, x, y - 1, z);
			decayBlock(world, x, y + 1, z);
		}
	}
	
	/**
	 * Picks random blocks from each active chunk in Limbo and, if decay is applicable, converts them directly to Unraveled Fabric.
	 * This decay method is designed to stop players from avoiding Limbo decay by building floating structures.
	 */
	private void applyRandomFastDecay()
	{
		int x, y, z;
		int sectionY;
		int limboHeight;
		World limbo = DimensionManager.getWorld(properties.LimboDimensionID);
		
		if (limbo != null)
		{
			limboHeight = limbo.getHeight();
			
			//Obtain the coordinates of active chunks in Limbo. For each section of each chunk,
			//pick a random block and try to apply fast decay.
			for (Object coordObject : limbo.activeChunkSet)
			{
				ChunkCoordIntPair chunkCoord = (ChunkCoordIntPair) coordObject;
				
				//Loop through each chunk section and fast-decay a random block
				//Apply the changes using the world object instead of directly to the chunk so that clients are always notified.
				for (sectionY = 0; sectionY < limboHeight; sectionY += SECTION_HEIGHT)
				{
					x = chunkCoord.chunkXPos * CHUNK_SIZE + random.nextInt(CHUNK_SIZE);
					z = chunkCoord.chunkZPos * CHUNK_SIZE + random.nextInt(CHUNK_SIZE);
					y = sectionY + random.nextInt(SECTION_HEIGHT);
					decayBlockFast(limbo, x, y, z);
				}
			}
		}
	}
	
	/**
	 * Checks if a block can be decayed and, if so, changes it directly into Unraveled Fabric.
	 */
	private boolean decayBlockFast(World world, int x, int y, int z)
	{
		int blockID = world.getBlockId(x, y, z);
		if (canDecayBlock(blockID))
		{
			world.setBlock(x, y, z, properties.LimboBlockID);
			return true;
		}
		return false;
	}
	
	/**
	 * Checks if a block can be decayed and, if so, changes it to the next block ID along the decay sequence.
	 */
	private boolean decayBlock(World world, int x, int y, int z)
	{
		int index;
		int blockID = world.getBlockId(x, y, z);
		if (canDecayBlock(blockID))
		{
			//Loop over the block IDs that decay can go through.
			//Find an index matching the current blockID, if any.
			for (index = 0; index < decaySequence.length; index++)
			{
				if (decaySequence[index] == blockID)
				{
					break;
				}
			}
			
			//Since the decay sequence is a reversed list, the block ID in the index before our match
			//is the block ID we should change this block into. A trick in this approach is that if
			//we loop over the array without finding a match, then (index - 1) will contain the
			//last ID in the array, which is the first one that all blocks decay into.
			//We assume that Unraveled Fabric is NOT decayable. Otherwise, this will go out of bounds!
			
			world.setBlock(x, y, z, decaySequence[index - 1]);
			return true;
		}
		return false;
	}
	
	/**
	 * Checks if a block can decay. We will not decay air, certain DD blocks, or containers.
	 */
	private boolean canDecayBlock(int blockID)
	{
		if (blockID == 0)
		{
			return false;
		}
		
		for (int k = 0; k < blocksImmuneToDecay.length; k++)
		{
			if (blockID == blocksImmuneToDecay[k])
			{
				return false;
			}
		}
		
		Block block = Block.blocksList[blockID];
		return (block == null || !(block instanceof BlockContainer));
	}
}