Custom Stuff 2 Documentation
Recipes
Methods
- addRecipe
- addRecipeFor
- addShapelessRecipe
- addShapelessRecipeFor
- removeRecipe
- removeRecipeFrom
- removeShapelessRecipe
- removeShapelessRecipeFrom
Smelting recipes
Methods
- addSmeltingRecipe
- addSmeltingRecipeFor
Fuels
Methods
- addFuel
- addFuelFor
Items
Methods
- addItem
Attributes
addToCreative (Boolean)
Description: If true the item will be added to the creative inventory.
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
alwaysEdible (Boolean)
Description: If true the food can be eaten even when the hungerbar is completly full.
Default value: false
Useable types:food
Value restriction:No value restriction.
armorTexture (Texture)
Description: Defines the texture for the armor. It is the texture that is displayed on your skin when wearing the armor.
Default value: no default value
Useable types:armor
Value restriction:No value restriction.
armorType (String)
Description: Defines the type of the armor.
Default value: "helmet"
Useable types:armor
Value restriction:
helmet
plate
legs
boots
containerItem (ItemStack)
Description: Defines the container item for the item. The container item remains when the item is crafted. For example the empty bucket is the container item of the water or lava bucket.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
creativeTab (CreativeTab)
Description: Defines on what creative tab that the item is shown on.
Default value: "search"
Default value overrides:
food: food
armor: combat
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
damage (Integer)
Description: Defines the damage against entities.
Default value: 1
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
damageReduction (Integer)
Description: Defines the damage reduction of the armor.
Default value: 1
Useable types:armor
Value restriction:No value restriction.
displayName (String)
Description: Defines the name that is displayed ingame.
Default value: "Unnamed"
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
doorId (Integer)
Description: Defines the id of the door that is placed with this door item.
Default value: 64
Useable types:door
Value restriction:No value restriction.
effectiveBlocks (ItemStackList)
Description: Defines what blocks the item is fast on mining. Those blocks have also to be in harvestBlocks.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No stack size
efficiency (Float)
Description: Defines the efficiency of the item, i.e how fast it can mine blocks.
Default value: 1.0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
enchantability (Integer)
Description: Defines the enchantability of the item.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
fallProof (Boolean)
Description: If true the player doesn't take any fall damage when wearing the armor.
Default value: false
Useable types:armor
Value restriction:No value restriction.
fireProof (Boolean)
Description: If true the player is fire resistant when wearing the armor.
Default value: false
Useable types:armor
Value restriction:No value restriction.
fluidId (Integer)
Description: Defines the id of the moving fluid block for a bucket.
Default value: no default value
Useable types:bucket
Value restriction:No value restriction.
fluidId2 (Integer)
Description: Defines the id of the still fluid block for a bucket.
Default value: no default value
Useable types:bucket
Value restriction:No value restriction.
full3d (Boolean)
Description: If true the item is rendered big like tools. If false it is rendered smaller like food.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
harvestBlocks (IntegerList)
Description: Defines the blocks that the item can harvest.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
harvestLevel (Integer)
Description: Defines the harvest level of the item. It is used in combination with toolClass, so you can have for example different pickaxes like stone and iron pickaxe.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
hunger (Integer)
Description: Defines how many half hunger sticks the food adds.
Default value: 2
Useable types:food
Value restriction:No value restriction.
id (Integer)
Description: Defines the id of the item. It has to be unique.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:1 to 31999 (including both).
information (StringArray)
Description: Defines additional information for an item, that is displayed when move your mouse over an item (like the second like on music discs).
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
leaveContainerItem (Boolean)
Description: If true the container item will remain in the crafting grid instead of going into the inventory after crafting.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
maxDamage (Integer)
Description: Defines the maximum damage the item can take.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 31999 (including both).
maxStack (Integer)
Description: Defines the maximum stack size for the item.
Default value: 1
Useable types:This attribute can be used with all types.
Value restriction:1 to 64 (including both).
maxUsingDuration (Integer)
Description: Defines how long the item can be used at one time in ticks.
Default value: 0
Default value overrides:
food: 32
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
name (String)
Description: Defines the interal name of the item. It should be unique.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No whitespaces.
onBlockStartBreak (Script)
Description: Defines the script that is called when the item starts mining a block. You can use mod, config, itemstack, position, player and world for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onCreated (Script)
Description: Defines the script that is called when the item was crafted. You can use mod, config, itemstack, world and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onDroppedByPlayer (Script)
Description: Defines the script that is called when the item is dropped by a player. You can use mod, config, itemstack, world and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onEaten (Script)
Description: Defines the script that is called when the item use count runs out. You can use mod, config, itemstack, world and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onHitEntity (Script)
Description: Defines the script that is called when the item hits a mob. It is called after the mob gets damaged. You can use mod, config, itemstack, world, player and living for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onLeftClickLiving (Script)
Description: Defines the script that is called when left clicking an living with the item. You can use mod, config, itemstack, player, world and living for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onLeftClickPlayer (Script)
Description: Defines the script that is called when left clicking an living with the item. You can use mod, config, itemstack, player and world, interactPlayer for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onRightClick (Script)
Description: Defines the script that is called when a player rightclicks with the item. You can use mod, config, itemstack, player and world for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onStoppedUsing (Script)
Description: Defines the script that is called when a player stopped using the item. You can use mod, config, itemstack, world, player and tickCount for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUpdate (Script)
Description: Defines the script that is called every tick as long as it is in a player's inventory. You can use mod, config, itemstack, world, player, slotId and isCurrentItem for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUse (Script)
Description: Defines the script that is called when the item is used on a block after the block's activated event is called. You can use mod, config, itemstack, player, world, position and side for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUseFirst (Script)
Description: Defines the script that is called when the item is used on a block before the block'S activated event is called. You can use mod, config, itemstack, player, world, position and side for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUseOnEntity (Script)
Description: Defines the script that is called when the item is used on a entity. You can use mod, config, itemstack, living and world for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUsing (Script)
Description: Defines the script that is called every tick when the item is in use (for example while a sword is blocking or while a food is eaten). You can use mod, config, itemstack, player, world and tickCount for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
potion (Potion)
Description: Defines the potion that will be used for the player when the food is eaten.
Default value: no default value
Useable types:food
Value restriction:No value restriction.
potionAmplifier (Integer)
Description: Defines the strenght of the potion effect. For example the higher the value the higher the move speed.
Default value: 0
Useable types:food
Value restriction:No value restriction.
potionDuration (Integer)
Description: Defines how long the potion effect remains in seconds
Default value: 60
Useable types:food
Value restriction:No value restriction.
potionProbability (Float)
Description: Defines the chance that the food is adding a potion effect when eaten.
Default value: 1.0
Useable types:food
Value restriction:0.0 to 1.0 (including both).
repairable (Boolean)
Description: Defines if this item can be repaired.
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
saturation (Float)
Description: Defines the amount of saturation is added from eaten the food.
Default value: 0.3
Useable types:food
Value restriction:No value restriction.
textureFile (Texture)
Description: Defines the textureFile the item uses to get its icon.
Default value: /gui/items.png
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
textureIndex (Integer)
Description: Defines the index of the texture the item will use for its icon.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
toolClass (String)
Description: Defines the tool class of the item. The item can then mine blocks with this tool class. It is used in combination with harvestLevel. If this is set to 'noHarvest' the item can't mine any block.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
usingAction (EnumAction)
Description: Defines the action while an item is in use.
Default value: "none"
Default value overrides:
food: eat
Useable types:This attribute can be used with all types.
Value restriction:
none
drink
eat
block
waterProof (Boolean)
Description: If true the player can breath underwater when wearing the armor.
Default value: false
Useable types:armor
Value restriction:No value restriction.
Blocks
Methods
- addBlock
Attributes
addToCreative (BooleanArray)
Description: If true the block will be added to the creative inventory.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
canPlaceOnCeiling (Boolean)
Description: If true the torch can be placed on a ceiling.
Default value: false
Useable types:torch
Value restriction:No value restriction.
canPlaceOnFloor (Boolean)
Description: If false the torch can't be placed on a floor.
Default value: true
Useable types:torch
Value restriction:No value restriction.
canPlaceOnWall (Boolean)
Description: If false the torch can't be placed on walls.
Default value: true
Useable types:torch
Value restriction:No value restriction.
canSilkHarvest (BooleanArray)
Description: If false the block won't be affected by silk touch.
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
color (Color)
Description: Defines the color od the fluid.
Default value: "ffffff"
Useable types:fluid
Value restriction:No value restriction.
creativeTab (CreativeTab)
Description: Defines the creative tab that the block is shown on.
Default value: "search"
Default value overrides:
button: redstone
chest: decoration
door: redstone
fence: decorations
fenceGate: redstone
ladder: decorations
pressurePlate: redstone
torch: decorations
trapDoor: redstone
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
displayName (StringArray)
Description: Defines the ingame name of the block.
Default value: "Unnamed"
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
doubleSlabId (Integer)
Description: Defines the id of the double slab block. -1 means no double slab.
Default value: -1
Useable types:slab
Value restriction:No value restriction.
doubleSlabMeta (Integer)
Description: Defines the metadata of the double slab block.
Default value: 0
Useable types:slab
Value restriction:0 to 15 (including both).
drop (ItemStackArray)
Description: Defines what the block does drop when it is destroyed. You can specify a range for the amount (for example 1-5).
Default value: [id]:0 1
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
fireSpreadSpeed (IntegerArray)
Description: Defines how fast fire will spread around the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
flammability (IntegerArray)
Description: Defines the chance that fire will spread and consume the block. 300 means 100%. 0 means 0%.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 300 (including both).
fortuneModifier (IntegerArray)
Description: Defines the fortune modifier of the block. The amount added to quantityDropped is [fortuneLevel]*[fortuneModifer].
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
hardness (FloatArray)
Description: Defines how long a block will take to break.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
hasAntiGravity (BooleanArray)
Description: If true the block goes in the air.
Default value: false
Useable types:gravity
Value restriction:No value restriction.
hasCollision (BooleanArray)
Description: If false entities can not collide with the block.
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
hasTileEntity (BooleanArray)
Description: Set this to true if the block has a tile entity.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
id (Integer)
Description: Defines the id of the block. It has to be unique.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
id2 (Integer)
Description: Defines the id of the still fluid block. It has to be unique.
Default value: no default value
Useable types:fluid
Value restriction:No value restriction.
infiniteSource (Boolean)
Description: Defines if the fluid can make infinite sources, like water does.
Default value: true
Useable types:fluid
Value restriction:No value restriction.
isBurning (BooleanArray)
Description: If true the block deals fire damage to entities coming into contact with it.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
isFireSource (BooleanArray)
Description: If true fire will not die on top of this block.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
isWood (BooleanArray)
Description: If true the block prevent leaves connected to it from decaying. This should be set to true if used in trees.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
light (IntegerArray)
Description: Defines the amount of the light the block emits.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 15 (including both).
material (Material)
Description: Defines the block's material. It is used for different things. For example if it is set to rock or iron it can only mined with a pickaxe.
Default value: "rock"
Default value overrides:
fluid: "water"
Useable types:This attribute can be used with all types.
Value restriction:
grass
ground
wood
rock
iron
water
lava
leaves
plants
vine
sponge
cloth
fire
sand
circuits
glass
redstoneLight
tnt
ice
snow
craftedSnow
cactus
clay
pumpkin
modelTexture (Texture)
Description: Defines the texture file for the chest.
Default value: no default value
Useable types:chest
Value restriction:No value restriction.
name (String)
Description: Defines the interal name of the block. It should be unique.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No whitespaces.
onActivated (ScriptArray)
Description: Defines the script that is called when the player activates (rightclicks) the block. You can use mod, config, world, position and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onAdded (ScriptArray)
Description: Defines the script that is called when the block was added to the world. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onBonemeal (ScriptArray)
Description: Defines the script that is called when a player uses bonmeal on this block. You can use mod, config, world, position and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onBreak (ScriptArray)
Description: Defines the script that is called when the block gets removed. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onClicked (ScriptArray)
Description: Defines the script that is called when the player clicks the block. You can use mod, config, world, position and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onCollided (ScriptArray)
Description: Defines the script that is called when an entity collides with the block. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onDestroyedByPlayer (ScriptArray)
Description: Defines the script that is called when the block was destroyed by a player. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onFallenUpon (ScriptArray)
Description: Defines the script that is called when an entity falls on the block. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onNeighborChange (ScriptArray)
Description: Defines the script that is called when a neighbor block changes. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onPlaced (ScriptArray)
Description: Defines the script that is called when the block was placed. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onPlacedBy (ScriptArray)
Description: Defines the script that is called when an entity places the block. It is not called if a player placed the block. This is called after onPlaced. You can use mod, config, world, position, and living for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onPlacedByPlayer (ScriptArray)
Description: Defines the script that is called when a player places the block. This is called after onPlaced. You can use mod, config, world, position, and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onRedstoneSignal (ScriptArray)
Description: Defines the script that is called when the block is added or a neighbor changed. You can use mod, config, world, position and redstoneSignal.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onUpdate (ScriptArray)
Description: Defines the script that is called every [tickrate] ticks. You can use mod, config, world and player for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
onWalking (ScriptArray)
Description: Defines the script that is called when an entity is walking on the block. You can use mod, config, world and position for scripts.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
opacity (Integer)
Description: Defines how much light goes through the block. 0 means all and 255 means nothing.
Default value: 255
Default value overrides:
button: 0
door: 0
fence: 0
fenceGate: 0
ladder: 0
pressurePlate: 0
sapling: 0
step: 0
torch: 0
trapDoor: 0
crossTexture: 0
pane: 0
liquid: 3
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
pick (ItemStackArray)
Description: Defines the block that you'll get when you middleclick a block in creative.
Default value: [id]:0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
redstoneOnly (Boolean)
Description: If true the block can only opened with redstone.
Default value: false
Useable types:door
fenceGate
trapDoor
Value restriction:No value restriction.
resistance (FloatArray)
Description: Defines the resistance against explosions.
Default value: 0.0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
semiTransparent (Boolean)
Description: Defines if this block uses a semi transparent texture.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
stepSound (StepSound)
Description: Defines the stepsound and the mining sound of the block.
Default value: "stone"
Useable types:This attribute can be used with all types.
Value restriction:
cloth
glass
grass
gravel
metal
powder
sand
stone
wood
textureFile (Texture)
Description: Defines the textureFile the block gets its texture from.
Default value: /terrain.png
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
textureIndexXN (IntegerArray)
Description: Defines the texture index of the x-negative side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
textureIndexXP (IntegerArray)
Description: Defines the texture index of the x-positive side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
textureIndexYN (IntegerArray)
Description: Defines the texture index of the y-negative side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
textureIndexYP (IntegerArray)
Description: Defines the texture index of the y-positive side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
textureIndexZn (IntegerArray)
Description: Defines the texture index of the z-negative side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
textureIndexZP (IntegerArray)
Description: Defines the texture index of the z-positive side of the block.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:0 to 255 (including both).
tickrate (Integer)
Description: Defines amount of ticks between an onUpdate call. For button and pressurePlate the tickrate defines how long they remain pressed.
Default value: 10
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
tileEntity (StringArray)
Description: Defines the tile entity of the block. This is a named used for the name attribute in a tile entity file.
Default value: ""
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
tileTransparent (BooleanArray)
Description: Defines if two faces of the same block are not shown (like glass).
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
transparent (Boolean)
Description: Defines if this block uses a transparent texture.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
trigger (String)
Description: Defines what entities can trigger the pressure plate.
Default value: "all"
Useable types:pressurePlate
Value restriction:
all
players
mobs
hostiles
animals
items
noplayers
nomobs
nohostiles
noanimals
noitems
Tile entities
Methods
- addTileEntity
Attributes
colLength (Integer)
Description: Defines how many slots a column has.
Default value: 6
Useable types:chest
chestblock
Value restriction:No value restriction.
name (String)
Description: Defines the name of the tile entity.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No whitespaces.
rowLength (Integer)
Description: Defines how many slots a row has.
Default value: 9
Useable types:chest
chestblock
Value restriction:No value restriction.
ticksToSmelt (Integer)
Description: Defines how many ticks are used to smelt an item.
Default value: 200
Useable types:furnace
Value restriction:No value restriction.
usedFuelLists (StringList)
Description: Defines what fuels the furnace can use.
Default value: "vanilla"
Useable types:furnace
Value restriction:No value restriction.
usedRecipeLists (StringList)
Description: Defines what smelting recipes the furnace can use.
Default value: "vanilla"
Useable types:furnace
Value restriction:No value restriction.
GUIs
Methods
- addGui
Attributes
burnDestX (Integer)
Description: The x-coordinate of the burn "animation" inside the gui.
Default value: 56
Useable types:furnace
Value restriction:No value restriction.
burnDestY (Integer)
Description: The y-coordinate of the burn "animation" inside the gui.
Default value: 36
Useable types:furnace
Value restriction:No value restriction.
burnHeight (Integer)
Description: The height of the burn "animation".
Default value: 14
Useable types:furnace
Value restriction:No value restriction.
burnSrcX (Integer)
Description: The x-coordinate of the burn "animation" outside the gui.
Default value: 176
Useable types:furnace
Value restriction:No value restriction.
burnSrcY (Integer)
Description: The y-coordinate of the burn "animation" outside the gui.
Default value: 0
Useable types:furnace
Value restriction:No value restriction.
burnWidth (Integer)
Description: The width of the burn "animation".
Default value: 14
Useable types:furnace
Value restriction:No value restriction.
chestX (Integer)
Description: Defines the x-coordinate of the chest inventory.
Default value: 8
Useable types:chest
Value restriction:No value restriction.
chestY (Integer)
Description: Defines the y-coordinate of the chest inventory.
Default value: 18
Useable types:chest
Value restriction:No value restriction.
colLength (Integer)
Description: Defines how many slots a column in the crafting grid has.
Default value: 3
Useable types:crafting
Value restriction:No value restriction.
cookDestX (Integer)
Description: The x-coordinate of the cook "animation" inside the gui.
Default value: 79
Useable types:furnace
Value restriction:No value restriction.
cookDestY (Integer)
Description: The y-coordinate of the cook "animation" inside the gui.
Default value: 34
Useable types:furnace
Value restriction:No value restriction.
cookHeight (Integer)
Description: The height of the cook "animation".
Default value: 16
Useable types:furnace
Value restriction:No value restriction.
cookSrcX (Integer)
Description: The x-coordinate of the cook "animation" outside the gui.
Default value: 176
Useable types:furnace
Value restriction:No value restriction.
cookSrcY (Integer)
Description: The y-coordinate of the cook "animation" outside the gui.
Default value: 14
Useable types:furnace
Value restriction:No value restriction.
cookWidth (Integer)
Description: The width of the cook "animation".
Default value: 24
Useable types:furnace
Value restriction:No value restriction.
craftingX (Integer)
Description: Defines the x-coordinate of the crafting grid.
Default value: 30
Useable types:crafting
Value restriction:No value restriction.
craftingY (Integer)
Description: Defines the y-coordinate of the crafting grid.
Default value: 17
Useable types:crafting
Value restriction:No value restriction.
fuelX (Integer)
Description: Defines the x-coordinate of the fuel slot.
Default value: 56
Useable types:furnace
Value restriction:No value restriction.
fuelY (Integer)
Description: Defines the y-coordinate of the fuel slot.
Default value: 53
Useable types:furnace
Value restriction:No value restriction.
guiFile (Texture)
Description: Defines the gui file.
Default value: no default value
Default value overrides:
chest: "/gui/container.png"
furnace: "/gui/furnace.png"
crafting: "/gui/crafting.png"
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
height (Integer)
Description: Defines the height of the gui.
Default value: 166
Default value overrides:
chest: 222
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
inputX (Integer)
Description: Defines the x-coordinate of the input slot.
Default value: 56
Useable types:furnace
Value restriction:No value restriction.
inputY (Integer)
Description: Defines the y-coordinate of the input slot.
Default value: 17
Useable types:furnace
Value restriction:No value restriction.
inventoryX (Integer)
Description: Defines the x-coordinate of the player inventory.
Default value: 8
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
inventoryY (Integer)
Description: Defines the y-coordinate of the player inventory.
Default value: 84
Default value overrides:
chest: 140
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
name ()
Description: Defines the name of the gui. It is used when opening a gui in a script.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No whitespaces.
resultX (Integer)
Description: Defines the x-coordinate of the result slot.
Default value: 124 (crafting), 116 (furnace)
Useable types:crafting
furnace
Value restriction:No value restriction.
resultY (Integer)
Description: Defines the y-coordinate of the result slot.
Default value: 35
Useable types:crafting
furnace
Value restriction:No value restriction.
rowLength (Integer)
Description: Defines how many slots a row in the crafting grid has.
Default value: 3
Useable types:crafting
Value restriction:No value restriction.
stringColor (ColorArray)
Description: Defines the color of the strings.
Default value: "404040"
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
stringText (StringArray)
Description: Defines the strings that are drawn on the gui.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
stringX (IntegerArray)
Description: Defines the x-coordinate of the strings.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
stringY (IntegerArray)
Description: Defines the y-coordinate of the strings.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
usedRecipeLists (StringList)
Description: Defines what recipes the crafting table uses.
Default value: vanilla
Useable types:crafting
Value restriction:No value restriction.
width (Integer)
Description: Defines the width of gui.
Default value: 176
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
World generations
Methods
- addWorldGen
Attributes
blockId (Integer)
Description: Defines the id of the generated block.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
blockMeta (Integer)
Description: Defines the metadata of the generated block.
Default value: no default value
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
blockRate (Integer)
Description: Defines how many flower are generated at one place. 64 is the rate of the vanilla flowers.
Default value: 64
Useable types:flower
Value restriction:No value restriction.
generateInEnd (Boolean)
Description: Defines if the generator is called in the end.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
generateInNether (Boolean)
Description: Defines if the generator is called in the nether.
Default value: false
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
generateInOverworld (Boolean)
Description: Defines if the generator is called in the overworld.
Default value: true
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
generationsPerChunk (Float)
Description: Defines how often the generator is called per chunk.
Default value: 1.0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
maxHeight (Integer)
Description: Defines the maximum height in which the generator is called.
Default value: 255
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
minHeight (Integer)
Description: Defines the minimum height in which the generator is called.
Default value: 0
Useable types:This attribute can be used with all types.
Value restriction:No value restriction.
numberOfBlocks (Integer)
Description: Defines how many blocks are generated at one ore vein at maximum.
Default value: 1
Useable types:ore
Value restriction:No value restriction.
Other
Item types
armor
This is the armor item. It is used to create armor items. Only armor items can be put into the armor slots of the player's inventory.
bucket
This is the bucket item. It is used to create a new filled bucket. You'll get the bucket if you use a vanilla empty bucket on the given fluid.
door
This is the door item. It is used to place a door in the world. To use this you also have to create a door block or use the vanilla doors.
food
This is the food item. It is used to create food or drinks. When the food is eaten the stack size is decremented and a potion effect will be added to the player if there is one.
normal
This is the normal item. It has nothing special.
Block types
button
This is the button block. You can't use metadata for this block.
chest
This is the chest block. It is used to create open lid chests. It is not required to create block like chests. You can't use metadata for this block.
crossTexture
This is the cross texture block. It is used to create flower like blocks. You can use metadata for this block.
door
This is the door block. You can't use metadata for this block.
fence
This is the fence block. You can use metadata for this block.
fenceGate
This is the fence gate block. You can't use metadata for this block.
fluid
This is the fluid block. It uses id for the flowing and id2 for the still block. It doesn't use textureFile and textureIndex. Only use water or lava as material. You can't use metadata for this block.
gravity
This is the gravity block. It is used to create sand like blocks but it can also have negated gravity so it goes up in the air. You can use metadata for this block.
ladder
This is the ladder block. You can't use metadata for this block.
normal
This is the normal block. It has nothing special. You can use metadata for this block.
pane
This is the pane block. It is used to create thin glass like blocks. You can use metadata for this block.
pressurePlate
This is the pressure plate block. You can't use metadata for this block.
slab
This is the slab block. You can use metadata 0 to 7 for this block.
stairs
This is the stairs block. You can't use metadata for this block.
torch
This is the torch block. This torch can also be placed on ceilings. You can't use metadata for this block.
trapDoor
This is the trap door block. You can't use metadata for this block.
Tile entity types
chest
This is the chest tile entity. It is used to create lid open chests.
chestBlock
This is the chest block tile entity. It is used to create block like chests.
furnace
This is the furnace tile entity. It is used to create a furnace.
normal
This is the normal tile entity. It is used to store data in a block. All other tile entities have also this ability.
GUI types
chest
This is the chest GUI. It is used to create open lid and block like chests.
crafting
This is the crafting GUI. It is used to create crafting tables.
furnace
This is the furnace GUI. It is used to create furnaces.
World generation types
flower
This generator generates blocks like flowers are generated.
ore
This generator generates blocks like coal, iron, etc are generated.
Attribute types
Boolean
This attribute can only store the values true and false
BooleanArray
This attribute is an array of Boolean.
isWood[5] = true;
// Sets the first value of isFireSource to true
isFireSource[0] = true;
Color
This attribute stores color values.
color = "ff0000";
ColorArray
This attribute is an array of Color
stringColor[0] = "ffffff";
// Sets the 8th value of stringColor to green
stringColor[8] = "00ff00";
CreativeTab
This attribute stores a creative tab. Valid values are "buildingBlocks", "decorations", "redstone", "transportation", "misc", "search", "food", "tools", "combat", "brewing", "materials" and "inventory".
creativeTab = "redstone";
CreativeTabArray
This attribute is an array of CreativeTab.
creativeTab[7] = "decorations";
EnumAction
This attribute stores an action. Valid values are "none", "drink", "eat" and "block".
EnumArmorMaterial
This attribute stores an armor material. Valid values are "cloth", "chain", "iron", "gold" and "diamond".
Float
This attribute stores an float.
FloatArray
This attribute is an array of Float.
hardness[2] = 9.45;
Integer
This attribute stores an integer.
IntegerArray
This attribute is an array of Integer.
hardness[7] = 14;
IntegerList
This attribute stores a list of Integer.
ItemStack
This attribute stores an item stack (id, metadata and stack size). The stack size isn't used for all attributes. You can use aliases here.
containerItem = "1";
// Sets the id to 35, the metadata to 1 and the stack size to 5
containerItem = "35:1 5";
// Sets the id to the alias id, the metadata to alias metadata or 0 if it hasn't any and the stack size to 4.
containerItem = "dirt 4";
ItemStackList
This attribute stores a list of ItemStack.
Material
This attribute stores a block material. Valid values are "grass", "ground", "wood", "rock", "iron", "water", "lava", "leaves", "plants", "vine", "sponge", "cloth", "fire", "sand", "circuits", "glass", "redstoneLight", "tnt", "ice", "snow", "craftedSnow", "cactus", "clay" and "pumpkin".
Potion
This attribute stores a potion. Valid values are "moveSpeed", "moveSlowdown", "digSpeed", "digSlowDown", "damageBoost", "heal", "harm", "jump", "confusion", "regeneration", "resistance", "fireResistance", "waterBreathing", "invisibility", "blindness", "nightVision", "hunger", "weakness" and "poison".
Script
This attribute stores a javascript script.
ScriptArray
This attribute is an array of Script.
StepSound
This attribute stores a step sound value. Valid values are "cloth", "glass", "grass", "gravel", "metal", "powder", "sand", "stone" and "wood".
String
This attribute stores a string.
StringArray
This attribute is an array of String.
StringList
This attribute is an list of String.
Texture
This attribute stores a texture file. Values that don't start with '/' a read from the texture directory of your custom stuff mod directory.
textureFile = "/gui/crafting.png";
// Uses the file from your texture directory.
textureFile = "myTexture.png";