Revision as of 04:17, 12 July 2017

Items are fairly broad in their types. Each type has it's own properties and uses.

This page is for coins, which will add to the player's money instead of being placed into the inventory.

Coin items are all items that have the following line;

"kind": "staxel.item.Coin",

And also must include a Currency Component, otherwise it may not work as intended.

Coin items actually act as normal Craft Items but have the ability to be spawned whenever currency is thrown into the world. Upon pickup, all Coins will disappear instead of being located in the inventory.

Creating a Coin Item

Coin are created in much the same way as Craft Items. In fact you should follow the guide, Craft Items#Creating a Craft Item, until you finish all of the steps there.

Once you have gone through that guide, there are two more steps you will need to do. First, change the "kind" from "staxel.item.CraftItem" to "staxel.item.Coin". Secondly add the following to the end of the file;

"currency": {
  "petalWorth": 10.0,
},

It's as simple as that. "petalWorth" is just how much this item will give upon being picked up.

Spawning in a Coin Item

Follow the guide at Craft Items#Spawning in a Craft Item. When that guide mentions "kind", make sure to use "staxel.item.Coin" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.

Config Options

The list of basic properties is included at Craft Items#Config Options.

All additional information being included at Currency Component#Config Options.