Template:Place Summary/Doc
From Starfield Wiki
Summary[edit]
This template provides a uniform look for all in-game location pages other than astral bodies (use {{System Infobox}} or {{Planet Infobox}}, and should be used at the top of the pages for any cities, houses, starstations, random POIs, etc. It automatically fills in the breadcrumb trails, primary image, and primary description. The description is also made available for other templates, such as Place Link.
Parameters[edit]
Parameters marked as being "autolinked" can be provided either as links or plain text and will convert plain text to links.
Parameter | Scope | Description |
---|---|---|
type | required | See Place Types for details. Used in infobox title and trail. |
description | required | A description of the location. |
mod | optional | Name of mod that adds the location (if not in baseline version of game). |
image | required | The name of an image file for this place (without "File:" or [[brackets]]). If this parameter is missing, a NeedsImage banner will automatically be added to the quest article. In cases where an image is truly never needed, set image to "none". |
imgdesc | optional | Description of image. Optional, but should usually be provided with image .
|
addabove addbelow |
optional | Any text to be added above or below the description. A space is automatically added after addabove and before addbelow . This should generally only be used for descriptive text and should not contain tables or images that would be better placed outside the template call.
|
is/are | optional | Define as anything to change from Place is <description> to Place are <description> .
|
titlename | optional | Name of place, used in infobox title and description sentence. Defaults to LABELNAME. |
defaultsort | optional | Sets a new DEFAULTSORT. Defaults to titlename. This parameter is only used with titlename, to handle cases of "The ..." or "A ..." where we don't want it to sort that way. When not using titlename, use {{DEFAULTSORT:...}} as usual at the top of the page.
|
random | optional | If yes, indicates that this location is randomly placed and is not on any set planet. |
mapname | optional | Name of location on the Oblivion/SI/Morrowind Map. Defaults to LABELNAME - set to "none" to omit this field. |
mapbase | optional | Namespace of game map to use if not the current namespace. Used for cases like Last Vigil and A Strange Door. |
mapx | optional | If mapname cannot be used for some reason, the location of a place can be specified using mapx and mapy. These are coordinates taken directly from the relevant map. |
mapy | optional | See mapx. |
lorepage | optional | Name (or full link) to a Lore page with more information on the location. |
zones | optional | Number of zones at location. |
job1 … job5 |
optional | List of people with functions at the location. |
jobtitle1 … jobtitle5 |
optional | Corresponding headings to use for job parameters. Defaults to "Publican" for Inns, "Guildmaster" for Guild Halls, "Master" for Telvanni Towers, and "Proprietor" for anything else.
|
prop | deprecated | Identical to job1 .
|
propname | deprecated | Identical to jobtitle1 parameters. jobtitle is preferred over propname .
|
occupants | optional | Type of occupants. |
treasure | optional | Listing of important treasures. |
transtype | optional | Transportation type for destinations header. |
dest1 dest2 dest3 dest4 |
optional | Fast-travel destinations from this location. |
locationcode | optional | Console location code. Defaults to "Unknown" - set to "none" to omit this field. |
planetheader | optional | Header to use with planet . Defaults to "Planet".
|
planet | optional | Name of the planet in which the place can be found. Autolinked. |
planetnote | optional | Adds a note after the planet text. |
location , city , or town . (Prioritized in that order if more than one is specified.)
| ||
city | optional | Name of the city in which the place can be found. Autolinked. |
town | optional | Name of town in which the place can be found. Unlike city, is not categorized. Autolinked. |
location | optional | Where this place is located. |
coords | optional | Coordinates of place (only if city or region is provided). |
notrail | optional | Specify any value to omit trail at top-left of screen. Defaults to omitted on User and Template pages. |
nocat | optional | Specify any value to omit categories. |
marker_icon | optional | Name of icon used for this place on the map. Icon will be added to the title of the infobox. |
roomcost | optional | Cost to rent a room. |
clearable | optional | Is this place clearable? If missing/empty, nothing is displayed; otherwise "Yes" is displayed (and it's added to the clearable category). |
dungeon | optional | Is this place classified as a dungeon? If missing/empty, nothing is displayed; otherwise "Yes" is displayed. |
respawn | optional | Respawn time for location. Most commonly used to set value to never . If entire respawn section should be skipped, set it to skip . Otherwise, default text is displayed, dependent upon whether or not location is clearable.
|
marker_id | optional | Name of marker used on the world map (e.g., 'Farm'). Auto-converted into the correct value of marker_icon. |
avail | optional | When the location is available. |
Place Types[edit]
Type | Description | Examples |
---|---|---|
Government Office | An office for a governmental agency | An embassy, a police station. |
District | A subsection of a city or other larger area. | The Well, Ebbside |
Tower | A tower with multiple places in it | Trade Tower, Ryujin Tower, MAST Tower |
Bar | A shop which sells primarily alcohol. | Astral Lounge, Lizzy's |
Restaurant | A shop which sells primarily food or non-alcoholic drinks. This may include a seating area. | CHUNKS, TerraBrew |
Shop | General purpose store | Clint's |
Service | A shop which provides some service, such as medical or ship repair. | Enchance!, Reliant Medical, Ship Services Technician |
Religious | A temple, church, or other religious facility. | |
Business | A place that does business but does not sell anything | Corporate HQs, refinement facilities. |
Residence | A place where somebody, or multiple people, live. | |
Hotel | A place where you can pay to rent a room |
This page uses material from the UESP article "Template:Place Infobox".