Template:Infobox npc/doc
Jump to navigation
Jump to search
This template serializes NPCs into Cargo data, as well as displaying a customized infobox for NPCs.
Parameters
Cargo-Stored Values | ||||
---|---|---|---|---|
Parameter | Parameter Type | Accepted Values | Default Value | Notes |
name | String | Any | {{PAGENAME}} |
The name of the NPC if it differs from the page name. |
type | String | See Below | None | The general category the NPC fits into. See below for valid values. |
subtype | String | See Below | None | A more specific type for each NPC, which is displayed in the infobox as their Role. See below for a complete list of valid values. Note: What is displayed within the infobox as the NPC's role and what their input equals may vary, as the data is altered before display to provide a more concise version for Cargo. What appears in Cargo and what is displayed in the infobox are both listed below. |
status | String | See Below | Alive (See Notes) | A representation of the NPC's current status. Note that while the default is "Alive", whether or not any status parameter is supplied determines whether or not to render the infobox, so if it is important to indicate that the NPC is alive in the infobox, be sure to specify their status as alive .See below for a complete list of valid values. |
shop-type | List of Strings (Delimiter , ) |
See Below | None | The types of Shop the NPC represents. As some NPCs (Legendary Luke) represent multiple shop types, this is instead available as an array for those edge cases. See below for a complete list of valid values. |
company | List of Strings (Delimiter , ) |
See Below | None | The Trading Companies the NPC currently represents. This is provided as an array instead of a singular value as a matter of future-proofing and for edge-cases where an NPC represents multiple companies. See below for a complete list of valid values. |
affiliation | List of Strings (Delimiter , ) |
Any | None | The groups that the NPC is currently or has formerly been affiliated with, separated by commas. Note: Parsing for this section is planned as part of a future update, but for now the values are processed as they are received. As such, Cargo queries on this field may be unreliable. |
location | List of Strings (Delimiter , ) |
Any | None | The locations where the NPC has been or can be found, separated by commas. Note: Parsing for this section is planned as part of a future update, but for now the values are processed as they are received. As such, Cargo queries on this field may be unreliable. |
appearances | List of Strings (Delimiter , ) |
Any | None | A list of Adventures, Voyages, Tall Tales, Updates, or other appearances an NPC has made, separated by commas. Note: Parsing for this section is planned as part of a future update, but for now the values are processed as they are received. As such, Cargo queries on this field may be unreliable. |
offers-voyages | Boolean |
|
no | A flag that indicates whether or not an NPC offers Voyages. |
buys-treasure | Boolean |
|
no | A flag that indicates whether or not an NPC buys Treasure. |
cargo-run-target | Boolean |
|
no | A flag that indicates whether or not an NPC can either give or receive Cargo as part of a Cargo Run. |
appears-ingame | Boolean |
|
yes | A flag that indicates whether or not an NPC actually appears in-game, or is only mentioned/appears in alternative media. |
removed | Boolean |
|
no | A flag that indicates whether or not an NPC has been removed from the game entirely. |
Infobox-Only Values | ||||
---|---|---|---|---|
Parameter | Parameter Type | Accepted Values | Default Value | Notes |
image | Filename | Any | Infobox_npc/doc.png | In most cases this doesn't need to be specified, as a file with a filename identical to the page (if it is a .png) will be inserted automatically. If such a file does not actually exist however (e.g. your file is a .jpg or identified by another name for a variety of reasons), then this specification will override the original value. |
caption | String | Any | None | A caption for the image. In most cases, this should not be used. |
type-primary | String | Any | NPC | The text displayed in the "Type" section of the infobox. Defaults to "NPC" and does not need to be changed in most cases. |
creaturetype | String | Any | None | A specifier for the NPC's level of aggression, if any, which fills in the "Behaviour" section of the infobox. In most cases this should not be used as most NPCs have no combat involvement whatsoever, but for enemies or allies that fight and can be damaged by enemies this should be specified. |
actor | String | Any | None | The voice actor for the NPC. |
related | String | Any | None | A list of related articles for the NPC, if any. |
List of Valid Parameter Values
Type
Valid Types | ||
---|---|---|
Valid Inputs | Resulting Output | Intended Use |
|
Company Representative | NPCs who directly represent a Trading Company. |
|
Shopkeeper | NPCs who primarily operate an in-game Shop. |
|
Island NPC | NPCs who are found on uninhabited Islands, primarily as Cargo Run Targets. |
|
Quest NPC | NPCs who are primarily involved in quests, such as Adventures, Voyages, or Tall Tales. |
|
Generic NPC | Generic NPCs who usually appear in numbers, such as Skeletons and Phantoms. |
|
Encounterable NPC | Unique NPCs who have no specific affiliations or typings, but appear in unique encounters. This includes generic bosses such as The Duchess or the various Ashen Lords. |
Subtype
Valid Subtypes | |||
---|---|---|---|
Valid Inputs | Resulting Output (Cargo) | Resulting Output (Infobox) | Intended Use |
|
Hoarder | Gold Hoarders Representative | Gold Hoarders representatives stationed at each Outpost, not including the Gold Hoarder himself. |
|
Madame | Order of Souls Representative | Order of Souls representatives stationed at each Outpost. |
|
Senior Trader | Merchant Alliance Representative | Merchant Alliance representatives stationed at each Outpost, including Chief Trader Mollie. Does not include Seapost Traders. |
|
Hunter | The Hunter's Call Representative | The Hunter's Call representatives stationed at each Seapost. |
|
Athena's Fortune Representative | Athena's Fortune Representative | Characters who directly represent Athena's Fortune. Does not include the Shopkeepers in the Athena's Fortune Hideout. |
|
Sovereign | Sovereign Representative | The Sovereign representative stationed at each Outpost. |
|
Bilge Rats Representative | Bilge Rats Representative | The Bilge Rats representative stationed at each Outpost. |
|
Reaper's Bones Representative | Reaper's Bones Representative | Characters which represent the Reaper's Bones Trading Company. Since The Servant of the Flame was the only NPC who fit this criteria at the time this template was created, their name was also used here. |
|
Sea Dogs Representative | Sea Dogs Representative. | NPCs which represent the Sea Dogs Trading Company. |
|
Tavernkeep | Tavernkeep | The Tavernkeeper NPC stationed in every Tavern. |
|
Toolsmith | Toolsmith | NPCs who run the Equipment Shops at every Outpost. |
|
Clothier | Clothier | NPCs who run the General Clothing Shops at every Outpost. |
|
Weaponsmith | Weaponsmith | NPCs who run the Weaponsmith's Shops at every Outpost. |
|
Shipwright | Shipwright | NPCs who run the Shipwright Shops at every Outpost. |
|
Emporium Shopkeeper | Emporium Shopkeeper | NPCs who run the Pirate Emporium shops at every Outpost. |
|
Athena's Fortune Shopkeeper | Athena's Fortune Shopkeeper | Shopkeepers who are a part of Athena's Fortune. Since Legendary Luke was the only individual who fit this criteria at the time this template was created, his name was used here. |
|
Seapost Trader | Seapost Trader | The NPCs who trade various goods at Seaposts. |
|
Chronicler of Legends | Chronicler of Legends | Unique designation for Umbra. |
|
Cargo Dealer | Cargo Dealer | Various Island NPCs who act as both a source and a target for Cargo Runs. |
|
Miscellaneous | {{{custom-role}}}
|
NPCs that do not belong to any other subtype. When this is the identified subtype of the NPC, they are assigned "Miscellaneous" in the database, but what is printed as their role is identified by the custom-role parameter (blank by default), where it is inserted without any special formatting or parsing. If you want your subtype to appear in the database you can specify it directly with the subtype parameter as long as it does not match (case insensitive) any other valid subtype input, but it is likely better to update the template itself so that it can parse your subtype and role printout as intended.
|
|
Quest Giver | Quest Giver | NPCs whose primary role is to offer quests. This does not include Trading Company representatives who offer Voyages. Since there is no single page specifically for characters who offer quests, this role does not print as a link. |
|
Quest Character | Quest Character | NPCs who primarily appear as part of quests, including Adventures, Tall Tales, and Voyages. Since there is no single page specifically for characters who are primarily a part of the many quest type events in Sea of Thieves, this page is not provided as a link. |
|
Enemy | Enemy | NPCs who primarily appear as generic enemies, such as Skeletons. For unique boss encounters, use boss instead.
|
|
Boss Enemy | Boss Enemy | NPCs who primarily appear as bosses outside of quests, such as The Duchess. For bosses in quests such as the Gold Hoarder, use quest npc instead.
|
Status
Valid Statuses | ||
---|---|---|
Valid Inputs | Corresponding Output | Notes |
alive |
Alive | This is the default value when reported to the Cargo database. Unless it is important that this NPC is acknowledged as alive in the infobox, leave this blank, as it will still provide their status in the database without showing it in their infobox. |
unknown |
Unknown | Differs from Missing. Use for when neither the NPC's whereabouts or status are known. |
missing |
Missing | Differs from unknown. Use for when the NPC's whereabouts are unknown, but that they are indeed alive. |
vanquished |
Vanquished | Differs from dead. Use for when NPC's have been temporarily killed/destroyed and are not present in the Sea of Thieves, but their soul still exists in some way/shape/form (either in the Sea of the Damned or elsewhere). |
dead |
Dead | Use for NPCs that are permanently dead, like DeMarco or 'Fetcher' Farley. |
Shop Type
Note: More than one shop type can be defined for NPCs who cover more than one category. To do so, separate each shop type with a comma (,) in your definition.
Valid Shop Types | |
---|---|
Valid Inputs | Corresponding Output |
|
Weaponsmith |
|
Toolsmith |
|
Clothing |
|
Shipwright |
|
Tavernkeep |
|
Pirate Emporium |
|
Athena's Fortune Shopkeeper |
|
Seapost Trader |
|
Black Market |
Company
Note: This section has yet to be completed.
Valid Companies | ||
---|---|---|
Valid Inputs | Corresponding Output | Notes |