Template:Voyage/doc
Jump to navigation
Jump to search
Template:Voyage creates an infobox for Voyage pages.
Uses templates
In addition to the code found here, this template relies on the following templates:
{{infobox voyage}}— The infobox.{{filter voyage}}— Filters valid shorthand for Voyage types into the desired, capitalized display names.{{filter shop}}— Filters valid shorthand for shop names into the desired, capitalized display names.{{filter company}}— Filters valid shorthand for Trading Company names into the desired, capitalized display names.
Parameters
Basic Information
| Parameter | Parameter Type | Default Value | Description | Example Value |
|---|---|---|---|---|
name |
string | {{PAGENAME}} |
The name of the Voyage as it appears in-game. Defaults to the page name. | A Captain's Treasure Map |
image |
file | {{PAGENAMEE}}.png |
The image displayed with the Voyage in-game. Defaults to a .png file with the same name as the page. | A_Captain's_Treasure_Map.png |
type |
string | None | The Voyage's type or category. For a full list of possible values, see {{filter voyage}}. |
Buried Treasure |
shop |
string | None | The Shop you could buy this Voyage from. Note that as of Season Eleven Voyages are no longer purchased from Shops. For a full list of possible values, see {{filter shop}}. |
Gold Hoarders Shop |
description |
string | None | The description of the Voyage as it appears in-game. | Study a map to unearth three hidden treasure chests buried on a large island. |
length |
integer | None | The length of the Voyage as it appears in-game. This should be an integer between 1 and 5. | 3 |
sail-to |
boolean | yes | Whether or not you can sail to a Voyage once started. | yes |
dive-to |
boolean | yes | Whether or not you can dive to a Voyage once started. | yes |
company |
list of string (delimiter ,) |
None | The companies that offer the Voyage. If more than one company offers this Voyage, list them all, separated by commas (,). For a list of valid values, see {{filter company}}. |
|
location |
string | None | A specific location that the Voyage takes place at. This should be used only if the Voyage takes you to a specific Location (e.g. one specific Island, Siren Shrine, Fort, etc.). If the Voyage takes you to a subset of locations (e.g. Large Islands, Skeleton Forts), use destination instead. |
Devil's Ridge |
destination |
string | None | A generalized subset of locations where the Voyage can take palce at. This should be used only if the Voyage takes you to a subset of Locations (e.g. Large Islands, Skeleton Forts). If the Voyage takes you to one specific location, use location instead. |
Small Islands |
region |
string | None | The Region the Voyage takes place in. | The Shores of Plenty |
| ashen-voyage | boolean | no | Whether or not this Voyage is an Ashen voyage that takes place exclusively within the Devil's Roar. | yes |
Requirement Information
| Parameter | Parameter Type | Default Value | Description | Example Value |
|---|---|---|---|---|
hoarder-level |
integer | None | The level required in the Gold Hoarders Trading Company to start this Voyage. | 25 |
souls-level |
integer | None | The level required in the Order of Souls Trading Company to start this Voyage. | 25 |
merchant-level |
integer | None | The level required in the Merchant Alliance Trading Company to start this Voyage. | 25 |
hunter-level |
integer | None | The level required in The Hunter's Call Trading Company to start this Voyage. | 25 |
athena-level |
integer | None | The level required in the Athena's Fortune Trading Company to start this Voyage. | 25 |
reaper-level |
integer | None | The level required in the Reaper's Bones Trading Company to start this Voyage. | 25 |
hoarder-distinction |
integer | None | The distinction level required in the Gold Hoarders Trading Company to start this Voyage. | 1 |
souls-distinction |
integer | None | The distinction level required in the Order of Souls Trading Company to start this Voyage. | 1 |
merchant-distinction |
integer | None | The distinction level required in the Merchant Alliance Trading Company to start this Voyage. | 1 |
hunter-distinction |
integer | None | The distinction level required in The Hunter's Call Trading Company to start this Voyage. | 1 |
athena-distinction |
integer | None | The distinction level required in the Athena's Fortune Trading Company to start this Voyage. | 1 |
reaper-distinction |
integer | None | The distinction level required in the Reaper's Bones Trading Company to start this Voyage. | 1 |
legendary |
boolean | no | Whether or not you must be a Pirate Legend to start this Voyage | yes |
commendation |
list of string (delimiter ,) | None | The Commendations required to start this voyage. If there is more than one Commendation, list them all separated by commas (,). |
|
title |
list of string (delimiter ,) | None | The Titles required to start this Voyage. If there is more than one Title, list them all separated by commas (,). |
|
promo |
string | None | The Promotion required to start this Voyage. | Gold Picaroon |
Availability Information
| Parameter | Parameter Type | Default Value | Description | Example Value |
|---|---|---|---|---|
event |
list of string (delimiter ,) | None | The Event this Voyage was available during. If there was more than one Event, list them all separated by commas (,). |
|
start-date |
date (MONTH DAY, YEAR) | None | The start date of this Voyage's availability window if it was time-limited. | January 1, 2024 |
end-date |
date (MONTH DAY, YEAR) | None | The end date of this Voyage's availability window if it was time-limited. | January 2, 2024 |
| timelimited | boolean | no | Whether or not the Voyage was time-limited. | yes |
| removed | boolean | no | Whether or not the Voyage was removed from the game. | yes |
| unavailable | boolean | no | Whether or not the Voyage is currently unavailable, but has not been removed permanently. | yes |
| highseas-only | boolean | no | Whether or not this Voyage is exclusive to High Seas. | yes |
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.