Class BaseMod

java.lang.Object
  BaseMod

Direct Known Subclasses:

mod_Arrows, mod_Floodgate, mod_LightSensor

public abstract class BaseMod
extends java.lang.Object

Inherit this class in new mods for it to be used by ModLoader.

Version:

1.2.6

Constructor Summary

BaseMod()

Method Summary

void	AddEntityID() Place holder for calling the function that adds entity IDs, which are used for SMP, MobSpawner, and saving.
int	AddFuel(int id) Used for adding new sources of fuel to the furnace.
void	AddRecipes(en recipes) Used to add recipes.
void	AddRenderer(java.util.Map<java.lang.Class<? extends lw>,aq> renderers) Used to add entity renderers.
int	AddSmelting(int id) Used for adding new options to the furnace for item creation.
void	GenerateNether(cy world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) in Nether.
void	GenerateSurface(cy world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) on the surface world.
bp	OpenModGUI(bq player, java.lang.Object instance) Opens GUI for use with mods.
void	OSDHook(net.minecraft.client.Minecraft game) Used for displaying OSDs, called each frame
void	RegisterAnimation(net.minecraft.client.Minecraft game) Used for registering animations for items and blocks.
void	RegisterBlocks(java.util.List<nq> registry) Used to register blocks that the client can use.
void	RegisterTextureOverrides() Used for registering textures to be overlaid over internal tex buffers
void	RegisterTileEntity() Place holder for calling the function that adds TileEntities.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseMod

public BaseMod()

Method Detail

AddEntityID

public void AddEntityID()

Place holder for calling the function that adds entity IDs, which are used for SMP, MobSpawner, and saving.

See Also:

ModLoader.AddAllEntityIDs()

AddFuel

public int AddFuel(int id)

Used for adding new sources of fuel to the furnace.

Parameters:

id - ItemID for the item to use as fuel.

Returns:

Duration of fuel provided.

See Also:

ModLoader.AddAllFuel(int)

AddRecipes

public void AddRecipes(en recipes)

Used to add recipes.

Parameters:

recipes - Recipe instance to add to.

See Also:

ModLoader.AddAllRecipes(en)

AddRenderer

public void AddRenderer(java.util.Map<java.lang.Class<? extends lw>,aq> renderers)

Used to add entity renderers.

Parameters:

renderers - HashMap of the renderers. key is an entity class, value is the renderer.

See Also:

ModLoader.AddAllRenderers(java.util.Map, aq>)

AddSmelting

public int AddSmelting(int id)

Used for adding new options to the furnace for item creation.

Parameters:

id - ItemID of the input item.

Returns:

ItemID of the output item.

See Also:

ModLoader.AddAllSmelting(int)

GenerateNether

public void GenerateNether(cy world,
                           java.util.Random random,
                           int chunkX,
                           int chunkZ)

Used for generating new blocks (veins) in Nether.

Parameters:

world - Reference to world.

random - Instance of random to use.

chunkX - X coordinate of chunk.

chunkZ - Z coordinate of chunk.

See Also:

ModLoader.PopulateChunk(bd, int, int, cy)

GenerateSurface

public void GenerateSurface(cy world,
                            java.util.Random random,
                            int chunkX,
                            int chunkZ)

Used for generating new blocks (veins) on the surface world.

Parameters:

world - Reference to world.

random - Instance of random to use.

chunkX - X coordinate of chunk.

chunkZ - Z coordinate of chunk.

See Also:

ModLoader.PopulateChunk(bd, int, int, cy)

OpenModGUI

public bp OpenModGUI(bq player,
                     java.lang.Object instance)

Opens GUI for use with mods.

Parameters:

player - Player instance to open GUI for.

instance - Used for identifying which mod this call is for. Allows for passing extra data to GUI.

Returns:

GUI that mod created.

See Also:

ModLoader.OpenModGUI(bq, java.lang.Object)

OSDHook

public void OSDHook(net.minecraft.client.Minecraft game)

Used for displaying OSDs, called each frame

Parameters:

game - Instance of the game class

See Also:

ModLoader.RunOSDHooks(net.minecraft.client.Minecraft)

RegisterBlocks

public void RegisterBlocks(java.util.List<nq> registry)

Used to register blocks that the client can use.

Parameters:

registry - List of blocks to add to.

See Also:

ModLoader.RegisterAllBlocks(java.util.List)

RegisterTextureOverrides

public void RegisterTextureOverrides()

Used for registering textures to be overlaid over internal tex buffers

See Also:

ModLoader.RegisterAllTextureOverrides(fu), ModLoader.addOverride(java.lang.String, java.lang.String, int)

RegisterAnimation

public void RegisterAnimation(net.minecraft.client.Minecraft game)

Used for registering animations for items and blocks.

See Also:

ModLoader.RegisterAllTextureOverrides(fu), ModLoader.addAnimation(ad)

RegisterTileEntity

public void RegisterTileEntity()

Place holder for calling the function that adds TileEntities.

See Also:

ModLoader.RegisterAllTileEntities()