User:OnyxVindicator/sandbox/Fish Template Setup

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search

Fish data

Parameters

Item infobox data

Parameter Data
name Fish Name
icon Item icon image
item-description item description
release Patch Release (currently on the infobox; could stay here)
id-edb EDB link
id-gt TC/GT link

This is a subset of the data that is already datamined. No changes needed for the normal Item infobox

Fish info data (for non-spearfishing)

Parameter Data Data Sheet Data Column Index ID and Col Notes
guide-index index in Fish Guide (also used to map ItemID to GuideID)" FishParameter 0 "#"/index ItemID (col 6) This is for normal fishing (values less than 20,000)
guide-description fish guide description FishParameter 1 "Text" GuideID (col 0), ItemID (col 6) The data that shows in the Fish Guide is different from what appears on the tooltip
prime-loc Primary Fishing Spot FishParameter 9 "FishingSpot" GuideID (col 0), ItemID (col 6) Maps to sheet "FishingSpot" (col 0 "index" > col 19 "PlaceName") to sheet "PlaceName" (col 0 "index" > text col 1 "Name")
other-loc All other fishing spots; delimited-list FishingSpot 0 "#/Index" ItemID (col 4-13; reverse lookup) This could maybe load a list from Fishing Spot and just be "all-locs"; otherwise see above for name matching
gathering Gathering Requirement
time-start Start of window Please use 24hr time so we can use Template:Format time
time-end End of window Please use 24hr time so we can use Template:Format time
weather-previous Previous weather condition - delimited list
weather-current Current weather condition - delimited list
intuition Fisher's Intuition - [delimited list of "# fish name"]
intuition-message Message given when Fisher's Intuition (and thus this fish) available Derived from FishingSpot (columns 1-3) Columns 1-3 "BigFishOnReach/BigFishOnEnd/BigFishOnRefresh" SpotID index 0 This maps uniquely to the intuition fish for this FishingSpot; however there are not indicators for what the intuition fish are from FishParameter or FishingSpot
bite Bite Strength† - !/!!/!!!
lure-action Patience Hookset/Powerful Hookset or Modest Lure/Ambitious Lure (weak, strong)
lure-message Modest Lure/Ambitious Lure + Required Lure Message FishParameter 2/3/4 (three messages) GuideID (col 0), ItemID (col 6) This are the messages for "the fish becomes available"; "the fish is not caught"; "the fish is caught"
preferred-bait Preferred Bait† - if mooch, list the mooch fish and the prereqs for that mooch fish
allowed-bait Other Allowed Bait
legendary-type Fishing Rarity - Normal (default), Big Fish, Legendary Fish, Fabled Legendary Fish FishParameter derived from 13 "IsHidden" & 11 "Ocean Stars" & Patch GuideID (col 0), ItemID (col 6) Derived values:
  • IsHidden=False :: Normal
  • IsHidden=True & OceanStars = 5 :: Fabled Legendary Fish
  • IsHidden=True & OceanStars = {1, 2, 3, 4} :: [Normal]
  • IsHidden=True & Ocean Stars = 0 & Patch = x.55 :: Legendary Fish
  • IsHidden=True & Ocean Stars = 0 & Patch = {x.1, x.2, x.3, x.4, x.5} :: Big Fish
habitat Fishing Type - Freshwater, Saltwater, Sand, Sky, Clouds, Magma, Aetherochemical,
Salt Lake, Space, Spearfishing, Ocean Fishing, Spectral Ocean Fishing		 Derived from FishingSpot Category (col 23)
is-moochable Is Mooch Bait flag (might have better name for this; can ask fishing community)
gives-intuition Gives Intuition flag (for getting Fisher's Intuition)
is-collectable Collectable flag (y/n) FishingNoteInfo 7 "IsCollectable" GuideID (col 5), ItemID (col 1) 0=n, 1=y
collectability Collectability score
scrip-value <-- not sure if we want this here or if this can be put on the Collectable Appraiser page instead
ocean-fishing-stars Star value for ocean vishing score FishParameter 11 "OceanStars" GuideID (col 0), ItemID (col 6) 0=null (non-ocean voyage fish); 1=*, 2=**, 3=***, 4=****, 5=***** (ocean voyage fish)
ocean-fishing-points Point value for ocean vishing score
is-spectral Is a fish that can trigger Spectral Currents for Ocean Fishing
req-snagging Snagging Required flag
req-intuition Is Intuition Fish (might have better name for this)
req-tome Requires a Tome of Ichthyological Folklore FishParameter 10 "GatheringSubCategory" GuideID (col 0), ItemID (col 6) Maps to sheet "GatheringSubCategory" (col 0 "index" > text col 1 "FolkloreBook")
req-other Fish that require a specific quest or rod ("quest:QUESTNAME" or "rod:FISHINGROD")
length Size: min-max
fishing-level Fishing Level Range is derived from FishingSpot level
canvas-size Canvas Size (S, M, L, XL) FishingNoteInfo 2 "Size" GuideID (col 0), ItemID (col 1) 1=S, 2=M, 3=L, 4=XL (only for aquarium fish)
AquariumFish 4 "Size" GuideID (col 0), ItemID (col 1) 1=S, 2=M, 3=L, 4=XL (only for aquarium fish)
aquarium-water Aquarium Water Type (none, freshwater, saltwater) FishingNoteInfo 3 "AquariumWater" GuideID (col 0), ItemID (col 1) 0=none, 1=freshwater, 2=saltwater
AquariumFish 3 "AquariumWater" GuideID (col 0), ItemID (col 1) 1=freshwater, 2=saltwater
aquarium-image Image file for fish in aquarium
print-image Image file for fish prints on canvas
weather-restriction Fish Guide "Weather Restriction" - y/n FishingNoteInfo 3 "WeatherRestriction" GuideID (col 3), ItemID (col 1) 0=n, 1=y
time-restriction Fish Guide "Time Restriction" y/n FishingNoteInfo 4 "TimeRestriction GuideID (col 4), ItemID (col 1) 0=n, 1=y
special-conditions Fish Guide "Special Conditions" y/n FishingNoteInfo 5 "Special Condition GuideID (col 5), ItemID (col 1) 0=n, 1=y
spearfish-size Icon Size - small/medium/large n/a - spearfishing only (listed to save spot on template)
spearfish-speed Swim Speed - slow/average/fast/very fast (might be better terms; check FruitySnacks guides) n/a - spearfishing only (listed to save spot on template)
eph-node-spawned If this fish is used to spawn an ephemeral node, list it; else null n/a - spearfishing only (listed to save spot on template)
video-link FruitySnacks video guide link (Carby has this)
id-cp ?? Look into links for CarbunclePlushy - I don't think we can do this

Fish info data (for spearfishing)

Parameter Data Data Sheet Data Column Index ID and Col Notes
guide-index index in Fish Guide (also used to map ItemID to GuideID)" SpearfishingItem 0 "#"/index ItemID (col 2) This is for spearfishing fishing (values 20,000 and greater)
guide-description fish guide description SpearfishingItem 1 "Description" GuideID (col 0), ItemID (col 2) The data that shows in the Fish Guide is different from what appears on the tooltip
prime-loc Primary Fishing Spot SpearfishingItem 5 "TerritoryType" GuideID (col 0), ItemID (col 2) Maps to sheet "Spearfishing Notebook" (col 0 "index" > col 3 "PlaceName") to sheet "PlaceName" (col 0 "index" > text col 1 "Name")
gathering Gathering Requirement
intuition Fisher's Intuition - [delimited list of "# fish name"]
habitat Fishing Type - Spearfishing This is always Spearfishing
gives-intuition Gives Intuition flag (for getting Fisher's Intuition)
is-collectable Collectable flag (y/n)
collectability Collectability score
scrip-value <-- not sure if we want this here or if this can be put on the Collectable Appraiser page instead
req-intuition Is Intuition Fish (might have better name for this)
req-tome Requires a Tome of Ichthyological Folklore
req-other Fish that require a specific quest or rod ("quest:QUESTNAME" or "rod:FISHINGROD")
length Size - min-max
fishing-level Fishing Level Range is derived from SpearfishingNotebook level
canvas-size Canvas Size (S, M, L, XL) AquariumFish 4 "Size" GuideID (col 0), ItemID (col 1) 1=S, 2=M, 3=L, 4=XL (only for aquarium fish)
aquarium-water Aquarium Water Type (none, freshwater, saltwater) AquariumFish 3 "AquariumWater" GuideID (col 0), ItemID (col 1) 1=freshwater, 2=saltwater
aquarium-image Image file for fish in aquarium
spearfish-size Icon Size - small/medium/large
spearfish-speed Swim Speed - slow/average/fast/very fast (might be better terms; check FruitySnacks guides)
eph-node-spawned If this fish is used to spawn an ephemeral node, list it; else null
video-link FruitySnacks video guide link (Carby has this)
id-cp ?? Look into links for CarbunclePlushy - I don't think we can do this

Other data

Covered by Desynthesis Results project

Parameter Data
desynth-results Desynth

Fish categories to set

  • [expansion] Fish
  • [expansion] Big Fish / Big Fish
  • [expansion] Legendary Fish / Legendary Fish
  • Fabled Legendary Fish
  • Collectable Fish (?)
  • Custom Delivery Fish (?)

Fishing Spot data

Non-spearfishing information

Infobox data

Parameter Data Data Sheet Data Column Index ID and Col Notes
type Fishing Type - Freshwater, Saltwater, Sand, Sky, Clouds, Magma, Aetherochemical,
Salt Lake, Space, Ocean Fishing, Spectral Ocean Fishing		 FishingSpot 23 "FishingSpotCategory" Need to map out the category numbers to text
level level of the fishing spot FishingSpot 22 "GatheringLevel" col 0 "#"/index
location zone of the fishing spot Probably mapped through Territory Type??
location-x x-coordinate
location-y y-coordinate
fishing-log-index FishingSpot 19 "Order" & 15 "PlaceName" patch col 0 "#"/index Derived value (semi-manual)
  • If added in x.0 patch :: Use "Order" value
  • If PlaceName = 3443 :: Use "Order Value" + 10,000 (these are Ocean Fishing Voyages)
  • If added in non-x.0 patch and PlaceName = 0 :: Manually Generate value after 70,000
  • We have not had an normal overworld Fishing Spot added outside of an x.0 patch since 3.0, and there are few enough of these that we could just do these all manually. Will be helpful to auto-generate Ocean Fishing IDs though.
fishing-spot-id FishingSpot 0 #/"index" Mapped on col 18 "PlaceName"

Note: Additional information for generating the fishing-log-index (and notes for finding fishing-spot-id) are hidden in HTML comments in Template:Fishing log infobox/doc

Fish List

Parameter Data Data Sheet Data Column Index ID and Col Notes
fish-list un-ordered list of fish (actually in order) FishingSpot columns col 4-13 col 0 "#"/index Need to map to "Item" sheet to get name

Spearfishing information

Infobox data

Parameter Data Data Sheet Data Column Index ID and Col Notes
type Fishing Type - Spearfishing, Spearfishing (Swimming Shadow) SpearfishingNotebook 12 "IsShadowNode" col 0 "#"/index Derived value:
  • If IsShadowNode = false :: Spearfishing
  • If IsShawoNode = true :: Spearfishing (Swimming Shadow)
level level of the fishing spot SpearfishingNotebook 9 "GatheringLevel" col 0 "#"/index
location zone of the fishing spot
location-x x-coordinate
location-y y-coordinate
fishing-log-index Manually generated to match game's sort order (range 30,000-39,999)
fishing-spot-id SpearfishingNotebook 0 #/"index" Mapped on col 3 "PlaceName"

Note: Additional information for generating the fishing-log-index (and notes for finding fishing-spot-id) are hidden in HTML comments in Template:Fishing log infobox/doc

Fish List

I think we need to query these from the fish pages; SpearfishingNotebook sheet doesn't have any fish list information.


Retrieved from "https://ffxiv.consolegameswiki.com/mediawiki/index.php?title=User:OnyxVindicator/sandbox/Fish_Template_Setup&oldid=1274201"