Pricing Component - Revision history

MarkGrant: added exceptions

2020-11-03T09:22:29Z

added exceptions

Toketsupuurin at 08:41, 3 November 2020

2020-11-03T08:41:23Z

Toketsupuurin at 08:33, 3 November 2020

2020-11-03T08:33:07Z

MarkGrant: /* "sellable" */

2020-08-27T18:28:35Z

‎"sellable"

MarkGrant: bool

2020-08-27T18:28:27Z

bool

DeamonHunter: Added "sellable".

2018-01-31T11:39:23Z

Added "sellable".

DeamonHunter: Update Page.

2017-12-14T10:56:01Z

Update Page.

DeamonHunter: Formatting changes

2017-07-12T08:24:02Z

Formatting changes

DeamonHunter: Initial commit.

2017-07-11T08:48:06Z

Initial commit.

New page

[[Category:Component Modding]]
[[: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 Pricing component, signified by the following;
<pre>
"pricing": {
=Content=
}
</pre>
Pricing components are the most universal component. They are used for [[Items]], [[Tile|Tiles]], and plenty of other files. Literally anything that could be sold to players will use the pricing component to do so.

= When and How to use =
Pricing components should be used whenever you want an item to be sold or bought. It is not needed when the item should not be bought OR sold. (i.e. Creative only items, Debugging items etc).

To create this component you would use the following;
<pre>
"pricing": {
"value": 10.0,
"sellPrice": 6.0,
"buyable": true
}
</pre>

"value" is the amount you want people to buy this object for. "sellPrice" is the amount you want people to sell this item for. A typical "sellPrice" in staxel is roughly 60% of the buying price. And buyable is whether or not you want to let players buy it from the catalogue. (i.e. Setting to false hides the item from catalogue.)

And that's it for all the properties in the Pricing Component. It is a very simple component but it does a whole lot.

= Config Options =
All config options must be inside the body of;
<pre>
"pricing": {
=Config Here=
}
</pre>

== "value" ==
'''Valid options (Float): <code>A positive decimal number.</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

This is the price at which the people will buy this object for.

== "sellPrice" ==
'''Valid options (Float): <code>A positive decimal number.</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

This is the price at which the people will sell this object for.

== "buyable" ==
'''Valid options (Bool): <code>True or False</code>'''

'''Default Value:''' True.

States whether or not this item can be bought from the catalogue.

@@ Line 52: / Line 52: @@
-This is the price at which the people will sell this object for.
+This is the price at which the people will sell this object for. Sell price must be less than or equal to buy price.
@@ Line 62: / Line 62: @@
 States whether or not this item can be bought from the catalogue.
 == "sellable" ==
@@ Line 67: / Line 68: @@
 '''Default Value:''' If not specified, will default to True.
 == "canBeEarntFromLuckyBox" ==
@@ Line 74: / Line 76: @@
 States whether or not this item can be gotten from a Lucky Box. It's recommended to leave this as true unless it's a quest item or some kind of reward or limited access item.
 == "appearsInCatalogue" ==
@@ Line 81: / Line 84: @@
 Defines whether or not an item is allowed to appear in the catalog.
 == "catalogueUnlockedFromStart" ==
@@ Line 88: / Line 92: @@
 Defines whether or not an item is one of the catalog's "starter" items. If this is false the item will only appear in the catalog after the player has obtained or inspected it.

← Older revision		Revision as of 08:41, 3 November 2020
Line 73:		Line 73:
	'''Default Value:''' If not specified, will default to True.		'''Default Value:''' If not specified, will default to True.

−	States whether or not this item can be gotten from a Lucky Box.	+	States whether or not this item can be gotten from a Lucky Box. It's recommended to leave this as true unless it's a quest item or some kind of reward or limited access item.
		+
		+	== "appearsInCatalogue" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False</code>'''
		+
		+	'''Default Value:''' If not specified, will default to True.
		+
		+	Defines whether or not an item is allowed to appear in the catalog.
		+
		+	== "catalogueUnlockedFromStart" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False</code>'''
		+
		+	'''Default Value:''' If not specified, will default to the same setting as "appearsInCatalogue".
		+
		+	Defines whether or not an item is one of the catalog's "starter" items. If this is false the item will only appear in the catalog after the player has obtained or inspected it.

← Older revision		Revision as of 08:33, 3 November 2020
Line 68:		Line 68:
	'''Default Value:''' If not specified, will default to True.		'''Default Value:''' If not specified, will default to True.

		+	== "canBeEarntFromLuckyBox" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False</code>'''

−	States whether or not this item can be ~~sold. Useful for making sure important items can't be sold~~.	+	'''Default Value:''' If not specified, will default to True.
		+
		+	States whether or not this item can be gotten from a Lucky Box.

@@ Line 64: / Line 64: @@
 == "sellable" ==
-'''Valid options ([[Modding_Key_Terms#Bool|Boll]]): <code>True or False</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False</code>'''
 '''Default Value:''' If not specified, will default to True.

@@ Line 56: / Line 56: @@
 == "buyable" ==
-'''Valid options ([[Modding_Key_Terms#Bool|Boll]]): <code>True or False</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False</code>'''
 '''Default Value:''' If not specified, will default to True.
@@ Line 62: / Line 62: @@
 States whether or not this item can be bought from the catalogue.
 == "sellable" ==

@@ Line 19: / Line 19: @@
    "value": 10.0,
    "sellPrice": 6.0,
-   "buyable": true
+   "buyable": true,
+}
 </pre>
-[[#"value"]] is the amount you want people to buy this object for. [[#"sellPrice"]] is the amount you want people to sell this item for. The typical selling price in staxel is roughly 60% of the buying price. And [[#"buyable"]] is whether or not you want to let players buy it from the catalogue. (i.e. Setting to false hides the item from catalogue.)
+[[#"value"]] is the amount you want people to buy this object for. [[#"sellPrice"]] is the amount you want people to sell this item for. The typical selling price in staxel is roughly 60% of the buying price. And [[#"buyable"]] is whether or not you want to let players buy it from the catalogue. (i.e. Setting to false hides the item from catalogue.) [[#"sellable"]] is whether or not you want to let players to sell the item.
 And that's it for all the properties in the Pricing Component. It is a very simple component but it does a whole lot.
@@ Line 61: / Line 62: @@
 States whether or not this item can be bought from the catalogue.

@@ Line 23: / Line 23: @@
 </pre>
-"value" is the amount you want people to buy this object for. "sellPrice" is the amount you want people to sell this item for. A typical "sellPrice" in staxel is roughly 60% of the buying price. And buyable is whether or not you want to let players buy it from the catalogue. (i.e. Setting to false hides the item from catalogue.)
+[[#"value"]] is the amount you want people to buy this object for. [[#"sellPrice"]] is the amount you want people to sell this item for. The typical selling price in staxel is roughly 60% of the buying price. And [[#"buyable"]] is whether or not you want to let players buy it from the catalogue. (i.e. Setting to false hides the item from catalogue.)
 And that's it for all the properties in the Pricing Component. It is a very simple component but it does a whole lot.
@@ Line 37: / Line 37: @@
 == "value" ==
-'''Valid options (Float): <code>A positive decimal number.</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 46: / Line 46: @@
 == "sellPrice" ==
-'''Valid options (Float): <code>A positive decimal number.</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 55: / Line 55: @@
 == "buyable" ==
-'''Valid options (Bool): <code>True or False</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Boll]]): <code>True or False</code>'''
-'''Default Value:''' True.
+'''Default Value:''' If not specified, will default to True.
 States whether or not this item can be bought from the catalogue.

@@ Line 13: / Line 13: @@
 = When and How to use =
 Pricing components should be used whenever you want an item to be sold or bought. It is not needed when the item should not be bought OR sold. (i.e. Creative only items, Debugging items etc).
 To create this component you would use the following;
@@ Line 36: / Line 35: @@
+}
 </pre>
 == "value" ==