The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

Difference between revisions of "Template:Infobox interface/doc"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
m
Line 1: Line 1:
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<noinclude>{{Documentation subpage}}</noinclude>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
==Usage==
 
 
This template provides an info box for an interface class. The info box can contain relevant information like parent interfaces.
 
This template provides an info box for an interface class. The info box can contain relevant information like parent interfaces.
  
 +
==Usage==
 +
{{Infobox interface
 +
| interface = UIDataStorePublisher
 +
| package  = UTGame
 +
| game      = UT3
 +
| engine    = UE3
 +
| tree      =
 +
+ [[UE3:UIDataStoreSubscriber (UT3)|UIDataStoreSubscriber]]
 +
++ [[UE3:UIDataStorePublisher (UT3)|UIDataStorePublisher]]
 +
| nocat    = 1
 +
}}
 
Example:
 
Example:
 
<pre>
 
<pre>
Line 10: Line 19:
 
| package  = UTGame
 
| package  = UTGame
 
| game      = UT3
 
| game      = UT3
 +
| engine    = UE3
 
| tree      =
 
| tree      =
 
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
 
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
Line 16: Line 26:
 
</pre>
 
</pre>
  
Only '''package''' is mandatory. If '''interface''', '''game''' or '''engine''' are missing, they are derived from the current page name. The parameter '''engine''' is only used if no game could be derived from parameter or page name. It's usually better to let the template derive game and/or engine from the page name. A '''tree''' should only be specified if the interface has a parent interface other than Interface, which should not be included in the tree.
+
If '''interface''', '''game''' or '''engine''' are missing, they are derived from the current page name. The engine is only displayed if no game could be derived from parameter or page name, but it may still be used for page and category links. It's usually better to let the template derive class, game and engine from the page name. A '''tree''' should only be specified if the interface has a parent interface other than ''Interface'', which should not be included in the tree.
  
 
==See also==
 
==See also==
 
* [[Template:Infobox class]]
 
* [[Template:Infobox class]]
  
<includeonly><!--
+
<includeonly>
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
+
 
[[Category:Infobox templates|Interface]]
 
[[Category:Infobox templates|Interface]]
 
</includeonly>
 
</includeonly>

Revision as of 09:16, 7 March 2008

This subpage contains documentation, categories and other content that is not part of the template.
To view the template page itself, see Template:Infobox interface.

This template provides an info box for an interface class. The info box can contain relevant information like parent interfaces.

Usage

UT3 Interface >> UIDataStorePublisher

Contents

Package: 
UTGame
Known implementing classes:
UICheckbox, UIComboBox, UIContextMenu, UIEditBox, UIImage, UILabelButton, UIList, UINumericEditBox, UINumericOptionList, UIOptionList, UIOptionListBase, UIProgressBar, UISlider, UITabButton, UIToggleButton, UTMapBackgroundImage, UTMapRoundImage, UTUIButtonBarButton, UTUICollectionCheckBox, UTUIComboBox, UTUIEditBox, UTUIList, UTUINumericEditBox, UTUIOptionButton, UTUISlider, UTUI_ContextMenu
This interface in other games:
UT3, UDK

Example:

{{Infobox interface
| interface = UIDataStorePublisher
| package   = UTGame
| game      = UT3
| engine    = UE3
| tree      =
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
++ [[UE3:UIDataStorePublisher (UT3)|]]
}}

If interface, game or engine are missing, they are derived from the current page name. The engine is only displayed if no game could be derived from parameter or page name, but it may still be used for page and category links. It's usually better to let the template derive class, game and engine from the page name. A tree should only be specified if the interface has a parent interface other than Interface, which should not be included in the tree.

See also