PipeDefinition_BC8.java

package buildcraft.api.transport.pipe_bc8;

import java.util.Arrays;

import net.minecraft.client.Minecraft;
import net.minecraft.client.renderer.texture.TextureAtlasSprite;
import net.minecraft.client.renderer.texture.TextureMap;
import net.minecraft.util.ResourceLocation;

import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;

import buildcraft.api.ObjectDefinition;
import buildcraft.api.core.BCLog;

/** Contains all of the definitions of a pipe. */
public final class PipeDefinition_BC8 extends ObjectDefinition {
    /** The number of sprites to register related to this definition. */
    public final int maxSprites;
    /** A string containing the location of the texture of a pipe. The final texture location will be
     * {@link #textureLocationStart} + {@link #spriteLocations} */
    public final String textureLocationStart;
    /** An array containing the end locations of each pipe texture. This array have a length equal to maxSprites. It is
     * up to each indervidual pipe to determine which sprite to use for locations though. By default all of them will be
     * initialised to {@link #textureLocationStart}+{@link #modUniqueTag}+{The texture suffixes given to the
     * constructor} */
    private final String[] spriteLocations;
    /** A factory the creates the behaviour of this definition. */
    public final IPipeBehaviourFactory behaviourFactory;
    /** The type of this pipe. This determines how the pipe should be rendered and how the pipe should act. */
    public final IPipeType type;

    /** An array containing the actual sprites, where the positions are determined by {@link #spriteLocations} */
    @SideOnly(Side.CLIENT)
    private TextureAtlasSprite[] sprites;
    public final int itemSpriteIndex;

    public PipeDefinition_BC8(String tag, IPipeType type, String textureStart, String[] textureSuffixes, IPipeBehaviourFactory behaviour) {
        this(tag, type, 0, textureStart, textureSuffixes, behaviour);
    }

    /** @param tag A MOD-unique tag for the pipe
     * @param type The type of pipe this is
     * @param maxSprites The maximum number of sprites
     * @param itemSpriteIndex
     * @param textureStart
     * @param factory */
    public PipeDefinition_BC8(String tag, IPipeType type, int itemSpriteIndex, String textureStart, String[] textureSuffixes,
            IPipeBehaviourFactory factory) {
        super(tag);
        this.type = type;
        this.maxSprites = textureSuffixes == null ? 1 : textureSuffixes.length;
        this.itemSpriteIndex = itemSpriteIndex;
        this.textureLocationStart = textureStart.endsWith("/") ? textureStart : (textureStart + "/");
        this.spriteLocations = new String[maxSprites];
        for (int i = 0; i < maxSprites; i++) {
            spriteLocations[i] = textureLocationStart + modUniqueTag + (textureSuffixes == null ? "" : textureSuffixes[i]);
        }
        this.behaviourFactory = factory;
    }

    @SideOnly(Side.CLIENT)
    public TextureAtlasSprite getSprite(int index) {
        if (sprites == null || index < 0 || index >= sprites.length) {
            BCLog.logger.warn("Tried to get the sprite index " + index + " for " + globalUniqueTag);
            return Minecraft.getMinecraft().getTextureMapBlocks().getMissingSprite();
        }
        return sprites[index];
    }

    @SideOnly(Side.CLIENT)
    public void registerSprites(TextureMap map) {
        sprites = new TextureAtlasSprite[maxSprites];
        for (int i = 0; i < spriteLocations.length; i++) {
            String string = spriteLocations[i];
            ResourceLocation location = new ResourceLocation(string);
            sprites[i] = map.registerSprite(location);
        }
    }

    @Override
    public String toString() {
        return "PipeDefinition [globalUniqueTag=" + globalUniqueTag + ", modUniqueTag=" + modUniqueTag + ", behaviourFactory=" + behaviourFactory
            + ", type=" + type + ", spriteLocations=" + Arrays.toString(spriteLocations) + "]";
    }
}