View source for Feeder Component

[[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 Component, signified by the following;
<pre>
"feeder": {
  =Content=
}
</pre>
Feeder Components are used to specify tiles that animals and pets can eat from. This component contains information about the capacity and type of food it can contain. This component also complements the [[Feeder Helper Component]], which provides information on tiles meant to go into the feeder.

= When and How to use =
Feeder Component is used whenever you want to make a tile that animals can eat out of.  Specifically, an Feeder component is needed whenever a [[Tile]] has it [[Tile#"tileStateKind"]] equal to "staxel.tileState.Feeder". Otherwise Feeder component will do nothing.

To start off with first, you will need to create a [[Tile]] with [[Tile#"tileStateKind"]] equal to "staxel.tileState.Feeder". Once that is done, you can add the following below the last property of the file;
<pre>
"feeder": {
  "emptyFeederCode": "staxel.tileObject.animalFurniture.ChickenFeedAreaEmpty",
  "feedCapacity": 4,
  "feedKind": "chickenFeed"
}
</pre>

'''If this is the empty tile, then do not include any properties inside of feeder.'''

"emptyFeederCode" is the code of the "Tile" you want to use when this tile is emptied.  "feedCapacity" is the number of units this feeder can take. If it is empty then do not include. "feedKind" is the type of food that you want to use. Look at the specific [[Animals|Animal]] to look at their feed type.

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


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

== "emptyFeederCode" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing a code to a [[Tile]].</code>'''

'''Default Value:''' If not specified, will treat this tile as the empty


This is the tile to switch to when the food is gone. It will switch to this tile if currentFood = 0 and feedCapacity != 0. 


== "feedCapacity" ==
'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>A positive integer number.</code>'''

'''Default Value:''' If not specified, will have 0 capacity.


This is the maximum amount of food this tile can use. If this is 0, then "emptyFeederCode" is not used, otherwise it will use "emptyFeederCode" when it runs out of food.


== "feedKind" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string matching the food type an [[Farm Animal|Farm Animal/Pet]] eats.</code>'''

'''Default Value:''' If not specified, will not have any type.


This specifies what type of food this tile is for. This is especially needed to feed certain types of animals.