Template:VoiceLineCite/doc: Difference between revisions
Gammaton32 (talk | contribs) No edit summary |
m no_pageref_file |
||
(7 intermediate revisions by 2 users not shown) | |||
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> | ||
==Example | There's an optional parameter to change the possessive suffix and one to add extra context to the line. | ||
==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: | |||
{{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: | |||
<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.}} | ||
This can be handled by passing the parameter ''no_pageref_file=true''. | |||
<nowiki>{{VoiceLineCite|name=Amber Hand|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki> | |||
Result: | |||
{{VoiceLineCite|name=Amber Hand|no_pageref_file=true||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 to whom the voice line belongs", | |||
"required": true | "required": true | ||
}, | }, | ||
"suffix": { | |||
"type": "string", | |||
"description": "Possessive suffix change for characters whose name ends with 's'", | |||
"required": false | |||
}, | |||
"file": { | "file": { | ||
" | "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", | |||
"required": true | "required": true | ||
} | }, | ||
"no_pageref_file": { | |||
"type": "string", | |||
"description": "Tells [[Template:PageRef]] to not use the icon file. Note that passing ''false'' does not work, the parameter must then be ommitted.", | |||
"required": false, | |||
"example": "true" | |||
} | |||
}, | }, | ||
"format": "inline", | "format": "inline", | ||
"paramOrder": [ | |||
" | "name", | ||
"suffix", | |||
"file", | "file", | ||
"transcription" | "context", | ||
"transcription", | |||
"no_pageref_file" | |||
] | ] | ||
} | } | ||
</templatedata><noinclude>[[Category:Template documentation]]</noinclude> | </templatedata><noinclude>[[Category:Template documentation]]</noinclude> |
Latest revision as of 17:42, 22 December 2024
Usage[edit source]
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 possessive suffix and one to add extra context to the line.
Example usages[edit source]
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."
This can be handled by passing the parameter no_pageref_file=true.
{{VoiceLineCite|name=Amber Hand|no_pageref_file=true|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 to whom the voice line belongs | String | required |
suffix | suffix | Possessive 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 |
no_pageref_file | no_pageref_file | Tells [[Template:PageRef]] to not use the icon file. Note that passing ''false'' does not work, the parameter must then be ommitted.
| String | optional |