×
Create a new article
Write your page title here:
We currently have 2,844 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



    YumeWiki
    2,844Articles

    Template:Locationbox: Difference between revisions

    m (original -> japanese)
    (BGM now removes commas without adding linebreaks, now that Template:BGM adds a break)
     
    Line 42: Line 42:
    }}
    }}
    | '''BGM'''
    | '''BGM'''
    |{{#if: {{{BGM|}}} | {{TextSpace|{{{BGM}}}}} | [https://yume.wiki/{{NAMESPACEE}}:{{PAGENAMEE}}/edit ''Missing''] }}
    |{{#if: {{{BGM|}}} | {{#arraymap:{{{BGM}}}|,|item|item|}} | [https://yume.wiki/{{NAMESPACEE}}:{{PAGENAMEE}}/edit ''Missing''] }}
    |-
    |-
    | '''Map ID'''
    | '''Map ID'''

    Latest revision as of 02:38, 26 July 2024

    Locationbox
    Missing image data.png
    Basic Info
    Effects EffectNone
    Events None
    Notable NPCs None
    Other
    Connecting Areas

    {{{Connections}}}

    BGM Missing
    Map ID Missing



    Documentation (for the above template, sometimes hidden or invisible)

    Displays an infobox containing a world's details.

    Template parameters

    This template has custom formatting.

    ParameterDescriptionTypeStatus
    Header colorheadercolor

    The header's background color.

    Default
    #3366CC
    Stringsuggested
    Header font colorheaderfontcolor

    The header's text color.

    Default
    #ffffff
    Stringsuggested
    Location imageimage

    The file name for the image to be displayed. It should properly represent the location.

    Example
    Azure_garden.png
    Filerequired
    Original Name(s)Name

    The area's original native-language names, along with any translations thereof, separated by commas. If the original name is Japanese and you specified it for "JapaneseName", do not repeat it here.

    Example
    ''Tobirabeya'', Door Room
    Stringsuggested
    Japanese NameJapaneseName

    The area's original name in Japanese, if applicable. Only one value is accepted.

    Example
    扉部屋
    Stringoptional
    EffectsEffects

    Effects (or the game's equivalent) obtainable in this location.

    Example
    Chainsaw
    Stringrequired
    CollectiblesCollectibles Wallpapers Menu

    Collectibles that you can find in this location.

    Example
    WP #87, Kura Puzzle #45
    Stringrequired
    EventsEvents

    Events that you can encounter in this location.

    Stringrequired
    Notable NPCsNPCS

    Noteworthy NPCs that show up in this location.

    Stringrequired
    Connecting AreasConnections

    List of areas connected to this location (using the Connection template) as of the game's current version.

    Example
    {{Connection|Dream Pool|one_way_type=NoEntry}}
    Stringrequired
    BGMBGM

    List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.

    Example
    {{BGM|title=soto_C5|filename=Soto-C5.ogg|label=Glasses Path}}
    Stringrequired
    Map IDMap ID

    List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits. Annotations may be added to each map ID using parentheses.

    Example
    0002, 0003 (Sub-area)
    Stringrequired
    Version AddedVersionAdded

    The version in which the area was first added.

    Example
    0.114
    Stringrequired
    Versions UpdatedVersionsUpdated

    The version(s) in which the area has been updated. This should not include VersionAdded, VersionRemoved, or any removed versions in VersionGaps. 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
    Stringsuggested
    Primary AuthorPrimary

    The location's main author(s). Applicable to collaborative games.

    Stringsuggested
    Contributing AuthorsContributing

    Authors who have contributed to the location. Applicable to collaborative games.

    Stringoptional
    Display Namename

    Overrides using the page name as the header text. If the name of the location should be changed on the wiki, move the page instead of using this parameter.

    Auto value
    {{PAGENAME}}
    Stringoptional
    Header font sizeheaderfontsize

    The header's font size as a percentage.

    Default
    200%
    Stringoptional
    Image widthimagewidth

    The image width in px.

    Default
    250
    Numberoptional
    Image captioncaption

    A corresponding caption for the image, visible if a value is provided.

    Stringoptional
    MasksMasks

    Yume 2kki Masks available to equip in the location.

    Stringoptional
    Removed ConnectionsRemovedConnections

    List of areas connected to this location (using the Connection template) that have since been removed. Be sure to include "is_removed=true" in each connection.

    Example
    {{Connection|Digital Forest|is_removed=true}}
    Stringoptional
    Map TypeMap Type

    Descriptors for a given location, such as the overall map size and whether it loops or otherwise.

    Example
    Small, Non-looping
    Stringoptional
    Version RemovedVersionRemoved

    The version in which the area was removed, if applicable.

    Example
    0.115a
    Stringoptional
    Version GapsVersionGaps

    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
    Stringoptional

    Semantic properties

    This template exposes the following semantic properties.

    Property name Description Data type Cardinality
    Has location image filename The location image's filename. Page Single
    Header font color The color of the locationbox's header text. Used for location-based styling. String Single
    Header background color The color of the locationbox's header background. Used for location-based styling. String Single
    Has location image The path pointing to the location image. Used for external applications to refer to the image. String Single
    Japanese name The area's Japanese (or generally, native-language) name. Used for localization purposes. String Single
    Version added The version where the location was added. Primarily used with the Yume 2kki Explorer. String Single
    Versions updated The version(s) where the location was updated. Primarily used with the Yume 2kki Explorer. String Multiple
    Version removed The version where the location was removed. Primarily used with the Yume 2kki Explorer. String Single
    Version gaps The versions where the location was absent prior to its return. Primarily used with the Yume 2kki Explorer. String Multiple
    Has map type The properties describing a map's nature. String Multiple
    Has primary author The person(s) who created the location; this is applicable to collaborative fangame projects. String Multiple
    Has contributing author The person(s) contributing to the the development of the location; this is applicable to collaborative fangame projects. String Multiple

    General usage

    {{Locationbox
    |name = Volcanic Subterrain
    |headercolor = #4a0400
    |headerfontcolor = #ffa500
    |image = volcanic_subterrain.png
    |JapaneseName = 鍛冶場
    |Name = ''Kajiba'', Foundry
    |Effects = None
    |Wallpapers = None
    |Events = None
    |NPCS = None
    |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}}
    |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}}
    |Map ID = 1023
    |Primary = Ruri
    |Contributing = qxy
    |VersionAdded = 0.109h patch 4
    |VersionRemoved = 0.112i
    }}
    

    will return:

    Volcanic Subterrain
    Volcanic subterrain.png
    Basic Info
    Japanese Name(s)

    鍛冶場
    Kajiba
    Foundry

    Effects EffectNone
    Events None
    Notable NPCs None
    Other
    Connecting Areas

    Chemical Research Facility

    BGM bgm-e (after lighting the foundry)
    Map ID 1023
    Version Added 0.109h patch 4
    Version Removed 0.112i
    Primary Author Ruri
    Contributing Author(s) qxy




    Visit Template:Locationbox/doc to edit this text! (How does this work?)