Template:VoiceLineCite/doc: Difference between revisions
m example added that shows it works if icon doesnt exist |
Gammaton32 (talk | contribs) No edit summary |
||
Line 2: | Line 2: | ||
This template can be used to reference in-game voice lines. | This template can be used to reference in-game voice lines. | ||
<nowiki>{{VoiceLineCite| | <nowiki>{{VoiceLineCite|name=hero_name|file=file_name.extension|transcription=transcription}}</nowiki> | ||
There's an optional parameter to change the quote suffix and one to add extra context to the line. | |||
==Example usages== | ==Example usages== | ||
Example: | Example: | ||
<nowiki>{{VoiceLineCite| | <nowiki>{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki> | ||
Result: | Result: | ||
{{VoiceLineCite| | {{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}} | ||
Example where the png icon for Amber Hand doesn't exist: | Example where the png icon for Amber Hand doesn't exist: | ||
<nowiki>{{VoiceLineCite| | <nowiki>{{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki> | ||
Result: | Result: | ||
{{VoiceLineCite| | {{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}} | ||
Example of suffix change: | |||
<nowiki>{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}</nowiki> | |||
Result: | |||
{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}} | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
" | "name": { | ||
"aliases": [ | "aliases": [ | ||
"1" | "1" | ||
], | ], | ||
"description": "The name of the | "type": "string", | ||
"description": "The name of the character who the voice line belongs", | |||
"required": true | "required": true | ||
}, | }, | ||
"suffix": { | |||
"type": "string", | |||
"description": "Optional suffix change for characters whose name ends with 's'", | |||
"required": false | |||
}, | |||
"file": { | "file": { | ||
"type": "string", | "type": "string", | ||
"description": "The name of the uploaded voice-line sound file (must include the file extension eg. .mp3)", | "description": "The name of the uploaded voice-line sound file (must include the file extension eg. .mp3)", | ||
"required": true | "required": true | ||
}, | }, | ||
"context": { | |||
"type": "string", | |||
"description": "Additional context to the line", | |||
"required": false | |||
}, | |||
"transcription": { | "transcription": { | ||
" | "type": "string", | ||
"description": "The transcription of the voice line (without quotation marks)", | "description": "The transcription of the voice line (without quotation marks)", | ||
"required": true | "required": true | ||
Line 47: | Line 62: | ||
}, | }, | ||
"format": "inline", | "format": "inline", | ||
"paramOrder": [ | |||
" | "name", | ||
"suffix", | |||
"file", | "file", | ||
"context", | |||
"transcription" | "transcription" | ||
] | ] | ||
} | } | ||
</templatedata><noinclude>[[Category:Template documentation]]</noinclude> | </templatedata><noinclude>[[Category:Template documentation]]</noinclude> |
Revision as of 01:07, 30 November 2024
Usage
This template can be used to reference in-game voice lines.
{{VoiceLineCite|name=hero_name|file=file_name.extension|transcription=transcription}}
There's an optional parameter to change the quote suffix and one to add extra context to the line.
Example usages
Example:
{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}
Result:
Lash's in-game voice line (killed Wraith) - "Backed the wrong horse, Wraith. Like always."
Example where the png icon for Amber Hand doesn't exist:
{{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
Result:
Amber Hand's in-game voice line - "Backed the wrong horse, Wraith. Like always."
Example of suffix change:
{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}
Result:
Abrams' in-game voice line - "Don't worry, I'm on the case."
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name 1 | The name of the character who the voice line belongs | String | required |
suffix | suffix | Optional suffix change for characters whose name ends with 's' | String | optional |
file | file | The name of the uploaded voice-line sound file (must include the file extension eg. .mp3) | String | required |
context | context | Additional context to the line | String | optional |
transcription | transcription | The transcription of the voice line (without quotation marks) | String | required |