src/api/java/railcraft/api/tracks/TrackSpec.java

package mods.railcraft.api.tracks;

import java.util.List;
import java.util.Locale;
import net.minecraft.block.Block;
import net.minecraft.init.Blocks;
import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.util.IIcon;

/**
 * Each type of Track has a single instance of TrackSpec that corresponds with
 * it. Each Track block in the world has a ITrackInstance that corresponds with
 * it.
 *
 * Take note of the difference (similar to block classes and tile entities
 * classes).
 *
 * TrackSpecs must be registered with the TrackRegistry in either the Pre-Init
 * or Init Phases.
 *
 * Track ItemStacks can be acquired from the TrackSpec, but you are required to
 * register a proper display name yourself (during Post-Init).
 *
 * @see TrackRegistry
 * @see ITrackInstance
 *
 * @author CovertJaguar <http://www.railcraft.info>
 */
public final class TrackSpec {

    public static Block blockTrack;
    private final String tag;
    private final short trackId;
    private final List<String> tooltip;
    private final ITrackItemIconProvider iconProvider;
    private final Class<? extends ITrackInstance> instanceClass;

    /**
     * Defines a new track spec.
     *
     * @param trackId A unique identifier for the track type. 0-512 are reserved
     * for Railcraft. Capped at Short.MAX_VALUE
     * @param tag A unique internal string identifier (ex.
     * "railcraft:track.speed.transition")
     * @param iconProvider The provider for Track item icons
     * @param instanceClass The ITrackInstance class that corresponds to this
     * TrackSpec
     * @see ITextureProvider
     */
    public TrackSpec(short trackId, String tag, ITrackItemIconProvider iconProvider, Class<? extends ITrackInstance> instanceClass) {
        this(trackId, tag, iconProvider, instanceClass, null);
    }

    /**
     * Defines a new track spec.
     *
     * @param trackId A unique identifier for the track type. 0-512 are reserved
     * for Railcraft. Capped at Short.MAX_VALUE
     * @param tag A unique internal string identifier (ex.
     * "railcraft:track.speed.transition")
     * @param iconProvider The provider for Track item icons
     * @param instanceClass The ITrackInstance class that corresponds to this
     * TrackSpec
     * @param tooltip The tool tip for the Track Item
     * @see ITextureProvider
     */
    public TrackSpec(short trackId, String tag, ITrackItemIconProvider iconProvider, Class<? extends ITrackInstance> instanceClass, List<String> tooltip) {
        this.trackId = trackId;
        this.tag = tag.toLowerCase(Locale.ENGLISH);
        this.iconProvider = iconProvider;
        this.instanceClass = instanceClass;
        this.tooltip = tooltip;
    }

    public String getTrackTag() {
        return tag;
    }

    public short getTrackId() {
        return trackId;
    }

    /**
     * This function will only work after the Init Phase.
     *
     * @return an ItemStack that can be used to place the track.
     */
    public ItemStack getItem() {
        return getItem(1);
    }

    /**
     * This function will only work after the Init Phase.
     *
     * @param qty
     * @return an ItemStack that can be used to place the track.
     */
    public ItemStack getItem(int qty) {
        if (blockTrack != null) {
            ItemStack stack = new ItemStack(blockTrack, qty);
            NBTTagCompound nbt = new NBTTagCompound();
            nbt.setString("track", tag);
            stack.setTagCompound(nbt);
            return stack;
        }
        return null;
    }

    public ITrackInstance createInstanceFromSpec() {
        try {
            return (ITrackInstance) instanceClass.newInstance();
        } catch (Exception ex) {
            throw new RuntimeException("Improper Track Instance Constructor", ex);
        }
    }

    public IIcon getItemIcon() {
        if (iconProvider == null)
            return Blocks.rail.getIcon(0, 0);
        return iconProvider.getTrackItemIcon(this);
    }

    public List<String> getItemToolTip() {
        return tooltip;
    }
    
    @Override
    public String toString(){
        return "Track -> " + getTrackTag();
    }

}