Class BaseMod

java.lang.Object
  BaseMod

Direct Known Subclasses:

mod_Arrows, mod_Floodgate, mod_LightSensor, mod_Prefab, mod_RecipeBook, mod_SpawnerGUI, mod_Stackables

public abstract class BaseMod
extends java.lang.Object

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

Version:

Beta 1.3_01

Constructor Summary

BaseMod()

Method Summary

int	AddFuel(int id) Used for adding new sources of fuel to the furnace.
void	AddRecipes(fr recipes) Used to add recipes.
void	AddRenderer(java.util.Map<java.lang.Class<? extends om>,bb> renderers) Used to add entity renderers.
boolean	DispenseEntity(dt world, double x, double y, double z, float xVel, float zVel, int itemid) Dispenses the entity associated with the selected item.
void	GenerateNether(dt world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) in Nether.
void	GenerateSurface(dt world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) on the surface world.
void	KeyboardEvent(mk event) This method will be called when the register key has been pressed, or held down.
void	ModsLoaded() Called after all mods are loaded.
void	OnTickInGame(net.minecraft.client.Minecraft game) Called when enabled, and in game.
void	OnTickInGUI(net.minecraft.client.Minecraft game, cb gui) Called when enabled, and a GUI is open.
cb	OpenModGUI(fd player, java.lang.Class<? extends cb> guiclass, java.lang.Object instance) Opens GUI for use with mods.
void	RegisterAnimation(net.minecraft.client.Minecraft game) Used for registering animations for items and blocks.
void	RenderInvBlock(bw renderer, qk block, int metadata, int modelID) Renders a block in inventory.
boolean	RenderWorldBlock(bw renderer, so world, int x, int y, int z, qk block, int modelID) Renders a block in the world.
java.lang.String	toString()
abstract java.lang.String	Version() Required override that informs users the version of this mod.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMod

public BaseMod()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Version

public abstract java.lang.String Version()

Required override that informs users the version of this mod. Used in console and error reports.

Returns:

Version string.

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(fr recipes)

Used to add recipes.

Parameters:

recipes - Recipe instance to add to.

See Also:

ModLoader.AddAllRecipes(fr)

DispenseEntity

public boolean DispenseEntity(dt world,
                              double x,
                              double y,
                              double z,
                              float xVel,
                              float zVel,
                              int itemid)

Dispenses the entity associated with the selected item.

Parameters:

world - reference to the World.

x - X coordinate.

y - Y coordinate.

z - Z coordinate.

xVel - X velocity.

zVel - Z velocity.

itemid - ID of item to chosen to dispense entity.

Returns:

true if item was handled.

See Also:

ModLoader.DispenseEntity(dt, double, double, double, float, float, int)

AddRenderer

public void AddRenderer(java.util.Map<java.lang.Class<? extends om>,bb> 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, bb>)

GenerateNether

public void GenerateNether(dt 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(bo, int, int, dt)

GenerateSurface

public void GenerateSurface(dt 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(bo, int, int, dt)

OpenModGUI

public cb OpenModGUI(fd player,
                     java.lang.Class<? extends cb> guiclass,
                     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(fd, java.lang.Class, java.lang.Object)

OnTickInGUI

public void OnTickInGUI(net.minecraft.client.Minecraft game,
                        cb gui)

Called when enabled, and a GUI is open.

Parameters:

game - Instance of the Minecraft class.

gui - Current GUI that is open.

OnTickInGame

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

Called when enabled, and in game.

Parameters:

game - Instance of the Minecraft class.

RegisterAnimation

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

Used for registering animations for items and blocks.

Parameters:

game - Instance of the Minecraft class.

See Also:

ModLoader.RegisterAllTextureOverrides(hf), ModLoader.addAnimation(ah)

RenderWorldBlock

public boolean RenderWorldBlock(bw renderer,
                                so world,
                                int x,
                                int y,
                                int z,
                                qk block,
                                int modelID)

Renders a block in the world.

Parameters:

renderer - parent renderer. Methods and fields may be referenced from here.

world - to render block in.

x - XPos

y - YPos

z - ZPos

block - reference to block to render.

modelID - ID of block model to render.

Returns:

true if model was rendered.

RenderInvBlock

public void RenderInvBlock(bw renderer,
                           qk block,
                           int metadata,
                           int modelID)

Renders a block in inventory.

Parameters:

renderer - parent renderer. Methods and fields may be referenced from here.

block - reference to block to render.

metadata - of block. Damage on an item.

modelID - ID of block model to render.

KeyboardEvent

public void KeyboardEvent(mk event)

This method will be called when the register key has been pressed, or held down.

Parameters:

event - Reference to the key pressed.

ModsLoaded

public void ModsLoaded()

Called after all mods are loaded.