Consumable Component - Revision history

DeamonHunter: Updated drinkable component page to consumable component.

2017-12-05T09:26:26Z

Updated drinkable component page to consumable component.

DeamonHunter: DeamonHunter moved page Drinkable Component to Consumable Component: Component name was changed to make it applicable to eating as well.

2017-12-05T09:22:21Z

DeamonHunter moved page Drinkable Component to Consumable Component: Component name was changed to make it applicable to eating as well.

DeamonHunter: Update formatting.

2017-11-21T05:08:13Z

Update formatting.

DeamonHunter: Small grammar issue.

2017-07-19T03:49:14Z

Small grammar issue.

DeamonHunter: Initial commit.

2017-07-19T03:31:08Z

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 Drinkable component, signified by the following;
<pre>
"drinkable": {
}
</pre>

Drinkable components are specifically used alongside [[Craft Items]] that have been made a [[Craft Items#Creating a Food/Drink Item|Drink]]. This is used to specify the extra little things that go into making a drink.

= When and How to use =
Drinkable components are only used when a [[Craft Items]] is a [[Craft Items#Creating a Food/Drink Item|Drink]]. It helps specify the visual particles that happen when drinking.

To create this component you would use the following;
<pre>
"drinkable": {
"colour": "FFF3D377",
"drinkParticles": "staxel.particle.item.Drink"
},
</pre>

There are only two properties. The first is the 'colour' value of the particles. This is an ARGB colour (That is Alpha, Red, Green, Blue) specified in hexadecimal. The second is the "drinkParticles", which points to [[Particles|Particle's Code]].

And that is all.

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

== "colour" ==
'''Valid options (ARGB Colour): <code>A string that is formatted to be in ARGB colour (Alpha, Red, Green, Blue in the format AARRGGBB in hexadecimal)</code>'''

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

This is the colour that particles will spawn with. (Before colour variance)

== "drinkParticles" ==
'''Valid options (String): <code>A string containing the code to a [[Particles|Particle]] spawner</code>'''

'''Default Value:''' Can be omitted.

This is the particle spawner that will be used to create the particles while drinking.

@@ Line 2: / Line 2: @@
 [[: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 Drinkable Component, signified by the following;
+On this page, we go over the Consumable Component, signified by the following;
 <pre>
-"drinkable": {
+"consumable": {
    =Content=
+}
 </pre>
-Drinkable Components are specifically used alongside [[Craft Items]] that have been made a [[Craft Items#Creating a Food/Drink Item|Drink]]. This is used to specify the extra little things that go into making a drink.
+Consumable Components are specifically used alongside [[Craft Items]] that have been made a [[Craft Items#Creating a Food/Drink Item|Food or Drink]]. This is used to specify the extra little things that go into making a food/drink.
 = When and How to use =
-Drinkable components are only used when a [[Craft Items]] is a [[Craft Items#Creating a Food/Drink Item|Drink]]. It helps specify the visual particles that happen when drinking.
+Consumable components are only used when a [[Craft Items]] is a [[Craft Items#Creating a Food/Drink Item|Drink]]. It helps specify the visual particles that happen when drinking.
 To create this component you would use the following;
 <pre>
-"drinkable": {
+"consumable": {
    "colour": "FFF3D377",
-   "drinkParticles": "staxel.particle.item.Drink"
+   "particles": "staxel.particle.item.Drink",
 },
 </pre>
-There are only two properties. The first is the 'colour' value of the particles. This is an ARGB colour (That is Alpha, Red, Green, Blue) specified in hexadecimal. The second is the "drinkParticles", which points to [[Particles|Particle's Code]].
+There are only three properties. The first is the [[#"colour"]] value of the particles. This is an ARGB colour (That is Alpha, Red, Green, Blue) specified in hexadecimal. The second is the [[#"particles"]], which points to [[Particles|Particle System Code]]. The third is the [[#"sound"]], which points to [[Sound|Sound Code]].
-And that is all.
+These are all used immediately after eating/drinking the item.
@@ Line 31: / Line 32: @@
 All config options must be inside the body of;
 <pre>
-"drinkable": {
+"consumable": {
    =Config Here=
+}
@@ Line 45: / Line 46: @@
-== "drinkParticles" ==
+== "particles" ==
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Particles|Particle]] spawner.</code>'''
@@ Line 51: / Line 52: @@
-This is the particle spawner that will be used to create the particles while drinking.
+This is the particle spawner that will be used to create the particles while eating/drinking.

← Older revision	Revision as of 09:22, 5 December 2017
(No difference)

@@ Line 2: / Line 2: @@
 [[: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 Drinkable component, signified by the following;
+On this page, we go over the Drinkable Component, signified by the following;
 <pre>
 "drinkable": {
@@ Line 9: / Line 9: @@
 </pre>
-Drinkable components are specifically used alongside [[Craft Items]] that have been made a [[Craft Items#Creating a Food/Drink Item|Drink]]. This is used to specify the extra little things that go into making a drink.
+Drinkable Components are specifically used alongside [[Craft Items]] that have been made a [[Craft Items#Creating a Food/Drink Item|Drink]]. This is used to specify the extra little things that go into making a drink.
@@ Line 37: / Line 37: @@
 == "colour" ==
-'''Valid options (ARGB Colour): <code>A string that is formatted to be in ARGB colour (Alpha, Red, Green, Blue in the format AARRGGBB in hexadecimal)</code>'''
+'''Valid options ([[Modding_Key_Terms#Colour|Colour]]): <code>A string that is formatted to be in ARGB or RGB colour (Alpha, Red, Green, Blue in the format AARRGGBB in hexadecimal)</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 46: / Line 46: @@
 == "drinkParticles" ==
-'''Valid options (String): <code>A string containing the code to a [[Particles|Particle]] spawner.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Particles|Particle]] spawner.</code>'''
-'''Default Value:''' Can be omitted.
+'''Default Value:''' If not specified, will not play particles.
 This is the particle spawner that will be used to create the particles while drinking.