Mineable Component

From wiki
Revision as of 05:13, 14 December 2017 by DeamonHunter (Talk | contribs) (Update Page.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Category:Component Modding are all optional properties that can be added to any file. Components are useful in extending the original files with even more information, such as the cost of the item or whether the block can be broken by a weapon.

On this page, we go over the Mineable component, signified by the following;

"mineable": { }

Mineable components are the compliment to Pickaxe Items. They are used on Tiles specifically, and are used to specify that Pickaxe Items can break this tile.


When and How to use

Mineable components should be used on any tile that you would want broken by an Pickaxe. This is mostly any stone tiles, such as bricks, but generally not stone furniture (which is commonly handled by Hammer Items and Hammerable Component)

To create this component you would use the following;

"mineable": { }

Or if you want a specific set of items dropped, then you would use;

"mineable": { 
  "treasure" : "staxel.treasure.something"
}

This #"treasure" property contains the code to a Treasure Pool and would be used to specify a set of items.

If you only want the same tile to spawn, then you will need to use the Spawn On Break Component in order to specify.


Config Options

All config options must be inside the body of;

"mineable": {
  =Config Here=
}

"treasure"

Valid options (String): A string containing the code to a Treasure Pool.

Default Value: If not specified, will not spawn any items.


This is the treasure pool it will use in order to give out items to the player. If you want the specific tile broken to spawn, without creating a new Treasure, check out Spawn On Break Component.