cubex2.mods.customstuff2.scripting

Class ScriptableMod

java.lang.Object

cubex2.mods.customstuff2.engine.ScriptObject

cubex2.mods.customstuff2.engine.ScriptMod

cubex2.mods.customstuff2.scripting.ScriptableMod

public class ScriptableMod
extends cubex2.mods.customstuff2.engine.ScriptMod

Constructor Summary

Constructors

Constructor and Description
ScriptableMod()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlias(int id, java.lang.String alias) Adds an alias for an item with metadata -1, which will allow all metadata items in a recipe
void	addAliasWithMetadata(int id, int dv, java.lang.String alias) 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	addCreativeTab(java.lang.String name, int id, int meta) Adds a creative tab.
void	addDungeonLoot(int id, int dv, int rarity) Adds a item stack to the dungeon loot list with a stack size of 1.
void	addDungeonLoot(int id, 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(int id, int dv, int prob) Register a new plant to be planted when bonemeal is used on grass.
void	addGrassSeed(int id, 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, int id, int meta, int amount) Adds an item to a mob's drops
void	addMobDrop(java.lang.String mob, int id, int meta, int amount, float rate) Adds an item to a mob's drops
void	addRareMobDrop(java.lang.String mob, int id, int meta, int amount) Adds an item to a mob's rare drops.
void	addRareMobDrop(java.lang.String mob, int id, 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, int id, 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
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(int id, 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 script from a file
void	printLine(java.lang.String s) Prints a line in the console.
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	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	removeBiome(java.lang.String biome) Remove a biome from the terrain generator
void	removeDungeonLoot(int id, 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(int id, 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	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	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	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.

Methods inherited from class cubex2.mods.customstuff2.engine.ScriptObject

setContext, setEngine, setMod, setName, setScope

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableMod

public ScriptableMod()

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 script from a file

Parameters:

file - The name of the file (for example aFile.js)

Throws:

java.lang.Exception

addAlias

public void addAlias(int id,
            java.lang.String alias)

Adds an alias for an item with metadata -1, which will allow all metadata items in a recipe

Parameters:

id - The item's id

alias - The alias for the item

addAliasWithMetadata

public void addAliasWithMetadata(int id,
                        int dv,
                        java.lang.String alias)

Adds an alias for an item

Parameters:

id - The item's id

dv - The item's damage value

alias - The alias for the item

registerCraftingHandler

public void registerCraftingHandler(java.lang.String file)
                             throws java.io.FileNotFoundException,
                                    java.io.IOException

Registers a file for a crafting handler. This file is executed everytime an item from this mod is picked up from a crafting table.

Parameters:

file - The file to register

Throws:

java.io.FileNotFoundException

java.io.IOException

registerPickupHandler

public void registerPickupHandler(java.lang.String file)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException

Registers a file for a pickup handler. This file is executed everytime a player picks up an item from this mod

Parameters:

file - The file to register

Throws:

java.io.FileNotFoundException

java.io.IOException

registerBonemealHandler

public void registerBonemealHandler(java.lang.String file)
                             throws java.io.FileNotFoundException,
                                    java.io.IOException

Registers a file for a bonemeal handler. This file is executed everytime bonemeal is used on a block from this mod

Parameters:

file - The file to register

Throws:

java.io.FileNotFoundException

java.io.IOException

registerDestroyItemHandler

public void registerDestroyItemHandler(java.lang.String file)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Registers a file for a destroyitem handler. This file is executed everytime the player's current item (an item from this mod) was destroyed

Parameters:

file - The file to register

Throws:

java.io.FileNotFoundException

java.io.IOException

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

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items

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.

Parameters:

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

result - The result item

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items

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

recipeItems - The recipe items

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.

Parameters:

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

result - The result item

recipeItems - The recipe items

Throws:

java.lang.Exception

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

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items

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.

Parameters:

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

result - The result item

width - The recipe's width

height - The recipe's height

recipeItems - The recipe items

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

recipeItems - The recipe items

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.

Parameters:

recipeLists - The recipe lists to remove the recipe from.

result - The result item

recipeItems - The recipe items

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 - The input item

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

Parameters:

recipeLists - The list to add the recipe for.

result - The result item

input - The input item

Throws:

java.lang.Exception

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

itemToSell - The item that the villager sells

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

secondItemToBuy - The second item that the villager buys

itemToSell - The item that the villager sells

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

Throws:

java.lang.Exception

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

duration - The duration

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

Parameters:

fuelLists - The fuel lists to add the fuel for.

item - The item

duration - The duration

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

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.

Throws:

java.lang.Exception

removeBiome

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

Remove a biome from the terrain generator

Parameters:

biome - The biome to remove

Throws:

java.lang.Exception

removeAllBiomesExcept

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

Removes all biomes except the selected one

Parameters:

biome - The biome to remove

Throws:

java.lang.Exception

addToOreDictionary

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

Adds an item to the ore dictionary

Parameters:

oreClass - The ore class

id - The item's id

dv - The item'S damage value

Throws:

java.lang.Exception

addGrassPlant

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

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

Parameters:

id - The block's id

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(int id,
                int dv,
                int quantity,
                int prob)
                  throws java.lang.Exception

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

Parameters:

id - The item's id

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(int id,
                  int dv,
                  int rarity)
                    throws java.lang.Exception

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

Parameters:

id - The item's id

dv - The item's damage value

rarity - The relative chance that this item will spawn

Throws:

java.lang.Exception

addDungeonLoot

public void addDungeonLoot(int id,
                  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:

id - The item's id

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

removeDungeonLoot

public void removeDungeonLoot(int id,
                     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:

id - The item's id

dv - The item's damage value

Throws:

java.lang.Exception

removeDungeonLoot

public void removeDungeonLoot(int id,
                     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:

id - The item's id

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 item's file

itemType - The item's type

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 block's file

blockType - The block's type

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 tileentity's file

tileEntityType - The tileentity's type

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 GUI's file

guiType - The GUI's type

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 world generator's file

worldGenType - The world generator's type

Throws:

java.lang.Exception

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(int id,
                           int meta,
                           java.lang.String clazz)

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

Parameters:

id - The id of the item

meta - The metadata of the item

clazz - The ore dictionary class

addMobDrop

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

Adds an item to a mob's drops

Parameters:

mob - The id or name of the mob

id - The id of the item

meta - The metadata of the item

amount - The amount of the item

addMobDrop

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

Adds an item to a mob's drops

Parameters:

mob - The id or name of the mob

id - The id 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,
                  int id,
                  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

id - The id of the item

meta - The metadata of the item

amount - The amount of the item

addRareMobDrop

public void addRareMobDrop(java.lang.String mob,
                  int id,
                  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

id - The id 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,
                  int id,
                  int meta)

Adds a creative tab.

Parameters:

name - The name of the tab

id - The id of the tab icon item

meta - The metadata of the tab icon item