Mostly Harmless

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
m (Usage: fixed example (UIDataStorePublisher is actually in package Engine))
 
(4 intermediate revisions by the same user not shown)
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==
 
Example:
 
Example:
 
<pre>
 
<pre>
 
{{Infobox interface
 
{{Infobox interface
 
| interface = UIDataStorePublisher
 
| interface = UIDataStorePublisher
| package  = UTGame
+
| package  = Engine
 
| game      = UT3
 
| game      = UT3
| tree      =
+
| engine    = UE3
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
+
| parent    = UIDataStoreSubscriber
++ [[UE3:UIDataStorePublisher (UT3)|]]
+
 
}}
 
}}
 
</pre>
 
</pre>
 +
{{Infobox interface
 +
| interface = UIDataStorePublisher
 +
| package  = Engine
 +
| game      = UT3
 +
| engine    = UE3
 +
| parent    = UIDataStoreSubscriber
 +
| nocat    = 1
 +
}}
 +
If '''interface''', '''game''' or '''engine''' are missing, they are derived from the current page name. Engine and game are only used for page and category links. It's usually better to let the template derive class, game and engine from the page name. If the interface has a super interface other than "Interface" itself, the list of '''parent''' interfaces up to (but excluding) "Interface" should be specified. If more than one parent needs to be specified, use '''parent1''', '''parent2''', etc., with '''parent1''' being a synonym for '''parent'''.
  
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.
+
For the interface "Interface" itself the class "Object" is given as parent, because technically "Interface" is an abstract class extending "Object" and all other interfaces are abstract classes extending either class "Interface" or their parent interface.
  
 
==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>

Latest revision as of 15:45, 21 November 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[edit]

Example:

{{Infobox interface
| interface = UIDataStorePublisher
| package   = Engine
| game      = UT3
| engine    = UE3
| parent    = UIDataStoreSubscriber
}}
UT3 Interface >> UIDataStoreSubscriber >> UIDataStorePublisher

Contents

Package: 
Engine
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

If interface, game or engine are missing, they are derived from the current page name. Engine and game are only used for page and category links. It's usually better to let the template derive class, game and engine from the page name. If the interface has a super interface other than "Interface" itself, the list of parent interfaces up to (but excluding) "Interface" should be specified. If more than one parent needs to be specified, use parent1, parent2, etc., with parent1 being a synonym for parent.

For the interface "Interface" itself the class "Object" is given as parent, because technically "Interface" is an abstract class extending "Object" and all other interfaces are abstract classes extending either class "Interface" or their parent interface.

See also[edit]