net.minecraft.src.BaseMod Class Reference

Inheritance diagram for net.minecraft.src.BaseMod:

Public Member Functions
final boolean	doTickInGame (TickType tick, boolean tickEnd, Object...data)
final boolean	doTickInGUI (TickType tick, boolean tickEnd, Object...data)
int	addFuel (int id, int metadata)
void	addRenderer (Map< Class<?extends Entity >, Render > renderers)
void	generateNether (World world, Random random, int chunkX, int chunkZ)
void	generateSurface (World world, Random random, int chunkX, int chunkZ)
GuiContainer	getContainerGUI (EntityClientPlayerMP player, int containerID, int x, int y, int z)
String	getName ()
String	getPriorities ()
abstract String	getVersion ()
void	keyboardEvent (KeyBinding event)
abstract void	load ()
void	modsLoaded ()
void	onItemPickup (EntityPlayer player, ItemStack item)
boolean	onTickInGame (float time, Minecraft minecraftInstance)
boolean	onTickInGame (MinecraftServer minecraftServer)
boolean	onTickInGUI (float tick, Minecraft game, GuiScreen gui)
void	clientChat (String text)
void	clientConnect (NetClientHandler handler)
void	clientDisconnect (NetClientHandler handler)
void	receiveCustomPacket (Packet250CustomPayload packet)
void	registerAnimation (Minecraft game)
void	renderInvBlock (RenderBlocks renderer, Block block, int metadata, int modelID)
boolean	renderWorldBlock (RenderBlocks renderer, IBlockAccess world, int x, int y, int z, Block block, int modelID)
void	serverConnect (NetHandler handler)
void	serverCustomPayload (NetServerHandler handler, Packet250CustomPayload packet)
void	serverDisconnect ()
void	takenFromCrafting (EntityPlayer player, ItemStack item, IInventory matrix)
void	takenFromFurnace (EntityPlayer player, ItemStack item)
String	toString ()
void	serverChat (NetServerHandler source, String message)
void	onClientLogin (EntityPlayer player)
void	onClientLogout (INetworkManager mgr)
Entity	spawnEntity (int entityId, World world, double scaledX, double scaledY, double scaledZ)
void	clientCustomPayload (NetClientHandler handler, Packet250CustomPayload packet)

Member Function Documentation

int net.minecraft.src.BaseMod.addFuel	(	int	id,
		int	metadata
	)

Override if you wish to provide a fuel item for the furnace and return the fuel value of the item

Parameters

id
metadata

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.addRenderer

(

Map< Class<?extends Entity >, Render >

renderers)

void net.minecraft.src.BaseMod.clientChat ( String  text)

virtual

Only implemented on the client side serverChat(NetServerHandler, String)

Parameters

text

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.clientConnect

(

NetClientHandler

handler)

Called when a client connects

Parameters

handler

void net.minecraft.src.BaseMod.clientCustomPayload	(	NetClientHandler	handler,
		Packet250CustomPayload	packet
	)

void net.minecraft.src.BaseMod.clientDisconnect

(

NetClientHandler

handler)

Called when the client disconnects

Parameters

handler

final boolean net.minecraft.src.BaseMod.doTickInGame	(	TickType	tick,
		boolean	tickEnd,
		Object...	data
	)

Implements cpw.mods.fml.common.modloader.BaseModProxy.

final boolean net.minecraft.src.BaseMod.doTickInGUI	(	TickType	tick,
		boolean	tickEnd,
		Object...	data
	)

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.generateNether	(	World	world,
		Random	random,
		int	chunkX,
		int	chunkZ
	)

Override if you wish to generate Nether (Hell biome) blocks

Parameters

world
random
chunkX
chunkZ

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.generateSurface	(	World	world,
		Random	random,
		int	chunkX,
		int	chunkZ
	)

Override if you wish to generate Overworld (not hell or the end) blocks

Parameters

world
random
chunkX
chunkZ

Implements cpw.mods.fml.common.modloader.BaseModProxy.

GuiContainer net.minecraft.src.BaseMod.getContainerGUI	(	EntityClientPlayerMP	player,
		int	containerID,
		int	x,
		int	y,
		int	z
	)

Callback to return a gui screen to display

Parameters

player
containerID
x
y
z

String net.minecraft.src.BaseMod.getName

(

)

Return the name of your mod. Defaults to the class name

Implements cpw.mods.fml.common.modloader.BaseModProxy.

String net.minecraft.src.BaseMod.getPriorities

(

)

Get your mod priorities

Implements cpw.mods.fml.common.modloader.BaseModProxy.

abstract String net.minecraft.src.BaseMod.getVersion ( )

pure virtual

Return the version of your mod

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.keyboardEvent

(

KeyBinding

event)

abstract void net.minecraft.src.BaseMod.load ( )

pure virtual

Load your mod

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.modsLoaded

(

)

Finish loading your mod

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.onClientLogin ( EntityPlayer  player)

virtual

Called when a new client logs in.

NOTE: this method is not provided in Risugami's implementation of BaseMod!

Parameters

player

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.onClientLogout ( INetworkManager  mgr)

virtual

Called when a client logs out of the server.

NOTE: this method is not provided in Risugami's implementation of BaseMod!

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.onItemPickup ( EntityPlayer  player, ItemStack  item  )

virtual

Handle item pickup

Parameters

player
item

Implements cpw.mods.fml.common.modloader.BaseModProxy.

boolean net.minecraft.src.BaseMod.onTickInGame	(	float	time,
		Minecraft	minecraftInstance
	)

Ticked every game tick if you have subscribed to tick events through ModLoader#setInGameHook(BaseMod, boolean, boolean)

Parameters

time	the rendering subtick time (0.0-1.0)
minecraftInstance	the client

Returns

true to continue receiving ticks

boolean net.minecraft.src.BaseMod.onTickInGame

(

MinecraftServer

minecraftServer)

boolean net.minecraft.src.BaseMod.onTickInGUI	(	float	tick,
		Minecraft	game,
		GuiScreen	gui
	)

void net.minecraft.src.BaseMod.receiveCustomPacket ( Packet250CustomPayload  packet)

virtual

Called client side to receive a custom payload for this mod

NOTE: this method is not provided in Risugami's implementation of BaseMod!

Parameters

packet

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.registerAnimation

(

Minecraft

game)

void net.minecraft.src.BaseMod.renderInvBlock	(	RenderBlocks	renderer,
		Block	block,
		int	metadata,
		int	modelID
	)

boolean net.minecraft.src.BaseMod.renderWorldBlock	(	RenderBlocks	renderer,
		IBlockAccess	world,
		int	x,
		int	y,
		int	z,
		Block	block,
		int	modelID
	)

void net.minecraft.src.BaseMod.serverChat ( NetServerHandler  source, String  message  )

virtual

Called when a chat message is received. Return true to stop further processing

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.serverConnect ( NetHandler  handler)

virtual

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.serverCustomPayload ( NetServerHandler  handler, Packet250CustomPayload  packet  )

virtual

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.serverDisconnect ( )

virtual

Implements cpw.mods.fml.common.modloader.BaseModProxy.

Entity net.minecraft.src.BaseMod.spawnEntity	(	int	entityId,
		World	world,
		double	scaledX,
		double	scaledY,
		double	scaledZ
	)

Spawn the entity of the supplied type, if it is your mod's

void net.minecraft.src.BaseMod.takenFromCrafting	(	EntityPlayer	player,
		ItemStack	item,
		IInventory	matrix
	)

Called when someone crafts an item from a crafting table

Parameters

player
item
matrix

Implements cpw.mods.fml.common.modloader.BaseModProxy.

void net.minecraft.src.BaseMod.takenFromFurnace	(	EntityPlayer	player,
		ItemStack	item
	)

Called when someone takes a smelted item from a furnace

Parameters

player
item

Implements cpw.mods.fml.common.modloader.BaseModProxy.

String net.minecraft.src.BaseMod.toString

(

)

The identifier string for the mod- used in client<->server negotiation

---

The documentation for this class was generated from the following file:

• C:/Users/LazDude/Downloads/MinecraftModding/YATS/forge/mcp/src/minecraft/net/minecraft/src/BaseMod.java