Sweepable Component

From wiki
Revision as of 11:02, 16 October 2018 by Maguschala (Talk | contribs) (Changed an instance of 'axe' to 'broom'.)

(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 Sweepable component, signified by the following;

"sweepable": { }

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

When and How to use

Sweepable components should be used on any tile that you would want broken by a broom. This is mostly things that should be swept like cobwebs (which is commonly handled by Broom Items and Sweepable Component)

To create this component you would use the following;

"sweepable": { }

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

"sweepable": { 
  "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;

"sweepable": {
  =Config Here=


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.