View source for Tile Replacer 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 "Tile Replacer" component, signified by the following;
<pre>
"tileReplacer": {
  =Content=
}
</pre>
Tile Replacer components are specifically for the item type, [[Replacers(Tile Transforming Items)]], providing all of the information needed to swap around weapons.


= When and How to use =
Tile Replacer components are, in most cases, only used to complement the [[Replacers(Tile_Transforming_Items)|Replacers]]. In other cases, this component is not used at all.


As this component is only ever used in one case, the information needed to create a Tile Replacer and this component is over at [[Replacers(Tile_Transforming_Items)#Creating a Replacer Item|this page]].


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

== "notificationTile" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string which contains the code of the [[Tile]] used in the error [[Notification]]</code>'''

'''Default Value:''' Can be omitted. But when omitted, the error will be "Try placing on ".


A string containing the Tile which the error will use. Specifically it will print out this tile's name in the error.

== "tiles" ==
This property actually contains a list of blobs. A common input to the property will look like the following;
<pre>
"tiles": [
  {
    "toReplaceTile": "staxel.tile.dirt.Dirt",
    "replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.1",
    "applyColouration": true
  },
  {
    "toReplaceTile": "staxel.tile.dirt.Dirt.tilled",
    "replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.1",
    "applyColouration": true
  }
],
</pre>


=== "toReplaceTile" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The code to an [[Tile]] file</code>'''

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


A string containing which tile you want to replace.


=== "replaceWithTile" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The code to an [[Tile]] file</code>'''

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


A string containing which tile you want to replace with.


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

'''Default Value:''' If not specified, will default to False.


This should be true if the replacing tile has the property [[Tile#"palette"]] non-blank and/or [[Tile#"smoothRecolorationOnPlace"]] to true. This allows it to recolour when placed. In all other cases it should be false.