Template:Locationbox/doc

Displays a location box, which contains a world's details.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
headercolor	headercolor	The color of the header of the location box. Default #3366cc	String	suggested
headerfontcolor	headerfontcolor	The color of the text for the header of the location box. Default #ffffff	String	optional
Name	Name	The area's original Japanese (or generally, native, assuming a fangame's language is not English) names, along with any translations thereof, separated by commas. Example 扉部屋, ''Tobirabeya'', Door Room	String	optional
image	image	The file name for the image to be displayed by the location box.	File	optional
caption	caption	The corresponding caption for the image, visible if a value is provided.	String	optional
JapaneseName	JapaneseName	The area's Japanese name. Example 扉部屋	String	optional
VersionAdded	VersionAdded	The version where the area has been added. Default x.x Example 0.114	String	optional
VersionRemoved	VersionRemoved	The version where the area has been removed. Example 0.115a	String	optional
VersionsUpdated	VersionsUpdated	The version(s) where the area has been updated. This should not include version added, version removed, or version removed in any version gaps. Use commas to separate multiple instances. Versions may also be followed by a dash and a 1 or 2 character code; this is an update type identifier used by Yume 2kki Explorer, and these are automatically handled by the version manager in the app. Example 0.112,0.112 patch 1,0.112d	String	optional
VersionGaps	VersionGaps	Any gaps where the area was removed only to later be re-added, starting with the version it was removed, followed by a dash, followed by the version it was re-added in. Use commas to separate multiple instances. Example 0.110b-0.110b patch 1,0.111-0.113a	String	optional
Effects	Effects	Effects obtainable in the current location. Example Chainsaw	String	optional
Wallpapers	Wallpapers	Collectibles that you can find in the current location. Example WP #87, Kura Puzzle #45	String	optional
Events	Events	Events that you can encounter.	String	optional
Map Type	Map Type	Descriptors for a given location, such as the overall map size and whether it loops or otherwise. Example Small, Non-looping	String	optional
NPCS	NPCS	Notable NPCs that show up in the current location.	String	optional
Connections	Connections	Locations accessible from the location at present.	String	optional
RemovedConnections	RemovedConnections	Locations that have been removed from recent versions, connected to the present area.	String	optional
BGM	BGM	Soundtrack that plays in the current location.	String	optional
Map ID	Map ID	The IDs corresponding to the location's map, as well as any existing sub-areas. Zero-padded, with four digits. Example 0002	String	optional
Primary	Primary	The location's main author.	String	optional
Contributing	Contributing	Authors who have added to the location, visible if a value is provided.	String	optional

General usage


 {{Locationbox
 |headercolor = #4a0400
 |headerfontcolor = #ffa500
 |image = volcanic_subterrain.png
 |Effects = None
 |Wallpapers = None
 |Events = None
 |NPCS = None
 |Connections = [[Yume 2kki:Chemical Research Facility|Chemical Research Facility]] {{OneWay|NoEntry}}
 |BGM = bgm-e (after lighting the foundry)
 |Map ID = 1023
 |Primary = Ruri
 |Contributing = qxy
 }}


will return

Locationbox/doc
Basic Info
Effects	EffectNone
Events	None
Notable NPCs	None
Other
Connecting Areas	Chemical Research Facility NoEntry⛔
BGM	bgm-e (after lighting the foundry)
Map ID	1023
Primary Author	Ruri
Contributing Author(s)	qxy