Fishing Rod Items - Revision history

DeamonHunter: Oops.

2017-12-12T11:41:51Z

Oops.

DeamonHunter: Oops.

2017-12-12T11:29:57Z

Oops.

DeamonHunter: Update Page.

2017-12-12T11:25:56Z

Update Page.

DeamonHunter: Fix red links

2017-07-13T07:28:47Z

Fix red links

DeamonHunter: Initial commit.

2017-07-13T07:27:20Z

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 allow you to fish

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

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

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

= Creating a Fishing Rod Item =
Fishing Rods 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.Rod". Secondly add the following to the end of the file;
<pre>
"fishing" {
"castEffect": "staxel.particle.fishing.RodPull",
"castSoundGroup": "staxel.sounds.place.Water",
"reelEffect": "staxel.particle.fishing.RodCatching",
"reelSoundGroup": "staxel.sounds.place.Water",
"catchEffect": "staxel.particle.fishing.RodPull",
"catchSoundGroup": "staxel.sounds.place.Water",
"indicator": "staxel/item/gatherables/RodBobber.qb",
"castDistance": 10.0,
"successTranslations": [
"fishing.success1",
"fishing.success2",
"fishing.success3"
]
}
</pre>
Most of these properties are just for customising how fishing will look. "castEffect" is the [[Effects|Effect]] it will play while casting. "castSoundGroup" is the [[Sounds]] it will play when casting. "reelEffect" is the [[Effects|Effect]] it will play while reeling. "reelSoundGroup" is the [[Sounds]] it will play when reeling. "catchEffect" is the [[Effects|Effect]] it will play while catching a fish. "catchSoundGroup" is the [[Sounds]] it will play when catching a fish. "indicator" is a model which will act as the floating bobber. "castDistance" is the maximum distance in which you can cast. And finally "successTranslations" is a list of strings which point to [[Translation]] codes to show when you have caught a fish.

= Spawning in a Fishing Rod Item =
Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.Rod" 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 [[Fishing Component#Config Options]].

← Older revision		Revision as of 11:41, 12 December 2017
Line 27:		Line 27:


−	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.	+	When you are done, close the window by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.

@@ Line 9: / Line 9: @@
 </pre>
-These items must also include a [[Fishing  Component]] in order to work. Fishing Rod items have the ability to fish on any water block.
+These items must also include a [[Fishing Component]] in order to work. Fishing Rod items have the ability to fish on any water block.
@@ Line 21: / Line 21: @@
 == Asset Manager ==
-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 "broom".
+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 "fishing".

@@ Line 9: / Line 9: @@
 </pre>
-And also must include a [[Fishing Component]] in order to actually do anything.
+These items must also include a [[Fishing  Component]] in order to work. Fishing Rod items have the ability to fish on any water block.
-−
-Fishing Rods actually act as normal [[Craft Items]] but have the ability to interact with a block that allows fishing. Most of the information required is kept in the component listed below.
 = Creating a Fishing Rod Item =
-Fishing Rods 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.
+Fishing Rods 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.Rod". 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.Rod".
 <pre>
 "fishing" {
@@ Line 35: / Line 49: @@
+}
 </pre>
 Most of these properties are just for customising how fishing will look. "castEffect" is the [[Effect]] it will play while casting. "castSoundGroup" is the [[Sound]] it will play when casting. "reelEffect" is the [[Effect]] it will play while reeling. "reelSoundGroup" is the [[Sound]] it will play when reeling. "catchEffect" is the [[Effect]] it will play while catching a fish. "catchSoundGroup" is the [[Sound]] it will play when catching a fish. "indicator" is a model which will act as the floating bobber. "castDistance" is the maximum distance in which you can cast. And finally "successTranslations" is a list of strings which point to [[Translation]] codes to show when you have caught a fish.
 = Spawning in a Fishing Rod Item =
-Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.Rod" 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.Rod" 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 [[Fishing Component#Config Options]].
+This item does need additional information. This additional information is contained in a [[Fishing Component]] which needs to be added along with the item file.