Displays a location box, which contains a world's details.
Parameter | Description | Type | Status | |
---|---|---|---|---|
headercolor | headercolor | The color of the header of the location box.
| String | suggested |
headerfontcolor | headerfontcolor | The color of the text for the header of the location box.
| 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.
| 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.
| String | optional |
VersionAdded | VersionAdded | The version where the area has been added.
| String | optional |
VersionRemoved | VersionRemoved | The version where the area has been removed.
| 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.
| 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.
| String | optional |
Effects | Effects | Effects obtainable in the current location.
| String | optional |
Wallpapers | Wallpapers | Collectibles that you can find in the current location.
| 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.
| 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. | 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 | None |
Events | None |
Notable NPCs | None |
Other | |
Connecting Areas | Chemical Research Facility ⛔ |
BGM | bgm-e (after lighting the foundry) |
Map ID | 1023 |
Primary Author | Ruri |
Contributing Author(s) | qxy |