Revision as of 02:28, 13 July 2017

Items are fairly broad in their types. Each 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;

"kind": "staxel.item.Rod",

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;

"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"
  ]
}

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.

Config Options

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

All additional information being included at Fishing Component#Config Options.