Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
m (updated for new layout)
Line 3: Line 3:
  
 
==Usage==
 
==Usage==
 +
Example:
 +
<pre>
 
{{Infobox interface
 
{{Infobox interface
 
| interface = UIDataStorePublisher
 
| interface = UIDataStorePublisher
Line 8: Line 10:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
| tree      =
+
| parent1  = Interface
+ [[UE3:UIDataStoreSubscriber (UT3)|UIDataStoreSubscriber]]
+
| parent2  = UIDataStoreSubscriber
++ [[UE3:UIDataStorePublisher (UT3)|UIDataStorePublisher]]
+
| nocat    = 1
+
 
}}
 
}}
Example:
+
</pre>
<pre>
+
 
{{Infobox interface
 
{{Infobox interface
 
| interface = UIDataStorePublisher
 
| interface = UIDataStorePublisher
Line 20: Line 19:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
| tree      =
+
| parent1  = Interface
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
+
| parent2  = UIDataStoreSubscriber
++ [[UE3:UIDataStorePublisher (UT3)|]]
+
| nocat    = 1
 
}}
 
}}
</pre>
+
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. The '''parent''' defaults to "Interface", except for the Interface class itself, where it defaults to "Object". (Interface technically is a subclass of Object.) If the interface has a different super interface, the entire list of parent interfaces up to and including Interface should be given.
 
+
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==

Revision as of 17:46, 18 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

Example:

{{Infobox interface
| interface = UIDataStorePublisher
| package   = UTGame
| game      = UT3
| engine    = UE3
| parent1   = Interface
| parent2   = UIDataStoreSubscriber
}}
UT3 Interface >> UIDataStoreSubscriber >> 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

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. The parent defaults to "Interface", except for the Interface class itself, where it defaults to "Object". (Interface technically is a subclass of Object.) If the interface has a different super interface, the entire list of parent interfaces up to and including Interface should be given.

See also