001/*
002 * The FML Forge Mod Loader suite.
003 * Copyright (C) 2012 cpw
004 *
005 * This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free
006 * Software Foundation; either version 2.1 of the License, or any later version.
007 *
008 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
009 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
010 *
011 * You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51
012 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
013 */
014package cpw.mods.fml.common;
015
016import java.util.Random;
017
018import net.minecraft.world.World;
019import net.minecraft.world.chunk.IChunkProvider;
020
021
022/**
023 * This is called back during world generation. 
024 *
025 * @author cpw
026 *
027 */
028public interface IWorldGenerator
029{
030    /**
031     * Generate some world
032     *
033     * @param random the chunk specific {@link Random}.
034     * @param chunkX the chunk X coordinate of this chunk.
035     * @param chunkZ the chunk Z coordinate of this chunk.
036     * @param world : additionalData[0] The minecraft {@link World} we're generating for.
037     * @param chunkGenerator : additionalData[1] The {@link IChunkProvider} that is generating.
038     * @param chunkProvider : additionalData[2] {@link IChunkProvider} that is requesting the world generation.
039     *
040     */
041    public void generate(Random random, int chunkX, int chunkZ, World world, IChunkProvider chunkGenerator, IChunkProvider chunkProvider);
042}