Difference between revisions of "Consumable Component"
DeamonHunter (Talk | contribs) m (Small grammar issue.) |
DeamonHunter (Talk | contribs) (Update formatting.) |
||
| 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. | [[: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 | + | On this page, we go over the Drinkable Component, signified by the following; |
<pre> | <pre> | ||
"drinkable": { | "drinkable": { | ||
| Line 9: | Line 9: | ||
</pre> | </pre> | ||
| − | Drinkable | + | 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" == | == "colour" == | ||
| − | '''Valid options ( | + | '''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. | '''Default Value:''' No default value is specified. Always need to provide your own. | ||
| Line 46: | Line 46: | ||
== "drinkParticles" == | == "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:''' | + | '''Default Value:''' If not specified, will not play particles. |
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 drinking. | ||
Revision as of 00:08, 21 November 2017
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;
"drinkable": {
=Content=
}
Drinkable Components are specifically used alongside Craft Items that have been made a 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 Drink. It helps specify the visual particles that happen when drinking.
To create this component you would use the following;
"drinkable": {
"colour": "FFF3D377",
"drinkParticles": "staxel.particle.item.Drink"
},
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 Particle's Code.
And that is all.
Config Options
All config options must be inside the body of;
"drinkable": {
=Config Here=
}
"colour"
Valid options (Colour): A string that is formatted to be in ARGB or RGB colour (Alpha, Red, Green, Blue in the format AARRGGBB in hexadecimal)
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): A string containing the code to a Particle spawner.
Default Value: If not specified, will not play particles.
This is the particle spawner that will be used to create the particles while drinking.
