Editing Template:Places/doc

'''Parameters''':

* '''Description''': The location's description text (trim to 250 characters).
* '''Unlocked with''' (optional): The name of a quality/action which unlocks the location.
* '''Main Quality''' (optional): A quality strongly associated with the location.
* '''Outfit''' (optional): Adds an line about if you can change your outfit; by default it assumes that you can change this by setting it to no
* '''Market''' (recommended): 
** <code>no</code> if the Bazaar tab gives you the "The Bazaar is not accessible from this location" message, otherwise one of:
** <code>The Echo Bazaar!</code>
** <code>Upper River Exchange</code>
** <code>The Rat Market (Bazaar)</code>
** <code>Khaganian Markets</code>
**Other values are accepted, but will sort the place under [[:Category:Places with unknown market parameter]].
* '''Starting storylet''' (optional): A storylet that you have to interact with when entering the location.
* '''MainSetting''' (optional): Set to "yes" if this is one of the main areas of Fallen London that share the main deck (e.g. [[Ladybones Road]], [[The Shuttered Palace]] etc.). Do '''not''' set to "yes" if this is a special location with its own deck such as [[On a Heist]].  This will display extra information about the rules applying to these areas. 
* '''Guide''' (optional): Title of the Wiki [[Guides|Guide]] for the location, if one exists.
* '''Deck''' (optional): If set to "yes", displays the "Custom Deck" image and a "Deck" section is added to the page, summarising the properties of the deck and adds a "Deck" section controlled by the parameters below. If set to "no", displays the "No Deck" image at the top right of the page and, in general, does not create a "Deck" section unless "LeaveCardMultiplier" parameter is set to "yes". If unset neither the image nor the section will appear on the page. It is not recommended to set this to a value other than "yes" or "no" (or leaving it entirely unset).
** '''UnlimitedDraws''' (optional): Can only be displayed if '''Deck''' is set to yes. Set to yes if this is an area with a deck that never runs out of card (e.g. [[A Flash Lay]]). Set to anything else if this is an area with a deck that has a maximum size (e.g. the main deck in Fallen London). If unset no information about deck size will be displayed.
** '''LeaveCardMultiplier''' (optional): Displays different messages in the '''Deck''' section, depending on whether '''Deck''' is set to "yes" or "no":
*** If '''Deck''' is set to "yes" displays a message based on the parameter value:
**** "refill" - Displays the message "''When you leave this location to a location with a limited deck size your deck will start at its '''maximum capacity'''.''"
**** Any other non-empty string - Displays the message "''If you leave this location to another location with a limited deck size you will '''double''' the number of cards in your deck.''". 
*** If '''Deck''' is set to "no", the messages are different:
**** "refill" - ''"This location does not have a deck of its own but when you leave this location to a location with a limited deck size your deck will start at its '''maximum capacity'''."''
**** Any other non-empty string - displays the message "''This location does not have a deck of its own but if  you leave to another location with a limited deck size you will '''double''' the number of cards in your deck.''". The word "double" can be changed via this parameter.
** '''FixedHandSize''' (optional): Can only be displayed if '''Deck''' is set to yes. Set to yes if this is an area with a fixed hand of 3 cards. Set to anything else if this is an area where the hand size is determined by your Lodgings. If unset no information about hand size will be displayed.
** '''HandResets''' (optional): Can only be displayed if '''Deck''' is set to yes. Set to yes if this is an area which resets your hand after you leave. Set to anything else if this is an area where the cards in your hand persist after you leave. If unset no information about the cards in hand will be displayed.

<noinclude>[[Category:Template documentation]]</noinclude>
<templatedata>
{
	"params": {
		"Icon": {
			"description": "Image file, without File:, but with .png",
			"type": "line"
		},
		"Deck": {
			"description": "Create link to custom deck?",
			"example": "no",
			"type": "boolean",
			"default": "yes"
		},
		"Description": {
			"description": "The location's description text (trim to 250 characters)",
			"example": "A haunt of poets, prostitutes and other low types, and location of the notorious Singing Mandrake. Elderwick is famous for its booksellers. Hollow Street offers the best honey-dens in the city.",
			"type": "content",
			"required": true
		},
		"ID": {
			"description": "Numerical ID of the location",
			"type": "number",
			"suggested": true
		},
		"Guide": {
			"label": "Guide page",
			"description": "Link to guide on the wiki",
			"example": "[[The Rat Market (Guide)]]",
			"type": "line"
		},
		"Unlocked with": {
			"description": "Conditions needed to access the area",
			"example": "{{Unlock|Route: Mahogany Hall}}",
			"type": "string"
		},
		"Main Quality": {
			"description": " A quality strongly associated with the location.",
			"example": "{{IL|Shadowy}} 95+ '''and''' {{IL|Persuasive}} 95+",
			"type": "string",
			"suggested": true
		},
		"Outfit": {
			"label": "Outfit change enabled",
			"description": "Can you change your outfit while here?",
			"example": "no",
			"type": "boolean",
			"default": "yes"
		},
		"Market": {
			"description": "Which market is accessible from this location?",
			"example": "no/The Echo Bazaar!/Upper River Exchange",
			"type": "wiki-page-name",
			"suggested": true
		},
		"Music": {
			"label": "Music theme",
			"description": "Title of Fallen London OST soundtrack",
			"example": "Carnival at Midnight",
			"type": "line"
		},
		"Starting storylet": {
			"description": " A storylet that you have to interact with when entering the location.",
			"example": "[[Head to Doubt Street]]",
			"type": "line"
		},
		"MainSetting": {
			"description": " \"yes\" if this is one of the areas using the main London deck",
			"example": "yes",
			"type": "boolean",
			"deprecated": "Use Setting = The Fifth City instead."
		},
		"UnlimitedDraws": {
			"label": "Unlimited draws from deck",
			"description": "yes for area with a deck that never runs out of cards",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"DeckSize": {
			"example": "3 cards",
			"default": "6 cards (or 10 cards for [[An Episode for Exceptional Friends|Exceptional Friends]])",
			"description": "Deck Size, relevant only if UnlimitedDraws is no",
			"type": "string"
		},
		"FixedHandSize": {
			"label": "Fixed hand size 3",
			"description": "yes if the hand size here is always 3 regardless of Lodging",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"HandResets": {
			"label": "Hand resets on leave",
			"description": "yes if leaving the location and coming back resets the hand",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"Setting": {
			"description": "Separate with ; if multiple settings apply",
			"example": "Upper River; The Fifth City; Parabola, ...",
			"type": "wiki-page-name",
			"label": "Setting from the JSON of the network traffic"
		}
	},
	"description": "Location information.",
	"format": "block",
	"paramOrder": [
		"Icon",
		"Deck",
		"Description",
		"ID",
		"Guide",
		"Unlocked with",
		"Main Quality",
		"Outfit",
		"Market",
		"Music",
		"Starting storylet",
		"MainSetting",
		"Setting",
		"UnlimitedDraws",
		"DeckSize",
		"FixedHandSize",
		"HandResets"
	]
}
</templatedata>