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 */
014
015package cpw.mods.fml.common.modloader;
016
017import java.util.Random;
018
019import net.minecraft.entity.player.EntityPlayer;
020import net.minecraft.inventory.IInventory;
021import net.minecraft.item.ItemStack;
022import net.minecraft.network.INetworkManager;
023import net.minecraft.network.NetServerHandler;
024import net.minecraft.network.packet.NetHandler;
025import net.minecraft.network.packet.Packet250CustomPayload;
026import net.minecraft.world.World;
027
028import cpw.mods.fml.common.TickType;
029import cpw.mods.fml.relauncher.Side;
030import cpw.mods.fml.relauncher.SideOnly;
031
032/**
033 *
034 * Marker interface for BaseMod
035 *
036 * @author cpw
037 *
038 */
039public interface BaseModProxy
040{
041    void modsLoaded();
042
043    void load();
044
045    String getName();
046
047    String getPriorities();
048
049    String getVersion();
050
051    boolean doTickInGUI(TickType type, boolean end, Object... tickData);
052    boolean doTickInGame(TickType type, boolean end, Object... tickData);
053    void generateSurface(World w, Random random, int i, int j);
054    void generateNether(World w, Random random, int i, int j);
055    int addFuel(int itemId, int damage);
056    void takenFromCrafting(EntityPlayer player, ItemStack item, IInventory craftMatrix);
057    void takenFromFurnace(EntityPlayer player, ItemStack item);
058
059    public abstract void onClientLogout(INetworkManager manager);
060
061    public abstract void onClientLogin(EntityPlayer player);
062
063    public abstract void serverDisconnect();
064
065    public abstract void serverConnect(NetHandler handler);
066
067    public abstract void receiveCustomPacket(Packet250CustomPayload packet);
068
069    public abstract void clientChat(String text);
070
071    public abstract void onItemPickup(EntityPlayer player, ItemStack item);
072
073    public abstract void serverCustomPayload(NetServerHandler handler, Packet250CustomPayload packet);
074
075    public abstract void serverChat(NetServerHandler source, String message);
076}