Template:Gametip/doc: Difference between revisions

From Homecoming Wiki
Jump to navigation Jump to search
imported>Eabrace (historical)
m (updating documentation)
imported>Aggelakis (historical)
m (a non-hero/vill specific image is a better default)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The Gametip template creates a text box containing a general tip for the game.  Tips can be Hero-specific, Villain-specific, or generic.
{{documentation subpage}}
The Gametip template creates a text box containing a general tip for the game.  Tips can be Hero-specific, Villain-specific, or generic.  Switch statements are used to alter the background and text colors of the boxes depending on the game specified in the template call.
 
Hero-specific tips will appear in blue boxes with white text and an City of Heroes icon.
 
Villain-specific tips will appear in red boxes with white text and an City of Villains icon.
 
Generic tips which apply to both games will appear in gray boxes with black text and an icon that is a hybrid of the City of Heroes and City of Villains icons.


==Syntax==
==Syntax==


'''<nowiki>{{</nowiki>Gametip | Game='''''game_id''''' | Tip='''''tip_text'''''<nowiki>}}</nowiki>
'''<nowiki>{{</nowiki>Gametip | game='''''game_id''''' | tip='''''tip_text'''''<nowiki>}}</nowiki>


where:
where:
Line 9: Line 16:
'''game_id'''
'''game_id'''
: Indicates whether the tip is specific to Heroes, specific to Villains, or generic.
: Indicates whether the tip is specific to Heroes, specific to Villains, or generic.
:* For Hero-specific tips, set this value to "'''hero'''".
:* For Hero-specific tips, set this value to '''h''', '''hero''', or '''heroes'''.
:* For Hero-specific tips, set this value to "'''vill'''".
:* For Villain-specific tips, set this value to '''v''', '''vill''', or '''villains'''.
:* For Hero-specific tips, set this value to "'''both'''". (This is also the default format.)
:* For Neutral tips, set this value to '''n''' or '''neutral'''. ''(Default if nothing is passed to '''game'''.)''
:* For tips that pertain to both 'sides,' set this value to '''x''', or '''both'''.


'''tip_text'''
'''tip_text'''
Line 17: Line 25:


==Examples==
==Examples==
<nowiki>{{Gametip|Game=hero|Tip=This will create a Hero-specific game tip.}}</nowiki>
<nowiki>{{Gametip|game=hero|tip=This will create a Hero-specific game tip.}}</nowiki>
{{Gametip|Game=hero|Tip=This will create a Hero-specific game tip.}}
{{Gametip|game=hero|tip=This will create a Hero-specific game tip.}}
 
<nowiki>{{Gametip|game=vill|tip=This will create a Villain-specific game tip.}}</nowiki>
{{Gametip|game=vill|tip=This will create a Villain-specific game tip.}}
 
<nowiki>{{Gametip|game=both|tip=This will create a generic game tip.}}</nowiki>
{{Gametip|game=both|tip=This will create a generic game tip.}}


<nowiki>{{Gametip|Game=vill|Tip=This will create a Villain-specific game tip.}}</nowiki>
<nowiki>{{Gametip|game=n|tip=This will create a neutral game tip.}}</nowiki>
{{Gametip|Game=vill|Tip=This will create a Villain-specific game tip.}}
{{Gametip|game=N|tip=This will create a neutral game tip.}}


<nowiki>{{Gametip|Game=both|Tip=This will create a generic game tip.}}</nowiki>
<includeonly>
{{Gametip|Game=both|Tip=This will create a generic game tip.}}
[[Category:Mission Templates]]
</includeonly>

Latest revision as of 13:47, 27 March 2012

This is a documentation subpage for Template:Gametip (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

The Gametip template creates a text box containing a general tip for the game. Tips can be Hero-specific, Villain-specific, or generic. Switch statements are used to alter the background and text colors of the boxes depending on the game specified in the template call.

Hero-specific tips will appear in blue boxes with white text and an City of Heroes icon.

Villain-specific tips will appear in red boxes with white text and an City of Villains icon.

Generic tips which apply to both games will appear in gray boxes with black text and an icon that is a hybrid of the City of Heroes and City of Villains icons.

Syntax

{{Gametip | game=game_id | tip=tip_text}}

where:

game_id

Indicates whether the tip is specific to Heroes, specific to Villains, or generic.
  • For Hero-specific tips, set this value to h, hero, or heroes.
  • For Villain-specific tips, set this value to v, vill, or villains.
  • For Neutral tips, set this value to n or neutral. (Default if nothing is passed to game.)
  • For tips that pertain to both 'sides,' set this value to x, or both.

tip_text

The text of the game tip.

Examples

{{Gametip|game=hero|tip=This will create a Hero-specific game tip.}}

Tip

This will create a Hero-specific game tip.

{{Gametip|game=vill|tip=This will create a Villain-specific game tip.}}

Tip

This will create a Villain-specific game tip.

{{Gametip|game=both|tip=This will create a generic game tip.}}

Tip

This will create a generic game tip.

{{Gametip|game=n|tip=This will create a neutral game tip.}}

Tip

This will create a neutral game tip.


Retrieved from "http://wiki.homecomingservers.com/w/index.php?title=Template:Gametip/doc&oldid=232651"