|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectModLoader
public final class ModLoader
ModLoader loads classes that inherit from BaseMod
and adds them to a
list for use.
Field Summary | |
---|---|
static java.util.logging.Level |
cfgLoggingLevel
Default logging level. |
static boolean |
DEBUG
Whether debug mode is enabled. |
static java.util.Properties |
props
Contains all the properties loaded from config file. |
static java.lang.String |
VERSION
Current version. |
Method Summary | ||
---|---|---|
static void |
addAchievementDesc(adw achievement,
java.lang.String name,
java.lang.String description)
Used to give your achievement a readable name and description. |
|
static int |
addAllFuel(int id,
int metadata)
Used for adding new sources of fuel to the furnace. |
|
static void |
addAllRenderers(java.util.Map<java.lang.Class<? extends nk>,ui> renderers)
Used to add all mod entity renderers. |
|
static void |
addAnimation(tp anim)
Registers one animation instance. |
|
static int |
addArmor(java.lang.String armor)
Use this when you need the player to have new armor skin. |
|
static void |
addBiome(abi biome)
Method for adding new biomes to the terrain generator. |
|
static void |
addLocalization(java.lang.String key,
java.lang.String value)
Method for adding raw strings to the translation table. |
|
static void |
addLocalization(java.lang.String key,
java.lang.String lang,
java.lang.String value)
Method for adding raw strings to the translation table. |
|
static void |
addName(java.lang.Object instance,
java.lang.String name)
This method will allow adding name to item in inventory. |
|
static void |
addName(java.lang.Object instance,
java.lang.String lang,
java.lang.String name)
This method will allow adding name to item in inventory. |
|
static int |
addOverride(java.lang.String fileToOverride,
java.lang.String fileToAdd)
Use this to add custom images for your items and blocks. |
|
static void |
addOverride(java.lang.String path,
java.lang.String overlayPath,
int index)
Registers one texture override to be done. |
|
static void |
addRecipe(aai output,
java.lang.Object... params)
Add recipe to crafting list. |
|
static void |
addShapelessRecipe(aai output,
java.lang.Object... params)
Add recipe to crafting list. |
|
static void |
addSmelting(int input,
aai output)
Used to add smelting recipes to the furnace. |
|
static void |
addSpawn(java.lang.Class<? extends acl> entityClass,
int weightedProb,
int min,
int max,
aca spawnList)
Add entity to spawn list for all biomes except Hell. |
|
static void |
addSpawn(java.lang.Class<? extends acl> entityClass,
int weightedProb,
int min,
int max,
aca spawnList,
abi... biomes)
Add entity to spawn list for selected biomes. |
|
static void |
addSpawn(java.lang.String entityName,
int weightedProb,
int min,
int max,
aca spawnList)
Add entity to spawn list for all biomes except Hell. |
|
static void |
addSpawn(java.lang.String entityName,
int weightedProb,
int min,
int max,
aca spawnList,
abi... biomes)
Add entity to spawn list for selected biomes. |
|
static boolean |
dispenseEntity(wz world,
double x,
double y,
double z,
int xVel,
int zVel,
aai item)
Dispenses the entity associated with the selected item. |
|
static void |
genericContainerRemoval(wz world,
int x,
int y,
int z)
|
|
static java.util.List<BaseMod> |
getLoadedMods()
Use this method if you need a list of loaded mods. |
|
static java.util.logging.Logger |
getLogger()
Use this to get a reference to the logger ModLoader uses. |
|
static net.minecraft.client.Minecraft |
getMinecraftInstance()
Use this method to get a reference to Minecraft instance. |
|
static
|
getPrivateValue(java.lang.Class<? super E> instanceclass,
E instance,
int fieldindex)
Used for getting value of private fields. |
|
static
|
getPrivateValue(java.lang.Class<? super E> instanceclass,
E instance,
java.lang.String field)
Used for getting value of private fields. |
|
static int |
getUniqueBlockModelID(BaseMod mod,
boolean full3DItem)
Assigns a model id for blocks to use for the given mod. |
|
static int |
getUniqueEntityId()
Gets next Entity ID to use. |
|
static int |
getUniqueSpriteIndex(java.lang.String path)
Gets next available index for this sprite map. |
|
static boolean |
isGUIOpen(java.lang.Class<? extends vl> gui)
Use this method to check if GUI is opened for the player. |
|
static boolean |
isModLoaded(java.lang.String modname)
Checks if a mod is loaded. |
|
static void |
loadConfig()
Reads the config file and stores the contents in props. |
|
static java.awt.image.BufferedImage |
loadImage(aar texCache,
java.lang.String path)
Loads an image from a file in the jar into a BufferedImage. |
|
static void |
onItemPickup(yr player,
aai item)
Is called when an item is picked up from the world. |
|
static void |
onTick(float tick,
net.minecraft.client.Minecraft game)
This method is called every tick while minecraft is running. |
|
static void |
openGUI(yr player,
vl gui)
Opens GUI for use with mods. |
|
static void |
populateChunk(bx generator,
int chunkX,
int chunkZ,
wz world)
Used for generating new blocks in the world. |
|
static afp[] |
registerAllKeys(afp[] keys)
Appends all mod key handlers to the given array and returns it. |
|
static void |
registerAllTextureOverrides(aar cache)
Processes all registered texture overrides. |
|
static void |
registerBlock(ox block)
Adds block to list of blocks the player can use. |
|
static void |
registerBlock(ox block,
java.lang.Class<? extends uz> itemclass)
Adds block to list of blocks the player can use. |
|
static void |
registerEntityID(java.lang.Class<? extends nk> entityClass,
java.lang.String entityName,
int id)
Registers an entity ID. |
|
static void |
registerEntityID(java.lang.Class<? extends nk> entityClass,
java.lang.String entityName,
int id,
int background,
int foreground)
Registers an entity ID. |
|
static void |
registerKey(BaseMod mod,
afp keyHandler,
boolean allowRepeat)
Use this to add an assignable key to the options menu. |
|
static void |
registerTileEntity(java.lang.Class<? extends kt> tileEntityClass,
java.lang.String id)
Registers a tile entity. |
|
static void |
registerTileEntity(java.lang.Class<? extends kt> tileEntityClass,
java.lang.String id,
aam renderer)
Registers a tile entity. |
|
static void |
removeBiome(abi biome)
Method for removing biomes from the terrain generator. |
|
static void |
removeSpawn(java.lang.Class<? extends acl> entityClass,
aca spawnList)
Remove entity from spawn list for all biomes except Hell. |
|
static void |
removeSpawn(java.lang.Class<? extends acl> entityClass,
aca spawnList,
abi... biomes)
Remove entity from spawn list for selected biomes. |
|
static void |
removeSpawn(java.lang.String entityName,
aca spawnList)
Remove entity from spawn list for all biomes except Hell. |
|
static void |
removeSpawn(java.lang.String entityName,
aca spawnList,
abi... biomes)
Remove entity from spawn list for selected biomes. |
|
static boolean |
renderBlockIsItemFull3D(int modelID)
Determines how the block should be rendered. |
|
static void |
renderInvBlock(vh renderer,
ox block,
int metadata,
int modelID)
Renders a block in inventory. |
|
static boolean |
renderWorldBlock(vh renderer,
alc world,
int x,
int y,
int z,
ox block,
int modelID)
Renders a block in the world. |
|
static void |
saveConfig()
Saves props to the config file. |
|
static void |
setInGameHook(BaseMod mod,
boolean enable,
boolean useClock)
Enable or disable BaseMod.onTickInGame(float, net.minecraft.client.Minecraft) |
|
static void |
setInGUIHook(BaseMod mod,
boolean enable,
boolean useClock)
Enable or disable BaseMod.onTickInGUI(float, net.minecraft.client.Minecraft, vl) |
|
static
|
setPrivateValue(java.lang.Class<? super T> instanceclass,
T instance,
int fieldindex,
E value)
Used for setting value of private fields. |
|
static
|
setPrivateValue(java.lang.Class<? super T> instanceclass,
T instance,
java.lang.String field,
E value)
Used for setting value of private fields. |
|
static void |
takenFromCrafting(yr player,
aai item,
il matrix)
Is called when an item is picked up from crafting result slot. |
|
static void |
takenFromFurnace(yr player,
aai item)
Is called when an item is picked up from furnace result slot. |
|
static void |
throwException(java.lang.String message,
java.lang.Throwable e)
Used for catching an error and generating an error report. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.util.logging.Level cfgLoggingLevel
public static final boolean DEBUG
public static final java.util.Properties props
public static final java.lang.String VERSION
Method Detail |
---|
public static void addAchievementDesc(adw achievement, java.lang.String name, java.lang.String description)
achievement
- to assign name and description to.name
- title of your achievementdescription
- details on how to earn this achievementpublic static int addAllFuel(int id, int metadata)
id
- ItemID for the item to use as fuel.metadata
- Extended data for the item.
BaseMod.addFuel(int, int)
public static void addAllRenderers(java.util.Map<java.lang.Class<? extends nk>,ui> renderers)
renderers
- HashMap of the renderers. key is an entity class, value is
the renderer.BaseMod.addRenderer(java.util.Map, ui>)
public static void addAnimation(tp anim)
anim
- instance of animation handler.public static int addArmor(java.lang.String armor)
armor
- Name of the armor skin.
public static void addBiome(abi biome)
biome
- Reference to biome.public static void addLocalization(java.lang.String key, java.lang.String value)
key
- tag for string.value
- string to add.public static void addLocalization(java.lang.String key, java.lang.String lang, java.lang.String value)
key
- tag for string.value
- string to add.public static void addName(java.lang.Object instance, java.lang.String name)
instance
- A block, item, or item stack reference to name.name
- The name to give.public static void addName(java.lang.Object instance, java.lang.String lang, java.lang.String name)
instance
- A block, item, or item stack reference to name.name
- The name to give.public static int addOverride(java.lang.String fileToOverride, java.lang.String fileToAdd)
fileToOverride
- "/terrain.png" or "/gui/items.png".fileToAdd
- path to the image you want to add.
public static void addOverride(java.lang.String path, java.lang.String overlayPath, int index)
path
- Path to the texture file to modify.overlayPath
- Path to the texture file which is to be overlaid.index
- Sprite index into the texture to be modified.public static void addRecipe(aai output, java.lang.Object... params)
output
- ItemStack to create.params
- The recipe. First one to three params should be strings
representing the layout of the recipe. Each string should be up to
three letters. Following that is a pair of Character and Item,
Block, or ItemStack references. The Character should match the one
used in first three params.public static void addShapelessRecipe(aai output, java.lang.Object... params)
output
- ItemStack to create.params
- The recipe. An array of Item, Block, or ItemStack references.public static void addSmelting(int input, aai output)
input
- ID of the item, or block, to smelt.output
- the ItemStack created.public static void addSpawn(java.lang.Class<? extends acl> entityClass, int weightedProb, int min, int max, aca spawnList)
entityClass
- Class of entity to spawn.weightedProb
- Higher number means more likely to spawn.min
- Minimum number of entities per spawn attempt.max
- Maximum number of entities per spawn attempt.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.public static void addSpawn(java.lang.Class<? extends acl> entityClass, int weightedProb, int min, int max, aca spawnList, abi... biomes)
entityClass
- Class of entity to spawn.weightedProb
- Higher number means more likely to spawn.min
- Minimum number of entities per spawn attempt.max
- Maximum number of entities per spawn attempt.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.biomes
- Array of biomes to add entity spawning to.public static void addSpawn(java.lang.String entityName, int weightedProb, int min, int max, aca spawnList)
entityName
- Name of entity to spawn.weightedProb
- Higher number means more likely to spawn.min
- Minimum number of entities per spawn attempt.max
- Maximum number of entities per spawn attempt.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.public static void addSpawn(java.lang.String entityName, int weightedProb, int min, int max, aca spawnList, abi... biomes)
entityName
- Name of entity to spawn.weightedProb
- Higher number means more likely to spawn.min
- Minimum number of entities per spawn attempt.max
- Maximum number of entities per spawn attempt.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.biomes
- Array of biomes to add entity spawning to.public static boolean dispenseEntity(wz world, double x, double y, double z, int xVel, int zVel, aai item)
world
- reference to the World.x
- X coordinate.y
- Y coordinate.z
- Z coordinate.xVel
- X velocity.zVel
- Z velocity.item
- Item to chosen to dispense entity.
BaseMod.dispenseEntity(wz, double, double, double, int, int, aai)
public static void genericContainerRemoval(wz world, int x, int y, int z)
public static java.util.List<BaseMod> getLoadedMods()
public static java.util.logging.Logger getLogger()
public static net.minecraft.client.Minecraft getMinecraftInstance()
public static <T,E> T getPrivateValue(java.lang.Class<? super E> instanceclass, E instance, int fieldindex) throws java.lang.IllegalArgumentException, java.lang.SecurityException, java.lang.NoSuchFieldException
T
- Return type.E
- Type of instance.instanceclass
- Class to use with instance.instance
- Object to get private field from.fieldindex
- Name of the field.
java.lang.IllegalArgumentException
- if instance isn't compatible with
instanceclass.
java.lang.SecurityException
- if the thread is not allowed to access field.
java.lang.NoSuchFieldException
- if field does not exist.public static <T,E> T getPrivateValue(java.lang.Class<? super E> instanceclass, E instance, java.lang.String field) throws java.lang.IllegalArgumentException, java.lang.SecurityException, java.lang.NoSuchFieldException
T
- Return type.E
- Type of instance.instanceclass
- Class to use with instance.instance
- Object to get private field from.field
- Name of the field.
java.lang.IllegalArgumentException
- if instance isn't compatible with
instanceclass.
java.lang.SecurityException
- if the thread is not allowed to access field.
java.lang.NoSuchFieldException
- if field does not exist.public static int getUniqueBlockModelID(BaseMod mod, boolean full3DItem)
mod
- to assign id to.full3DItem
- if true the item will have 3D model created from
renderInvBlock(vh, ox, int, int)
, if false will be a flat image.
public static int getUniqueEntityId()
public static int getUniqueSpriteIndex(java.lang.String path)
path
- Sprite map to get available index from.
public static boolean isGUIOpen(java.lang.Class<? extends vl> gui)
gui
- The type of GUI to check for. If null, will check for any GUI.
public static boolean isModLoaded(java.lang.String modname)
modname
- Name of the mod to check for.
public static void loadConfig() throws java.io.IOException
java.io.IOException
public static java.awt.image.BufferedImage loadImage(aar texCache, java.lang.String path) throws java.lang.Exception
texCache
- Reference to texture cache.path
- Path inside the jar to the image (starts with /).
java.lang.Exception
public static void onItemPickup(yr player, aai item)
player
- that picked up itemitem
- that was picked uppublic static void onTick(float tick, net.minecraft.client.Minecraft game)
tick
- Partial tick. Used for smooth animation.game
- instance of the game class.public static void openGUI(yr player, vl gui)
player
- Player instance to open GUI for.gui
- Instance of GUI to open for player.public static void populateChunk(bx generator, int chunkX, int chunkZ, wz world)
generator
- Generator to pair with.chunkX
- X coordinate of chunk.chunkZ
- Z coordinate of chunk.world
- World to generate blocks in.BaseMod.generateSurface(wz, java.util.Random, int, int)
,
BaseMod.generateNether(wz, java.util.Random, int, int)
public static afp[] registerAllKeys(afp[] keys)
keys
- Array of the original keys.
public static void registerAllTextureOverrides(aar cache)
cache
- Reference to texture cache.public static void registerBlock(ox block)
block
- to add.public static void registerBlock(ox block, java.lang.Class<? extends uz> itemclass)
block
- to add.itemclass
- Class to use for block item.public static void registerEntityID(java.lang.Class<? extends nk> entityClass, java.lang.String entityName, int id)
entityClass
- Class of entity to register.entityName
- The given name of entity. Used for saving.id
- Numeric ID of entity.public static void registerEntityID(java.lang.Class<? extends nk> entityClass, java.lang.String entityName, int id, int background, int foreground)
entityClass
- Class of entity to register.entityName
- The given name of entity. Used for saving.id
- Numeric ID of entity.background
- color of entity egg.foreground
- color of entity egg.public static void registerKey(BaseMod mod, afp keyHandler, boolean allowRepeat)
mod
- The mod which will use this. 99% of the time you should pass
"this".keyHandler
- reference to the key to register. Define this in your mod
file.allowRepeat
- when true the command will repeat. When false, only
called once per press.public static void registerTileEntity(java.lang.Class<? extends kt> tileEntityClass, java.lang.String id)
tileEntityClass
- Class of tile entity to register.id
- The given name of entity. Used for saving.public static void registerTileEntity(java.lang.Class<? extends kt> tileEntityClass, java.lang.String id, aam renderer)
tileEntityClass
- Class of tile entity to register.id
- The given name of entity. Used for saving.renderer
- Tile entity renderer to assign this tile entity.public static void removeBiome(abi biome)
biome
- Reference to biome.public static void removeSpawn(java.lang.Class<? extends acl> entityClass, aca spawnList)
entityClass
- Class of entity to spawn.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.public static void removeSpawn(java.lang.Class<? extends acl> entityClass, aca spawnList, abi... biomes)
entityClass
- Class of entity to spawn.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.biomes
- Array of biomes to add entity spawning to.public static void removeSpawn(java.lang.String entityName, aca spawnList)
entityName
- Name of entity to spawn.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.public static void removeSpawn(java.lang.String entityName, aca spawnList, abi... biomes)
entityName
- Name of entity to spawn.spawnList
- The type of list to add entity to. Monster, Creature, or
Water.biomes
- Array of biomes to add entity spawning to.public static boolean renderBlockIsItemFull3D(int modelID)
modelID
- ID of block model.
renderInvBlock(vh, ox, int, int)
.public static void renderInvBlock(vh renderer, ox block, int metadata, int modelID)
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.public static boolean renderWorldBlock(vh renderer, alc world, int x, int y, int z, ox block, int modelID)
renderer
- parent renderer. Methods and fields may be referenced from
here.world
- to render block in.x
- XPosy
- YPosz
- ZPosblock
- reference to block to render.modelID
- ID of block model to render.
public static void saveConfig() throws java.io.IOException
java.io.IOException
public static void setInGameHook(BaseMod mod, boolean enable, boolean useClock)
BaseMod.onTickInGame(float, net.minecraft.client.Minecraft)
mod
- to setenable
- whether to add or remove from listuseClock
- if true will only run once each tick on game clock, if
false once every render framepublic static void setInGUIHook(BaseMod mod, boolean enable, boolean useClock)
BaseMod.onTickInGUI(float, net.minecraft.client.Minecraft, vl)
mod
- to setenable
- whether to add or remove from listuseClock
- if true will only run once each tick on game clock, if
false once every render framepublic static <T,E> void setPrivateValue(java.lang.Class<? super T> instanceclass, T instance, int fieldindex, E value) throws java.lang.IllegalArgumentException, java.lang.SecurityException, java.lang.NoSuchFieldException
T
- Type of instance.E
- Type of value.instanceclass
- Class to use with instance.instance
- Object to get private field from.fieldindex
- Offset of field in class.value
- Value to set.
java.lang.IllegalArgumentException
- if instance isn't compatible with
instanceclass.
java.lang.SecurityException
- if the thread is not allowed to access field.
java.lang.NoSuchFieldException
- if field does not exist.public static <T,E> void setPrivateValue(java.lang.Class<? super T> instanceclass, T instance, java.lang.String field, E value) throws java.lang.IllegalArgumentException, java.lang.SecurityException, java.lang.NoSuchFieldException
T
- Type of instance.E
- Type of value.instanceclass
- Class to use with instance.instance
- Object to get private field from.field
- Name of the field.value
- Value to set.
java.lang.IllegalArgumentException
- if instance isn't compatible with
instanceclass.
java.lang.SecurityException
- if the thread is not allowed to access field.
java.lang.NoSuchFieldException
- if field does not exist.public static void takenFromCrafting(yr player, aai item, il matrix)
player
- that picked up itemitem
- that was picked upmatrix
- crafting matrix that is usedpublic static void takenFromFurnace(yr player, aai item)
player
- that picked up itemitem
- that was picked uppublic static void throwException(java.lang.String message, java.lang.Throwable e)
message
- Title of error report.e
- Exception to report.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |