Coins Items - Revision history

DeamonHunter: Oops.

2017-12-12T11:41:15Z

Oops.

DeamonHunter: Update Page.

2017-12-12T10:43:42Z

Update Page.

DeamonHunter: Initial commit.

2017-07-12T08:17:27Z

Initial commit.

New page

[[Category:Item Modding]]
[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|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;
<pre>
"kind": "staxel.item.Coin",
</pre>

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;
<pre>
"currency": {
"petalWorth": 10.0,
},
</pre>

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]].

← Older revision		Revision as of 11:41, 12 December 2017
Line 27:		Line 27:


−	When you are done, close ~~both windows~~ by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.	+	When you are done, close the window by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.

@@ Line 9: / Line 9: @@
 </pre>
-And also must include a [[Currency Component]], otherwise it may not work as intended.
+These items must also include a [[Currency  Component]] in order to work. Currency items will add to the player's petals upon picking up rather than go to the inventory.
-−
-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.
+Coins are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Items#How to Make a Normal 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;
+Once you have gone through that guide, there are two more steps you will need to do. The first step is to change the "kind" from "staxel.item.CraftItem" to "staxel.item.Coin".
 <pre>
 "currency": {
-   "petalWorth": 10.0,
+   "petalWorth": 1
 },
 </pre>
-It's as simple as that. "petalWorth" is just how much this item will give upon being picked up.
+With that out of the way, it is time to start editing these values. The outermost property "currency" is known as a [[:Category:Component Modding|Component]] that holds all the information. (Specifically the [[Currency Component]]).
 = 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.
+Follow the guide at [[Items#How to Spawn an 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]].
+The list of basic properties is included at [[Items#Config Options]].
-All additional information being included at [[Currency Component#Config Options]].
+This item does need additional information. This additional information is contained in a [[Currency Component]] which needs to be added along with the item file.