Class BaseMod

java.lang.Object
  BaseMod

Direct Known Subclasses:

mod_Armor, mod_Arrows, mod_Biosphere, mod_Floodgate, mod_LightSensor, mod_MipMap, mod_RecipeBook, mod_Shelf, 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:

1.2.3

Constructor Summary

BaseMod()

Method Summary

int	addFuel(int id, int metadata) Used for adding new sources of fuel to the furnace.
void	addRenderer(java.util.Map<java.lang.Class<? extends nk>,ui> renderers) Used to add entity renderers.
boolean	dispenseEntity(wz world, double x, double y, double z, int xVel, int zVel, aai item) Dispenses the entity associated with the selected item.
void	generateNether(wz world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) in Nether.
void	generateSurface(wz world, java.util.Random random, int chunkX, int chunkZ) Used for generating new blocks (veins) on the surface world.
java.lang.String	getName() Descriptive name for this class.
java.lang.String	getPriorities() This method will tell ModLoader what must come before or after a mod.
abstract java.lang.String	getVersion() Required override that informs users the version of this mod.
void	keyboardEvent(afp event) This method will be called when the register key has been pressed, or held down.
abstract void	load() Required override.
void	modsLoaded() Called after all mods are loaded.
void	onItemPickup(yr player, aai item) Is called when an item is picked up from the world.
boolean	onTickInGame(float tick, net.minecraft.client.Minecraft game) Called when enabled, and in game.
boolean	onTickInGUI(float tick, net.minecraft.client.Minecraft game, vl gui) Called when enabled, and a GUI is open.
void	registerAnimation(net.minecraft.client.Minecraft game) Used for registering animations for items and blocks.
void	renderInvBlock(vh renderer, ox block, int metadata, int modelID) Renders a block in inventory.
boolean	renderWorldBlock(vh renderer, alc world, int x, int y, int z, ox block, int modelID) Renders a block in the world.
void	takenFromCrafting(yr player, aai item, il matrix) Is called when an item is picked up from crafting result slot.
void	takenFromFurnace(yr player, aai item) Is called when an item is picked up from furnace result slot.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMod

public BaseMod()

Method Detail

addFuel

public int addFuel(int id,
                   int metadata)

Used for adding new sources of fuel to the furnace.

Parameters:

id - ItemID for the item to use as fuel.

metadata -

Returns:

Duration of fuel provided.

See Also:

ModLoader.addAllFuel(int, int)

addRenderer

public void addRenderer(java.util.Map<java.lang.Class<? extends nk>,ui> 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, ui>)

dispenseEntity

public boolean dispenseEntity(wz world,
                              double x,
                              double y,
                              double z,
                              int xVel,
                              int zVel,
                              aai item)

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.

item - ID of item to chosen to dispense entity.

Returns:

true if item was handled.

See Also:

ModLoader.dispenseEntity(wz, double, double, double, int, int, aai)

generateNether

public void generateNether(wz 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(bx, int, int, wz)

generateSurface

public void generateSurface(wz 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(bx, int, int, wz)

getName

public java.lang.String getName()

Descriptive name for this class. Defaults to class name.

Returns:

the name

getPriorities

public java.lang.String getPriorities()

This method will tell ModLoader what must come before or after a mod. Examples:

require-before:*	Require that this mod come before all other mods.
require-after:*	Require that this mod come after all other mods.
before:*	Says that this mod may come before all other mods.
after:*	Says that this mod may come after all other mods.
before:mod_x	Says that this mod may come before mod_x
after:mod_x	Says that this mod may come after mod_x
after:mod_x;after:mod_y	Says that this mod may come after mod_x and mod_y

Returns:

priority

getVersion

public abstract java.lang.String getVersion()

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

Returns:

Version version.

keyboardEvent

public void keyboardEvent(afp event)

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

Parameters:

event - Reference to the key pressed.

See Also:

ModLoader.registerKey(BaseMod, afp, boolean)

load

public abstract void load()

Required override. Put EVERYTHING that has any relation to minecraft in here that needs to be added to the game when loaded. This includes blocks and items.

modsLoaded

public void modsLoaded()

Called after all mods are loaded.

onItemPickup

public void onItemPickup(yr player,
                         aai item)

Is called when an item is picked up from the world.

Parameters:

player - that picked up item

item - that was picked up

onTickInGame

public boolean onTickInGame(float tick,
                            net.minecraft.client.Minecraft game)

Called when enabled, and in game.

Parameters:

tick - Partial tick. Used for smooth animation.

game - Instance of the Minecraft class.

Returns:

true to continue ticking, or false to stop ticking.

onTickInGUI

public boolean onTickInGUI(float tick,
                           net.minecraft.client.Minecraft game,
                           vl gui)

Called when enabled, and a GUI is open.

Parameters:

tick - Partial tick. Used for smooth animation.

game - Instance of the Minecraft class.

gui - Current GUI that is open.

Returns:

true to continue ticking, or false to stop ticking.

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(aar), ModLoader.addAnimation(tp)

renderInvBlock

public void renderInvBlock(vh renderer,
                           ox 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.

renderWorldBlock

public boolean renderWorldBlock(vh renderer,
                                alc world,
                                int x,
                                int y,
                                int z,
                                ox 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.

takenFromCrafting

public void takenFromCrafting(yr player,
                              aai item,
                              il matrix)

Is called when an item is picked up from crafting result slot. Normally used to award achievements.

Parameters:

player - that picked up item

item - that was picked up

matrix - crafting matrix that is used

takenFromFurnace

public void takenFromFurnace(yr player,
                             aai item)

Is called when an item is picked up from furnace result slot. Normally used to award achievements.

Parameters:

player - that picked up item

item - that was picked up

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object