Template:Ship entry/doc

From YPPedia
Revision as of 10:10, 4 March 2018 by Jlh0605 (talk | contribs) (Parameters: Grammar)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a usage of the Template:Ship entry.

Usage

These usage notes will not be included in articles bearing this template.

This template is one of three templates that, combined, are used to help describe a scene on a ship. In addition to making the layout of the scene descriptions uniform, this template is used in finding paths to the images, and it also creates in-page anchor links to the particular scenes. An example usage of this template is:

{{Ship entry
|name=Crow's Nest
|type=Sloop
|paint=**Railing: 2 units
}}

For a good example of this template in use, see Bardic class sloop.

Note: This template is not meant to be used alone. It is meant to be used in conjunction with the Template:Ship table and Template:Ship end templates. The "Rooms and furnishings" section of a ship page should have, in this order: A short description of the scenes (and, if desired, their paint configurations), the Template:Ship table template, one Template:Ship entry template per scene, and the Template:Ship end template.

Parameters

Note: Unlike most templates, the parameters used as input parameters here must be named. Any parameter not specifically named is ignored, which can cause the template to break. The parameters, if present, will appear in the following order in the table.

  • name= Required. The name of the scene. This can be easily determined by using the /who command while a pirate is standing in the scene in the vessel.
  • type= Required. The name of the ship. This should almost always be the name of the article in question. If so, the value of this parameter can be substituted with {{PAGENAME}}.
  • plans= Optional. Defaults to no. Should only be yes or no, as other values will cause template errors. If present and set to yes, this will show the content of the plan1 parameter inside a show/hide box (with the title Floor plan) beneath the scene image.
  • plan1= Optional. If present, this parameter should contain only a floorplan template (e.g. Template:Floorplan1x2), and, optionally, a link to the scene XML (e.g. *{{Xml|Sloop-CrowsNest}}).
  • paint= Optional. Defaults to **This scene cannot be painted. If present, this should list all paintable areas of a scene and how much paint they use. Each paintable area after the first should be listed on its own separate line, they should be listed in the same order they appear in-game, and they should all should start with **. If there are no paintable areas in the scene, this parameter can be safely omitted.
  • spec_items= Optional. Defaults to no. Should only be yes, no, or unknown, as other values will cause template errors. A "Special item" is defined as an item in the scene that both cannot be removed, and can be interacted with. The most common examples are duty stations, the hold, the navigation table, and the booty chest. This parameter represents whether or not the scene has at least one special item (if known). If the scene does have special items, but there is not time to list them yet, set this parameter to unknown.
  • items= Optional. If present, this parameter should contain a list of all of the special items in the scene. Each special item after the first should be listed on its own separate line, and they should all start with **. If there is more than one of a particular special item present in a scene, the quantity should follow the item name (e.g. [[Bilging]] stations (x2)). If the item in question also has the same appearance as a known furniture item, that item can be linked to (e.g. **[[Yer known world]] ({{fl|g|Globe table}})). The items should be sorted alphabetically, and the text used should exactly match the hover text of the item in game (though the word 'duty' may be omitted from duty stations).
  • has_interactive_props= Optional. Defaults to unknown. Should only be yes, no, or unknown, as other values will cause template errors. An "Interactive prop" is defined as a prop that can be removed, but can also be interacted with. The most common examples are storage items and light-changing items. This parameter represents whether or not the scene has at least one interactive prop (if known). If the scene does have at least one interactive prop, but there is not time to list them yet, set this parameter to unknown.
  • interactive_props= Optional. If present, this parameter should contain a list of all of the interactive props in the scene. Each prop after the first should be listed on its own separate line, and they should all start with **. If there is more than one of a particular interactive prop item present in a scene, the quantity should follow the item name (e.g. **{{fl|c|Color wall lamp}} (x2)). Each item in this list should, whenever possible, link to the appropriate furniture page using the furniture list template. Any props that fit this category, but do not have a corresponding furniture item, should have a note (in the notes= parameter below) explaining what it does. The items should be sorted alphabetically, and the text should, when possible, match the name of the furniture item. When it is not possible to match the name of the furniture item, the text should exactly match the hover text of the item in game.
  • has_decorative_props= Optional. Defaults to unknown. Should only be yes, no, or unknown, as other values will cause template errors. A "Decorative prop" is defined as an item that can be removed and cannot be interacted with. This category also includes props that, while not interactive, cannot be removed, usually because it is a table with a tabletop special item on it. If this is the case, make a note of this in the notes= parameter below. This parameter represents whether or not the scene has at least one decorative prop (if known). If the scene does have at least one decorative prop, but there is not time to list them yet, set this parameter to unknown.
  • decorative_props1=, decorative_props2=, and decorative_props3= Optional. If present, these paramters should contain a list of all of the decorative props in the scene. Each prop after the first should be listed on its own separate line, and they should all start with *. (Please note that there is only one asterisk here instead of the two in most other parameters.) Each item in this list should, whenever possible, link to the appropriate furniture page using the furniture list template. Any props that fit this category, but do not have a corresponding furniture item, should have a note (in the notes= parameter below) explaining that the item is not available from furnishers, and where the name listed is taken from (usaully Yohoho Tools). The items in this list should be sorted alphabetically, with the first item alphabetically in the decorative_props1 parameter. If there are 1-5 props, put all of them in the decorative_props1 parameter. If there are 6-10 props, split them as evenly as possible between the decorative_props1 and decorative_props2 parameters (if there is an odd number, put the extra in the first parameter). If there are more than 10 props, split them as evenly as possible between all three of these parameters (and put the extras on decorative_props1 and decorative_props2, if needed). If the furniture item being linked to is functional, but the given prop is not, make a note of that in the notes= parameter below. Note that if the scene has at least one of its decorative props listed, it should have all of its decorative props listed.
  • props= Obsolete. This parameter was used previously, and is included to not break old pages. This parameter will eventually be removed, and should not be used on new pages.
  • props1= Obsolete. This parameter was used previously, and is included to not break old pages. This parameter will eventually be removed, and should not be used on new pages. This also applies to props2= and props3=.
  • notes= Optional. If present, this parameter should include a list of notes explaining any special details about the scene that don't fit nicely into one of the other parameters. Each note after the first should be listed on its own separate line, and they should all start with **.