No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
-->{{#if: {{{title|}}}<!-- Check for title | -->{{#if: {{{title|}}}<!-- Check for title | ||
-->| {{#if: {{{filename|}}}<!-- Check for filename | -->| {{#if: {{{filename|}}}<!-- Check for filename | ||
-->| {{#set: Has BGM={{{title}}};{{filepath:{{{filename}}}}};File:{{{filename}}};{{{label|}}};{{{soundroom|}}} }}<!-- Create record | -->| {{#set: Has BGM={{{title}}};{{filepath:{{{filename}}}}};File:{{{filename}}};{{{label|}}};{{#invoke:SoundtrackTable|formatRecord|{{{soundroom|}}}}} }}<!-- Create record | ||
-->{{#if:{{filepath:{{{filename}}}}}<!-- Check if file is uploaded | -->{{#if:{{filepath:{{{filename}}}}}<!-- Check if file is uploaded | ||
-->|[{{filepath:{{{filename}}}}} {{#tag:nowiki|{{{title}}}}}]<!-- Visible file link | -->|[{{filepath:{{{filename}}}}} {{#tag:nowiki|{{{title}}}}}]<!-- Visible file link |
Revision as of 17:49, 21 July 2024
This template conditionally sets categories on pages. Please only use this template as intended. Conditions: On Collective Unconscious pages, it adds Category:Missing BGM author if no author is specified. |
This template automatically sets Semantic MediaWiki properties on pages. This may include creating subobjects. Please only use this template as intended. |
Description
Renders a link (if provided) to an area's BGM, and sets a record that can be queried.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | The BGM's title to be displayed. This could either be an official title, or the original filename exclusive of extension.
| String | required |
Filename | filename | The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.
| String | suggested |
Label | label | A label describing where or when the BGM would play. This could be a sub-area, an event, or the area under different conditions.
| String | optional |
Sound Room ID | soundroom | If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID as seen in the Sound Room.
| String | optional |
Speed | speed | The speed at which the track is set to play in-game.
| Number | required |
Author | author | Credit the track's composer/author. Usually only applicable to collaborative games.
| String | optional |
Semantic properties
This template exposes the following semantic properties.
Property name | Description | Data type | Cardinality |
---|---|---|---|
Has BGM | The main record that holds all the other properties. | Record | Single |
BGM/Title | The title of the BGM, either official or from the game files. | Text | Single |
Has media path | The path leading to the audio file on the wiki. | URL | Single |
BGM/Audio | The wiki page of the audio file. | Page | Single |
BGM/Label | A label describing the BGM, usually where it plays in the location. | Text | Single |
BGM/Soundroom | The ID of the track in the game's Sound Room or equivalent feature, if one is present in the game. | Text | Multiple |
BGM/Speed | The speed at which the BGM is set to play in the location. This should correspond to the audio file on the wiki. | Number | Single |
BGM/Author | The author(s) who created the BGM. Usually only applicable to collaborative games. | Text | Multiple |
Syntax
{{BGM|title= |filename= |label= |speed= |soundroom= |author= }}
Sample
The following input:
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
Produces:
tonny31.6 (??%) (No. 248D): Budding Life World