Feeder Helper Component - Revision history

DeamonHunter: Update formatting.

2017-11-21T05:12:37Z

Update formatting.

DeamonHunter: Formatting changes.

2017-07-20T06:40:34Z

Formatting changes.

DeamonHunter: Initial commit.

2017-07-20T04:51:04Z

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 Feeder Helper component, signified by the following;
<pre>
"feederHelper": {
=Content=
}
</pre>
Feeder Helper components are used to specify items that can turn Feeder Tiles into Feeder Tiles with food. This component basically only has the information to fill feeder tiles. This component also complements the [[Feeder Component]], which provides information on creating feeders.

= When and How to use =
Feeder Helper component is used whenever you want to make a item that can fill feeders. Specifically, most animal food items should have this property

To start off with first, you will need to create an [[Items|Item]]. Once that is done, you can add the following below the last property of the file;
<pre>
"feederHelper": {
"canReplace": [
{
"from": "staxel.tileObject.animalFurniture.SlopTroughEmpty",
"to": "staxel.tileObject.animalFurniture.SlopTroughFeed"
}
],
"feedAmount": 8,
"replaceSound" : "staxel.sound.whatever"
},
</pre>
"canReplace" contains a list of blobs which have two properties. "from" is the [[Tile]] to check for, "to" is the tile to change to. "feedAmount" is how much food this will add to the feeder. "replaceSound" is the [[Sound]] to play when filling the feeder.

With that, this component is complete. You may want to also look into [[Feeder Component]] for making the feeder.

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

== "canReplace" ==
This is a list of blobs that contain exactly two properties. This property can often look like;
<pre>
"canReplace": [
{
"from": "staxel.tileObject.animalFurniture.SlopTroughEmpty",
"to": "staxel.tileObject.animalFurniture.SlopTroughFeed"
},
{
"from": "staxel.tileObject.animalFurniture.SlopTroughEmpty",
"to": "staxel.tileObject.animalFurniture.SlopTroughFeed"
}
]
</pre>

"from" is the [[Tile]] code to check for.

"to" is the [[Tile]] code for the tile to switch to.

== "feedAmount" ==
'''Valid options (Int): <code>A positive integer number</code>'''

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

This is the amount of food to add to the tile when it is spawned.

== "replaceSound" ==
'''Valid options (String): <code>A string matching the food type an [[Sound]] eats</code>'''

'''Default Value:''' If not specified, will not play any sound.

This specifies a sound to play when switching the tiles around.

@@ 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 Feeder Helper component, signified by the following;
+On this page, we go over the Feeder Helper Component, signified by the following;
 <pre>
 "feederHelper": {
@@ Line 8: / Line 8: @@
+}
 </pre>
-Feeder Helper components are used to specify items that can turn Feeder Tiles into Feeder Tiles with food. This component basically only has the information to fill feeder tiles. This component also complements the [[Feeder Component]], which provides information on creating feeders.
+Feeder Helper Components are used to specify items that can turn Feeder Tiles into Feeder Tiles with food. This component basically only has the information to fill feeder tiles. This component also complements the [[Feeder Component]], which provides information on creating feeders.
 = When and How to use =
-Feeder Helper component is used whenever you want to make a item that can fill feeders.  Specifically, most animal food items should have this property
+Feeder Helper Component is used whenever you want to make a item that can fill feeders.  Specifically, most animal food items should have this property
 To start off with first, you will need to create an [[Items|Item]]. Once that is done, you can add the following below the last property of the file;
@@ Line 40: / Line 40: @@
 == "canReplace" ==
-This is a list of blobs that contain exactly two properties. This property can often look like;
+This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]] that contain exactly two properties. This property can often look like;
 <pre>
 "canReplace": [
@@ Line 60: / Line 60: @@
 == "feedAmount" ==
-'''Valid options (Int): <code>A positive integer number</code>'''
+'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>A positive integer number</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 69: / Line 69: @@
 == "replaceSound" ==
-'''Valid options (String): <code>A string matching the food type an [[Sound]] eats</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Sound]].</code>'''
 '''Default Value:''' If not specified, will not play any sound.

@@ Line 63: / Line 63: @@
 '''Default Value:''' No default value is specified. Always need to provide your own.
 This is the amount of food to add to the tile when it is spawned.
@@ Line 71: / Line 72: @@
 '''Default Value:''' If not specified, will not play any sound.
 This specifies a sound to play when switching the tiles around.