Replacers(Tile Transforming Items) - Revision history

DeamonHunter: Oops.

2017-12-12T11:41:59Z

Oops.

DeamonHunter: Minor grammatical change

2017-12-12T10:23:44Z

Minor grammatical change

DeamonHunter: Update Page. Added more to the tutorial

2017-12-12T09:50:09Z

Update Page. Added more to the tutorial

DeamonHunter: Initial commit.

2017-07-10T09:54:32Z

Initial commit.

New page

[[Category:Item Modding]]
[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses. This page is for items that when activated, they will replace a tile with another tile. For example, the game has seed packets which replace dirt with the grass of the respective type.

Replacer Items are all items that have the following line;
<pre>
"kind": "staxel.item.TileReplacer",
</pre>

And also must include a [[Tile Replacer Component]] in order to actually do anything.

Replacer items actually act as normal [[Craft Items]] but have the ability to interact with a block. Most of the information required is kept in the component listed below.

= Creating a Replacer Item =
Replacers are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Craft Items#Creating a Craft Item]], until you finish all of the steps there.

Once you have gone through that guide, there are two more steps you will need to do. First, change the "kind" from "staxel.item.CraftItem" to "staxel.item.TileReplacer". Secondly add the following to the end of the file;
<pre>

"replacerItem": {
"tiles": [
{
"toReplaceTile": "staxel.tile.dirt.Dirt",
"replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.2",
"applyColouration": true
},
{
"toReplaceTile": "staxel.tile.dirt.Dirt.tilled",
"replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.2",
"applyColouration": true
}
],
"notificationTile": "staxel.tile.dirt.Dirt"
},
</pre>

This looks complicated but it is not. The outermost property "replacerItem" is a component that holds all the information. (Specifically the [[Tile Replacer Component]]). Inside of that it includes two properties. The simpler property is "notificationTile", a property in which says what tile should be printed out onto the error message. The other property "tiles" is a list of blobs that contain 3 individual properties. Inside of tiles you have, "toReplaceTile" for the code of the [[Tile]] you want to replace, "replaceWithTile" for the code of the tile you want to replace with and "applyColouration". "applyColouration" 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.

= Spawning in a Replacer Item =
Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.TileReplacer" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.

= Config Options =
The list of basic properties is included at [[Craft Items#Config Options]].

All additional information being included at [[Tile Replacer Component#Config Options]].

← Older revision		Revision as of 11:41, 12 December 2017
Line 9:		Line 9:
	</pre>		</pre>

−	These items must also include a [[Tile Replacer Component]] in order to work. Replacer items have the ability to interact with a block and replace it with another block. It does this by searching for a specific tile then	+	These items must also include a [[Tile Replacer Component]] in order to work. Replacer items have the ability to interact with a block and replace it with another block. It does this by searching for a specific tile then replacing it with another tile.

@@ Line 53: / Line 53: @@
 </pre>
-With that out of the way, it is time to start editing these values. The outermost property "replacerItem" is known [[:Category:Component Modding|Component]] that holds all the information. (Specifically the [[Tile Replacer Component]]).
+With that out of the way, it is time to start editing these values. The outermost property "replacerItem" is known as a [[:Category:Component Modding|Component]] that holds all the information. (Specifically the [[Tile Replacer Component]]).
@@ Line 63: / Line 63: @@
 You can add more Tiles by following the pattern provided. Or you can remove the second entry if you only want to replace a single tile.

@@ Line 1: / Line 1: @@
 [[Category:Item Modding]]
-[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses. This page is for items that when activated, they will replace a tile with another tile. For example, the game has seed packets which replace dirt with the grass of the respective type.
+[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses.
 Replacer Items are all items that have the following line;
@@ Line 7: / Line 9: @@
 </pre>
-And also must include a [[Tile Replacer Component]] in order to actually do anything.
+These items must also include a [[Tile Replacer Component]] in order to work. Replacer items have the ability to interact with a block and replace it with another block. It does this by searching for a specific tile then
-−
-Replacer items actually act as normal [[Craft Items]] but have the ability to interact with a block. Most of the information required is kept in the component listed below.
 = Creating a Replacer Item =
-Replacers are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Craft Items#Creating a Craft Item]], until you finish all of the steps there.
+Replacers are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Items#How to Make a Normal Item]], until you finish all of the steps there.
-Once you have gone through that guide, there are two more steps you will need to do. First, change the "kind" from "staxel.item.CraftItem" to "staxel.item.TileReplacer". Secondly add the following to the end of the file;
+Once you have gone through that guide, there are two more steps you will need to do. The first step is to change the "kind" from "staxel.item.CraftItem" to "staxel.item.TileReplacer".
-<pre>
-  "replacerItem": {
+The second step depends on what you are using to create items.
-    "tiles": [
-−
-        "toReplaceTile": "staxel.tile.dirt.Dirt",
+== Asset Manager ==
-        "replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.2",
+Navigate to the item you had created before. Head to the components property and click on the <code>[...]</code>. When the new window pops up, click on "Add" and select "replacerItem".
-        "applyColouration": true
-      },
+Once that is done, the Asset Manager should have selected your new component. Click on "Notification Tile" and click the drop down to find the tile you want. This property gives the tile in the error message that appears when you use the item on the wrong tile.
-        "toReplaceTile": "staxel.tile.dirt.Dirt.tilled",
-        "replaceWithTile": "staxel.tile.fairyVillage.FairyGrassLayer.2",
-        "applyColouration": true
+Now onto the meat of the item, click on tiles and click on the <code>[...]</code>. When the new window pops up, click on "Add". A new entry will appear, you can now edit the values that just appeared. Click on these to find out what to do.
-−
-    ],
-    "notificationTile": "staxel.tile.dirt.Dirt"
+When you are done, close both windows by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.
-  },
 </pre>
-This looks complicated but it is not. The outermost property "replacerItem" is a component that holds all the information. (Specifically the [[Tile Replacer Component]]). Inside of that it includes two properties. The simpler property is "notificationTile", a property in which says what tile should be printed out onto the error message. The other property "tiles" is a list of blobs that contain 3 individual properties. Inside of tiles you have, "toReplaceTile" for the code of the [[Tile]] you want to replace, "replaceWithTile" for the code of the tile you want to replace with and "applyColouration". "applyColouration" 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.
+With that out of the way, it is time to start editing these values. The outermost property "replacerItem" is known [[:Category:Component Modding|Component]] that holds all the information. (Specifically the [[Tile Replacer Component]]).
 = Spawning in a Replacer Item =
-Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.TileReplacer" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.
+Follow the guide at [[Items#How to Spawn an Item]]. When that guide mentions "kind", make sure to use "staxel.item.TileReplacer" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.
 = Config Options =
-The list of basic properties is included at [[Craft Items#Config Options]].
+The list of basic properties is included at [[Items#Config Options]].
-All additional information being included at [[Tile Replacer Component#Config Options]].
+This item does need additional information. This additional information is contained in a [[Tile Replacer Component]] which needs to be added along with the item file.