cubex2.cs2.scripting

Class ScriptableMod

java.lang.Object

cubex2.cs2.scripting.ScriptableMod

public class ScriptableMod
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptableMod(cubex2.cs2.Mod mod, org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlias(java.lang.String itemName, java.lang.String name) Adds an alias for an item with the wildcard metadata of 32767.
void	addAliasWithMetadata(java.lang.String itemName, int metadata, java.lang.String name) Adds an alias for an item
void	addBlock(java.lang.String blockFile, java.lang.String blockType) Adds a block with the given type to the game
void	addChestItem(java.lang.String chest, java.lang.String itemName, int dv, int rarity) Adds an item to a generated chest with a stack size of 1
void	addChestItem(java.lang.String chest, java.lang.String itemName, int dv, int minCount, int maxCount, int rarity) Adds an item to a generated chest.
void	addCreativeTab(java.lang.String name, java.lang.String itemName, int meta) Adds a creative tab.
void	addDungeonLoot(java.lang.String itemName, int dv, int rarity) Adds a item stack to the dungeon loot list with a stack size of 1.
void	addDungeonLoot(java.lang.String itemName, int dv, int minCount, int maxCount, int rarity) Adds a item stack, with a range of sizes, to the dungeon loot list.
void	addDungeonMob(java.lang.String name, int rarity) Adds a mob to the possible list of creatures the spawner will create.
void	addFuel(java.lang.String item, int duration) Adds a fuel to the vanilla fuel list
void	addFuelFor(java.lang.String fuelLists, java.lang.String item, int duration) Adds a fuel to the given fuel lists.
void	addGrassPlant(java.lang.String blockName, int dv, int prob) Register a new plant to be planted when bonemeal is used on grass.
void	addGrassSeed(java.lang.String itemName, int dv, int quantity, int prob) Register a new seed to be dropped when breaking tall grass.
void	addGui(java.lang.String guiFile, java.lang.String guiType) Adds a GUI with the given type to the game
void	addItem(java.lang.String itemFile, java.lang.String itemType) Adds an item with the given type to the game
void	addMobDrop(java.lang.String mob, java.lang.String itemName, int meta, int amount) Adds an item to a mob's drops
void	addMobDrop(java.lang.String mob, java.lang.String itemName, int meta, int amount, float rate) Adds an item to a mob's drops
void	addRareMobDrop(java.lang.String mob, java.lang.String itemName, int meta, int amount) Adds an item to a mob's rare drops.
void	addRareMobDrop(java.lang.String mob, java.lang.String itemName, int meta, int amount, float rate) Adds an item to a mob's rare drops.
void	addRecipe(java.lang.String result, int width, int height, java.lang.String... recipeItems) Adds a crafting recipe to the vanilla recipe list.
void	addRecipeFor(java.lang.String recipeLists, java.lang.String result, int width, int height, java.lang.String... recipeItems) Adds a crafting recipe to the given recipeLists.
void	addShapelessRecipe(java.lang.String result, java.lang.String... recipeItems) Adds a shapeless crafting recipe to the vanilla recipe list.
void	addShapelessRecipeFor(java.lang.String recipeLists, java.lang.String result, java.lang.String... recipeItems) Adds a shapeless crafting recipe to the given recipe lists.
void	addSmeltingRecipe(java.lang.String result, java.lang.String input) Adds a smelting recipe to the vanilla recipe list
void	addSmeltingRecipeFor(java.lang.String recipeLists, java.lang.String result, java.lang.String input) Adds a smelting recipe to the given recipe lists.
void	addSpawn(java.lang.String name, int rate, int min, int max, java.lang.String type) Adds a mob to the spawn list for all biomes except hell
void	addSpawn(java.lang.String name, int rate, int min, int max, java.lang.String type, java.lang.String... biome) Adds a mob to the spawn list for selected biomes
void	addTileEntity(java.lang.String tileEntityFile, java.lang.String tileEntityType) Adds a tile entity with the given type to the game
void	addToOreDictionary(java.lang.String oreClass, java.lang.String itemName, int dv) Adds an item to the ore dictionary
void	addTradeRecipe(int profession, java.lang.String itemToBuy, java.lang.String itemToSell, float chance) Adds a trade recipe for villagers.
void	addTradeRecipe(int profession, java.lang.String itemToBuy, java.lang.String secondItemToBuy, java.lang.String itemToSell, float chance) Adds a trade recipe for villagers.
void	addWorldGen(java.lang.String worldGenFile, java.lang.String worldGenType) Adds a world generator with the given type to the game
void	appendFile(java.lang.String file, java.lang.String content) Appends a string to a file.
void	disableAirRendering() Disables rendering of the air bar
void	disableArmorRendering() Disables rendering of the player's armor bar
void	disableBossHealthRendering() Disables rendering of the boss health
void	disableCrosshairsRendering() Disables rendering of the crosshairs
void	disableExperienceRendering() Disables rendering of the experience bar
void	disableFoodRendering() Disables rendering of the food bar
void	disableHealthRendering() Disables rendering of the player's health
void	disableHelmetRendering() Disables rendering of helmet overlay (i.e. the pumpkin overlay)
void	disableHotbarRendering() Disables rendering of the hotbar
void	disableObjectiveRendering() Disables rendering of the objective
void	disablePortalRendering() Disables rendering of the portal overlay
void	enableAirRendering() Enables rendering of the air bar
void	enableArmorRendering() Enables rendering of the player's armor bar
void	enableBossHealthRendering() Enables rendering of the boss health
void	enableCrosshairsRendering() Enables rendering of the crosshairs
void	enableExperienceRendering() Enables rendering of the experience bar
void	enableFoodRendering() Enables rendering of the food bar
void	enableHealthRendering() Enables rendering of the player's health
void	enableHelmetRendering() Enables rendering of helmet overlay (i.e. the pumpkin overlay)
void	enableHotbarRendering() Enables rendering of the hotbar
void	enableObjectiveRendering() Enables rendering of the objective
void	enablePortalRendering() Enables rendering of the portal overlay
java.lang.String	getAliasItemName(java.lang.String name) Gets the item name of an alias
int	getAliasMetadata(java.lang.String name) Gets the metadata of an alias
java.lang.String	getBlockType(java.lang.String blockName) Gets the type of the block with the given id.
java.lang.String	getModName() Gets the mod's name.
java.lang.String[]	getOreDictClasses() Gets all registered ore dictionary classes.
java.lang.String[]	getOreDictClassItems(java.lang.String clazz) Gets all items in a ore dictionary class.
boolean	isItemInOreDictClass(java.lang.String itemName, int meta, java.lang.String clazz) Checks if the given item is registered for the given ore dictionary class.
void	loadScript(java.lang.String file) Executes a javascript file.
void	printLine(java.lang.String s) Prints a line in the console.
java.lang.String	readFile(java.lang.String file) Reads the content of a file.
void	registerBonemealHandler(java.lang.String file) Registers a file for a bonemeal handler.
void	registerCraftingHandler(java.lang.String file) Registers a file for a crafting handler.
void	registerDestroyItemHandler(java.lang.String file) Registers a file for a destroyitem handler.
void	registerIngameRenderer(java.lang.String file) Registers a file for the ingame renderer.
void	registerPickupHandler(java.lang.String file) Registers a file for a pickup handler.
void	removeAllBiomesExcept(java.lang.String biome) Removes all biomes except the selected one.
void	removeAllRecipes() Removes all recipes that can be used in the vanilla crafting table.
void	removeBiome(java.lang.String biome) Remove a biome from the terrain generator.
void	removeBiomeDecoration(java.lang.String name) Removes a vanilla biome decorator.
void	removeChestItem(java.lang.String chest, java.lang.String itemName, int dv) Removes and item from the list of items in a generated chest.
void	removeDungeonLoot(java.lang.String itemName, int dv) Removes a item stack from the dungeon loot list, this will remove all items as long as the item stack matches, it will not care about matching the stack size ranges perfectly.
void	removeDungeonLoot(java.lang.String itemName, int dv, int minCount, int maxCount) Removes a item stack from the dungeon loot list.
void	removeDungeonMob(java.lang.String name) Will completely remove a Mob from the dungeon spawn list.
void	removeMinable(java.lang.String name) Removes a vanilla minable world generator.
void	removeRecipe(java.lang.String result, int width, int height, java.lang.String... recipeItems) Removes a crafting recipe from the vanilla recipe list.
void	removeRecipeFrom(java.lang.String recipeLists, java.lang.String result, int width, int height, java.lang.String... recipeItems) Removes a crafting recipe from the given recipe lists.
void	removeRecipesByResult(java.lang.String result) Removes all recipes that have the given result and can be used in the vanilla crafting table.
void	removeShapelessRecipe(java.lang.String result, java.lang.String... recipeItems) Removes a shapeless crafting recipe from the vanilla recipe list
void	removeShapelessRecipeFrom(java.lang.String recipeLists, java.lang.String result, java.lang.String... recipeItems) Removes a shapeless crafting recipe from the given recipe lists.
void	removeSmeltingRecipe(java.lang.String input) Removes a smelting recipe from the vanilla recipe list
void	removeSmeltingRecipeFrom(java.lang.String recipeLists, java.lang.String input) Removes a smelting recipe from the given recipe lists.
void	removeSpawn(java.lang.String name, java.lang.String type) Remove a mob from the spawn list for all biomes except hell
void	removeSpawn(java.lang.String name, java.lang.String type, java.lang.String... biome) Remove a mob from spawn list for selected biomes.
void	removeTradeRecipe(int profession, java.lang.String itemToBuy, java.lang.String itemToSell) Removes a trade recipe from villagers
void	removeTradeRecipe(int profession, java.lang.String itemToBuy, java.lang.String secondItemToBuy, java.lang.String itemToSell) Removes a trade recipe from villagers
void	writeFile(java.lang.String file, java.lang.String content) Writes a string to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableMod

public ScriptableMod(cubex2.cs2.Mod mod,
             org.mozilla.javascript.Context cx,
             org.mozilla.javascript.Scriptable scope)

Method Detail

printLine

public void printLine(java.lang.String s)

Prints a line in the console. Mainly for debugging.

Parameters:

s - The text to display

loadScript

public void loadScript(java.lang.String file)
                throws java.lang.Exception

Executes a javascript file.

Parameters:

file - The path to a script file. The path is relative to the scripts directory (for example aFile.js or aDirectory/aFile.js).

Throws:

java.lang.Exception

addAlias

public void addAlias(java.lang.String itemName,
            java.lang.String name)

Adds an alias for an item with the wildcard metadata of 32767. This basically means that if this alias is used for any recipe input or as a fuel, the metadata is ignored and thus only the item ID is checked.

Parameters:

itemName - The item's name

name - The name for the alias

addAliasWithMetadata

public void addAliasWithMetadata(java.lang.String itemName,
                        int metadata,
                        java.lang.String name)

Adds an alias for an item

Parameters:

itemName - The item's name

metadata - The item's metadata

name - The name for the alias

getAliasItemName

public java.lang.String getAliasItemName(java.lang.String name)

Gets the item name of an alias

Parameters:

name - The name of the alias

Returns:

The item name or null if the alias doesn't exist

getAliasMetadata

public int getAliasMetadata(java.lang.String name)

Gets the metadata of an alias

Parameters:

name - The name of the alias

Returns:

The metadata or -1 if the alias doesn't exist

registerCraftingHandler

public void registerCraftingHandler(java.lang.String file)
                             throws java.lang.Exception

Registers a file for a crafting handler. This file is executed everytime an item from this mod is picked up from a crafting table. After all crafting handlers are called, the stack size of every itemstack in the craft matrix is reduced by 1. You can use mod, config, itemstack, craftMatrix, player and world in this script.

Parameters:

file - The path to the script file relative to the mod's scripts directory.

Throws:

java.lang.Exception

registerPickupHandler

public void registerPickupHandler(java.lang.String file)
                           throws java.lang.Exception

Registers a file for a pickup handler. This file is executed everytime a player picks up an item from this mod. You can use mod, config, item, player and world in this script.

Parameters:

file - The path to the script file relative to the mod's scripts directory.

Throws:

java.lang.Exception

registerBonemealHandler

public void registerBonemealHandler(java.lang.String file)
                             throws java.lang.Exception

Registers a file for a bonemeal handler. This file is executed everytime bonemeal is used on a block from this mod. You can use mod, config, player, world and position in this script.

Parameters:

file - The path to the script file relative to the mod's scripts directory.

Throws:

java.lang.Exception

registerDestroyItemHandler

public void registerDestroyItemHandler(java.lang.String file)
                                throws java.lang.Exception

Registers a file for a destroyitem handler. This file is executed everytime the player's current item (an item from this mod) was destroyed. You can use mod, config, player, world and itemstack in this script.

Parameters:

file - The path to the script file relative to the mod's scripts directory.

Throws:

java.lang.Exception

registerIngameRenderer

public void registerIngameRenderer(java.lang.String file)
                            throws java.lang.Exception

Registers a file for the ingame renderer. This script file is able to draw things to the ingame HUD. You can use mod, config, renderer, mouseX, mouseY, width and height (width and height of the screen; this is scaled and does not represent the resolution that the game is running with) in this script.

Parameters:

file - The path to the script file relative to the mod's scripts directory.

Throws:

java.lang.Exception

addRecipe

public void addRecipe(java.lang.String result,
             int width,
             int height,
             java.lang.String... recipeItems)
               throws java.lang.Exception

Adds a crafting recipe to the vanilla recipe list.

Parameters:

result - The result item. Input Format #1 is used for this parameter (see here)

width - The recipe's width

height - The recipe's height

recipeItems - The recipe ingredients. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

addRecipeFor

public void addRecipeFor(java.lang.String recipeLists,
                java.lang.String result,
                int width,
                int height,
                java.lang.String... recipeItems)
                  throws java.lang.Exception

Adds a crafting recipe to the given recipeLists. This can only add recipes to the vanilla recipe list or to recipe lists of custom crafting tables.

Parameters:

recipeLists - The recipe lists in which the recipe is added separated with ','. For example 'vanilla,myOwn' or 'myOwn'

result - The result item. Input Format #1 is used for this parameter (see here)

width - The recipe's width

height - The recipe's height

recipeItems - The recipe ingredients. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

addShapelessRecipe

public void addShapelessRecipe(java.lang.String result,
                      java.lang.String... recipeItems)
                        throws java.lang.Exception

Adds a shapeless crafting recipe to the vanilla recipe list.

Parameters:

result - The result item. Input Format #1 is used for this parameter (see here)

recipeItems - The recipe ingredients. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

addShapelessRecipeFor

public void addShapelessRecipeFor(java.lang.String recipeLists,
                         java.lang.String result,
                         java.lang.String... recipeItems)
                           throws java.lang.Exception

Adds a shapeless crafting recipe to the given recipe lists. This can only add recipes to the vanilla recipe list or to recipe lists of custom crafting tables.

Parameters:

recipeLists - The recipe lists in which the recipe is added separated with ','. For example 'vanilla,myOwn' or 'myOwn'

result - The result item. Input Format #1 is used for this parameter (see here)

recipeItems - The recipe ingredients. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

removeAllRecipes

public void removeAllRecipes()

Removes all recipes that can be used in the vanilla crafting table.

removeRecipesByResult

public void removeRecipesByResult(java.lang.String result)

Removes all recipes that have the given result and can be used in the vanilla crafting table.

Parameters:

result - The result item. Input Format #3 is used for this parameter (see here)

removeRecipe

public void removeRecipe(java.lang.String result,
                int width,
                int height,
                java.lang.String... recipeItems)
                  throws java.lang.Exception

Removes a crafting recipe from the vanilla recipe list.

Parameters:

result - The result item. Input Format #3 is used for this parameter (see here)

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

removeRecipeFrom

public void removeRecipeFrom(java.lang.String recipeLists,
                    java.lang.String result,
                    int width,
                    int height,
                    java.lang.String... recipeItems)
                      throws java.lang.Exception

Removes a crafting recipe from the given recipe lists. This can only remove recipes from the vanilla recipe list or from recipe lists of custom crafting tables.

Parameters:

recipeLists - The recipe lists to remove the recipe from. For example 'vanilla,myOwn' or 'myOwn'

result - The result item. Input Format #3 is used for this parameter (see here)

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

removeShapelessRecipe

public void removeShapelessRecipe(java.lang.String result,
                         java.lang.String... recipeItems)
                           throws java.lang.Exception

Removes a shapeless crafting recipe from the vanilla recipe list

Parameters:

result - The result item. Input Format #3 is used for this parameter (see here)

recipeItems - The recipe items. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

removeShapelessRecipeFrom

public void removeShapelessRecipeFrom(java.lang.String recipeLists,
                             java.lang.String result,
                             java.lang.String... recipeItems)
                               throws java.lang.Exception

Removes a shapeless crafting recipe from the given recipe lists. This can only remove recipes from the vanilla recipe list or from recipe lists of custom crafting tables.

Parameters:

recipeLists - The recipe lists to remove the recipe from.

result - The result item. Input Format #3 is used for this parameter (see here)

recipeItems - The recipe items. Input Format #2 is used for this parameter (see here)

Throws:

java.lang.Exception

addSmeltingRecipe

public void addSmeltingRecipe(java.lang.String result,
                     java.lang.String input)
                       throws java.lang.Exception

Adds a smelting recipe to the vanilla recipe list

Parameters:

result - The result item. Input Format #1 is used for this parameter (see here)

input - The input item. Input Format #3 is used for this parameter (see here)

Throws:

java.lang.Exception

addSmeltingRecipeFor

public void addSmeltingRecipeFor(java.lang.String recipeLists,
                        java.lang.String result,
                        java.lang.String input)
                          throws java.lang.Exception

Adds a smelting recipe to the given recipe lists. This can only add recipes to the vanilla recipe list or to recipe lists of custom furnaces.

Parameters:

recipeLists - The lists to add the recipe for separated by ','.

result - The result item. Input Format #1 is used for this parameter (see here)

input - The input item. Input Format #3 is used for this parameter (see here)

Throws:

java.lang.Exception

removeSmeltingRecipe

public void removeSmeltingRecipe(java.lang.String input)

Removes a smelting recipe from the vanilla recipe list

Parameters:

input - The input of the smelting recipe. Input Format #3 is used for this parameter (see here)

removeSmeltingRecipeFrom

public void removeSmeltingRecipeFrom(java.lang.String recipeLists,
                            java.lang.String input)

Removes a smelting recipe from the given recipe lists. This can only remove recipes from the vanilla recipe list or from recipe lists of custom furnaces.

Parameters:

recipeLists - The recipe lists separated with ','

input - The input of the smelting recipe. Input Format #3 is used for this parameter (see here)

addTradeRecipe

public void addTradeRecipe(int profession,
                  java.lang.String itemToBuy,
                  java.lang.String itemToSell,
                  float chance)
                    throws java.lang.Exception

Adds a trade recipe for villagers.

Parameters:

profession - The profession of the villager

itemToBuy - The item that the villager buys. Input Format #1 is used for this parameter (see here)

itemToSell - The item that the villager sells. Input Format #1 is used for this parameter (see here)

chance - The chance of the recipe (0.0 to 1.0)

Throws:

java.lang.Exception

addTradeRecipe

public void addTradeRecipe(int profession,
                  java.lang.String itemToBuy,
                  java.lang.String secondItemToBuy,
                  java.lang.String itemToSell,
                  float chance)
                    throws java.lang.Exception

Adds a trade recipe for villagers.

Parameters:

profession - The profession of the villager

itemToBuy - The item that the villager buys. Input Format #1 is used for this parameter (see here)

secondItemToBuy - The second item that the villager buys. Input Format #1 is used for this parameter (see here)

itemToSell - The item that the villager sells. Input Format #1 is used for this parameter (see here)

chance - The chance of the recipe (0.0 to 1.0)

Throws:

java.lang.Exception

removeTradeRecipe

public void removeTradeRecipe(int profession,
                     java.lang.String itemToBuy,
                     java.lang.String itemToSell)

Removes a trade recipe from villagers

Parameters:

profession - The profession of the villager

itemToBuy - The item that the villager buys. Input Format #1 is used for this parameter (see here)

itemToSell - The item that the villager sells. Input Format #1 is used for this parameter (see here)

removeTradeRecipe

public void removeTradeRecipe(int profession,
                     java.lang.String itemToBuy,
                     java.lang.String secondItemToBuy,
                     java.lang.String itemToSell)

Removes a trade recipe from villagers

Parameters:

profession - The profession of the villager

itemToBuy - The item that the villager buys. Input Format #1 is used for this parameter (see here)

secondItemToBuy - The second item that the villager buys. Input Format #1 is used for this parameter (see here)

itemToSell - The item that the villager sells. Input Format #1 is used for this parameter (see here)

addFuel

public void addFuel(java.lang.String item,
           int duration)
             throws java.lang.Exception

Adds a fuel to the vanilla fuel list

Parameters:

item - The item. Input Format #3 is used for this parameter (see here)

duration - The duration in ticks

Throws:

java.lang.Exception

addFuelFor

public void addFuelFor(java.lang.String fuelLists,
              java.lang.String item,
              int duration)
                throws java.lang.Exception

Adds a fuel to the given fuel lists. This can only add fuel to the vanilla fuel list or to fuel lists of custom furnaces.

Parameters:

fuelLists - The fuel lists to add the fuel for separated by ','.

item - The item. Input Format #3 is used for this parameter (see here)

duration - The duration in ticks

Throws:

java.lang.Exception

addSpawn

public void addSpawn(java.lang.String name,
            int rate,
            int min,
            int max,
            java.lang.String type)
              throws java.lang.Exception

Adds a mob to the spawn list for all biomes except hell

Parameters:

name - The name of the mob

rate - The rate (higher rate -> mob is more common)

min - The minimum count of the mob for one spawn

max - The maximum count of the mob for one spawn

type - The type of the spawn (monster, creature or water)

Throws:

java.lang.Exception

addSpawn

public void addSpawn(java.lang.String name,
            int rate,
            int min,
            int max,
            java.lang.String type,
            java.lang.String... biome)
              throws java.lang.Exception

Adds a mob to the spawn list for selected biomes

Parameters:

name - The name of the mob

rate - The rate (higher rate -> mob is more common)

min - The minimum count of the mob for one spawn

max - The maximum count of the mob for one spawn

type - The type of the spawn (monster, creature or water)

biome - The biomes where the mob is spawned. See the CS2InformationFile.txt for all list of all biomes available in your minecraft setup.

Throws:

java.lang.Exception

removeSpawn

public void removeSpawn(java.lang.String name,
               java.lang.String type)
                 throws java.lang.Exception

Remove a mob from the spawn list for all biomes except hell

Parameters:

name - The name of the mob

type - The type of the spawn (monster, creature or water)

Throws:

java.lang.Exception

removeSpawn

public void removeSpawn(java.lang.String name,
               java.lang.String type,
               java.lang.String... biome)
                 throws java.lang.Exception

Remove a mob from spawn list for selected biomes.

Parameters:

name - The name of the mob

type - The type of the spawn (monster, creature or water)

biome - The biomes to remove the mob from. See the CS2InformationFile.txt for all list of all biomes available in your minecraft setup.

Throws:

java.lang.Exception

removeBiome

public void removeBiome(java.lang.String biome)
                 throws java.lang.Exception

Remove a biome from the terrain generator. Doesn't work at the moment.

Parameters:

biome - The biome to remove See the CS2InformationFile.txt for all list of all biomes available in your minecraft setup.

Throws:

java.lang.Exception

removeAllBiomesExcept

public void removeAllBiomesExcept(java.lang.String biome)
                           throws java.lang.Exception

Removes all biomes except the selected one. Doesn't work at the moment.

Parameters:

biome - The biome to remove See the CS2InformationFile.txt for all list of all biomes available in your minecraft setup.

Throws:

java.lang.Exception

addToOreDictionary

public void addToOreDictionary(java.lang.String oreClass,
                      java.lang.String itemName,
                      int dv)
                        throws java.lang.Exception

Adds an item to the ore dictionary

Parameters:

oreClass - The ore class. See the CS2InformationFile.txt for all list of all ore classes available in your minecraft setup. You can also use a new ore class that isn't listed their.

itemName - The item's name

dv - The item's damage value

Throws:

java.lang.Exception

addGrassPlant

public void addGrassPlant(java.lang.String blockName,
                 int dv,
                 int prob)
                   throws java.lang.Exception

Register a new plant to be planted when bonemeal is used on grass.

Parameters:

blockName - The block's name

dv - The block's damage value

prob - The relative probability of the plant, where red flowers are 10 and yellow flowers are 20.

Throws:

java.lang.Exception

addGrassSeed

public void addGrassSeed(java.lang.String itemName,
                int dv,
                int quantity,
                int prob)
                  throws java.lang.Exception

Register a new seed to be dropped when breaking tall grass.

Parameters:

itemName - The item's name

dv - The item's damage value

quantity - The quantity of seeds to drop.

prob - The relative probability of the seeds, where wheat seeds are 10.

Throws:

java.lang.Exception

addDungeonMob

public void addDungeonMob(java.lang.String name,
                 int rarity)
                   throws java.lang.Exception

Adds a mob to the possible list of creatures the spawner will create. If the mob is already in the spawn list, the rarity will be added to the existing one, causing the mob to be more common.

Parameters:

name - The name of the mob

rarity - The rarity of selecting this mob over others. Must be greater then 0.

Throws:

java.lang.Exception

removeDungeonMob

public void removeDungeonMob(java.lang.String name)
                      throws java.lang.Exception

Will completely remove a Mob from the dungeon spawn list.

Parameters:

name - The name of the mob

Throws:

java.lang.Exception

addDungeonLoot

public void addDungeonLoot(java.lang.String itemName,
                  int dv,
                  int rarity)
                    throws java.lang.Exception

Adds a item stack to the dungeon loot list with a stack size of 1.

Parameters:

itemName - The item's name

dv - The item's damage value

rarity - The relative chance that this item will spawn

Throws:

java.lang.Exception

addDungeonLoot

public void addDungeonLoot(java.lang.String itemName,
                  int dv,
                  int minCount,
                  int maxCount,
                  int rarity)
                    throws java.lang.Exception

Adds a item stack, with a range of sizes, to the dungeon loot list. If a stack matching the same item, and size range, is already in the list the rarities will be added together making the item more common.

Parameters:

itemName - The item's name

dv - The item's damage value

minCount - When this item does generate, the minimum number that is in the stack

maxCount - When this item does generate, the maximum number that can bein the stack

rarity - The relative chance that this item will spawn.

Throws:

java.lang.Exception

addChestItem

public void addChestItem(java.lang.String chest,
                java.lang.String itemName,
                int dv,
                int rarity)

Adds an item to a generated chest with a stack size of 1

Parameters:

chest - The name of the chest. Possible values are mineshaftCorridor, pyramidDesertyChest, pyramidJungleChest, pyramidJungleDispenser, strongholdCorridor, strongholdLibrary, strongholdCrossing, villageBlacksmith, bonusChest, dungeonChest

itemName - The item's name

dv - The item's damage value

rarity - The rarity of the item. Higher rarity means higher chance that the item is added to the chest.

addChestItem

public void addChestItem(java.lang.String chest,
                java.lang.String itemName,
                int dv,
                int minCount,
                int maxCount,
                int rarity)

Adds an item to a generated chest.

Parameters:

chest - The name of the chest. Possible values are mineshaftCorridor, pyramidDesertyChest, pyramidJungleChest, pyramidJungleDispenser, strongholdCorridor, strongholdLibrary, strongholdCrossing, villageBlacksmith, bonusChest, dungeonChest

itemName - The item's name

dv - The item's damage value

minCount - When this item does generate, the minimum number that is in the stack

maxCount - When this item does generate, the maximum number that can bein the stack

rarity - The rarity of the item. Higher rarity means higher chance that the item is added to the chest.

removeChestItem

public void removeChestItem(java.lang.String chest,
                   java.lang.String itemName,
                   int dv)

Removes and item from the list of items in a generated chest.

Parameters:

chest - The name of the chest. Possible values are mineshaftCorridor, pyramidDesertyChest, pyramidJungleChest, pyramidJungleDispenser, strongholdCorridor, strongholdLibrary, strongholdCrossing, villageBlacksmith, bonusChest, dungeonChest

itemName - The item's name

dv - The item's damage value

removeDungeonLoot

public void removeDungeonLoot(java.lang.String itemName,
                     int dv)
                       throws java.lang.Exception

Removes a item stack from the dungeon loot list, this will remove all items as long as the item stack matches, it will not care about matching the stack size ranges perfectly.

Parameters:

itemName - The item's name

dv - The item's damage value

Throws:

java.lang.Exception

removeDungeonLoot

public void removeDungeonLoot(java.lang.String itemName,
                     int dv,
                     int minCount,
                     int maxCount)
                       throws java.lang.Exception

Removes a item stack from the dungeon loot list. If 'minCount' parameter is greater then 0, it will only remove loot items that have the same exact stack size range as passed in by parameters.

Parameters:

itemName - The item's name

dv - The item's damage value

minCount - The minimum count for the match check, if less then 0, the size check is skipped

maxCount - The max count used in match check when 'minCount' is >= 0

Throws:

java.lang.Exception

addItem

public void addItem(java.lang.String itemFile,
           java.lang.String itemType)
             throws java.lang.Exception

Adds an item with the given type to the game

Parameters:

itemFile - The path to an item file. The path is relative to the items directory of your mod.

itemType - The item's type. See a list of all item types here

Throws:

java.lang.Exception

addBlock

public void addBlock(java.lang.String blockFile,
            java.lang.String blockType)
              throws java.lang.Exception

Adds a block with the given type to the game

Parameters:

blockFile - The path to a block file. The path is relative to the blocks directory of your mod.

blockType - The block's type. See a list of all block types here

Throws:

java.lang.Exception

addTileEntity

public void addTileEntity(java.lang.String tileEntityFile,
                 java.lang.String tileEntityType)
                   throws java.lang.Exception

Adds a tile entity with the given type to the game

Parameters:

tileEntityFile - The path to an tile entity file. The path is relative to the tileEntity directory of your mod.

tileEntityType - The tile entity's type. See a list of all tile entity types here

Throws:

java.lang.Exception

addGui

public void addGui(java.lang.String guiFile,
          java.lang.String guiType)
            throws java.lang.Exception

Adds a GUI with the given type to the game

Parameters:

guiFile - The path to an GUI file. The path is relative to the guis directory of your mod.

guiType - The GUI's type. See a list of all GUI types here

Throws:

java.lang.Exception

addWorldGen

public void addWorldGen(java.lang.String worldGenFile,
               java.lang.String worldGenType)
                 throws java.lang.Exception

Adds a world generator with the given type to the game

Parameters:

worldGenFile - The path to a world generation file. The path is relative to the worldGeneration directory of your mod.

worldGenType - The world generator's type. See a list of all world generation types here

Throws:

java.lang.Exception

removeMinable

public void removeMinable(java.lang.String name)

Removes a vanilla minable world generator.

Parameters:

name - The name of the minable. Possible values are coal, diamond, iron, lapis, redstone, gold, dirt and gravel.

removeBiomeDecoration

public void removeBiomeDecoration(java.lang.String name)

Removes a vanilla biome decorator.

Parameters:

name - The name of the decorator. Possible values are bigShroom, cactus, clay, deadBush, lilypad, flowers, grass, lake, pumpkin, reed, sand, sandPass2, shroom, tree

getOreDictClasses

public java.lang.String[] getOreDictClasses()

Gets all registered ore dictionary classes.

getOreDictClassItems

public java.lang.String[] getOreDictClassItems(java.lang.String clazz)

Gets all items in a ore dictionary class.

Parameters:

clazz - The ore dictionary class.

Returns:

The items in a array. Each entry is one item.

isItemInOreDictClass

public boolean isItemInOreDictClass(java.lang.String itemName,
                           int meta,
                           java.lang.String clazz)

Checks if the given item is registered for the given ore dictionary class.

Parameters:

itemName - The item's name

meta - The metadata of the item

clazz - The ore dictionary class

addMobDrop

public void addMobDrop(java.lang.String mob,
              java.lang.String itemName,
              int meta,
              int amount)

Adds an item to a mob's drops

Parameters:

mob - The id or name of the mob

itemName - The name of the item

meta - The metadata of the item

amount - The amount of the item

addMobDrop

public void addMobDrop(java.lang.String mob,
              java.lang.String itemName,
              int meta,
              int amount,
              float rate)

Adds an item to a mob's drops

Parameters:

mob - The id or name of the mob

itemName - The name of the item

meta - The metadata of the item

amount - The amount of the item

rate - The rate of the drop where 0.0 is 0% and 1.0 is 100%

addRareMobDrop

public void addRareMobDrop(java.lang.String mob,
                  java.lang.String itemName,
                  int meta,
                  int amount)

Adds an item to a mob's rare drops. Those are only dropped if a player kills the mob.

Parameters:

mob - The id or name of the mob

itemName - The name of the item

meta - The metadata of the item

amount - The amount of the item

addRareMobDrop

public void addRareMobDrop(java.lang.String mob,
                  java.lang.String itemName,
                  int meta,
                  int amount,
                  float rate)

Adds an item to a mob's rare drops. Those are only dropped if a player kills the mob.

Parameters:

mob - The id or name of the mob

itemName - The name of the item

meta - The metadata of the item

amount - The amount of the item

rate - The rate of the drop where 0.0 is 0% and 1.0 is 100%

addCreativeTab

public void addCreativeTab(java.lang.String name,
                  java.lang.String itemName,
                  int meta)

Adds a creative tab.

Parameters:

name - The name of the tab

itemName - The name of the tab icon item

meta - The metadata of the tab icon item

enableHelmetRendering

public void enableHelmetRendering()

Enables rendering of helmet overlay (i.e. the pumpkin overlay)

disableHelmetRendering

public void disableHelmetRendering()

Disables rendering of helmet overlay (i.e. the pumpkin overlay)

enablePortalRendering

public void enablePortalRendering()

Enables rendering of the portal overlay

disablePortalRendering

public void disablePortalRendering()

Disables rendering of the portal overlay

enableHotbarRendering

public void enableHotbarRendering()

Enables rendering of the hotbar

disableHotbarRendering

public void disableHotbarRendering()

Disables rendering of the hotbar

enableCrosshairsRendering

public void enableCrosshairsRendering()

Enables rendering of the crosshairs

disableCrosshairsRendering

public void disableCrosshairsRendering()

Disables rendering of the crosshairs

enableBossHealthRendering

public void enableBossHealthRendering()

Enables rendering of the boss health

disableBossHealthRendering

public void disableBossHealthRendering()

Disables rendering of the boss health

enableHealthRendering

public void enableHealthRendering()

Enables rendering of the player's health

disableHealthRendering

public void disableHealthRendering()

Disables rendering of the player's health

enableArmorRendering

public void enableArmorRendering()

Enables rendering of the player's armor bar

disableArmorRendering

public void disableArmorRendering()

Disables rendering of the player's armor bar

enableFoodRendering

public void enableFoodRendering()

Enables rendering of the food bar

disableFoodRendering

public void disableFoodRendering()

Disables rendering of the food bar

enableAirRendering

public void enableAirRendering()

Enables rendering of the air bar

disableAirRendering

public void disableAirRendering()

Disables rendering of the air bar

enableExperienceRendering

public void enableExperienceRendering()

Enables rendering of the experience bar

disableExperienceRendering

public void disableExperienceRendering()

Disables rendering of the experience bar

enableObjectiveRendering

public void enableObjectiveRendering()

Enables rendering of the objective

disableObjectiveRendering

public void disableObjectiveRendering()

Disables rendering of the objective

getBlockType

public java.lang.String getBlockType(java.lang.String blockName)

Gets the type of the block with the given id. This works for all CS2 blocks and for vanilla buttons, chests, doors, fences, fence gates, fluids, furnaces, ladders, panes, pressure plates, slabs, torches, trap doors and walls. It may work some blocks from other non-CS2 mods.

Parameters:

blockName - The name of the block.

Returns:

The type of the block or unknown if the block doesn't exist or isn't supported. The types equal to the CS2 block types.

getModName

public java.lang.String getModName()

Gets the mod's name.

Returns:

The mod's name.

readFile

public java.lang.String readFile(java.lang.String file)
                          throws java.io.IOException

Reads the content of a file.

Parameters:

file - The path of the file to be read. If the path starts with a '/', the path is relative to the .minecraft directory. If it doesn't start with '/', the path is relative to the mod's data directory.

Returns:

The content of the file or null if it doesn't exist.

Throws:

java.io.IOException

writeFile

public void writeFile(java.lang.String file,
             java.lang.String content)
               throws java.io.IOException

Writes a string to a file. If the file exists, I will be overridden.

Parameters:

file - The path of the file. If the path starts with a '/', the path is relative to the .minecraft directory. If it doesn't start with '/', the path is relative to the mod's data directory.

content - The content to write to the file.

Throws:

java.io.IOException

appendFile

public void appendFile(java.lang.String file,
              java.lang.String content)
                throws java.io.IOException

Appends a string to a file. If the file doesn't exist, I will be created.

Parameters:

file - The path of the file. If the path starts with a '/', the path is relative to the .minecraft directory. If it doesn't start with '/', the path is relative to the mod's data directory.

content - The content to append to the file.

Throws:

java.io.IOException