I don't need to test my programs. I have an error-correcting modem.

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (updated for new layout)
m (Usage: adjusted example to reflect new parent order)
Line 10: Line 10:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
| parent1  = Interface
+
| parent1  = UIDataStoreSubscriber
| parent2  = UIDataStoreSubscriber
+
| parent2  = Interface
 
}}
 
}}
 
</pre>
 
</pre>
Line 19: Line 19:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
| parent1  = Interface
+
| parent1  = UIDataStoreSubscriber
| parent2  = UIDataStoreSubscriber
+
| parent2  = Interface
 
| nocat    = 1
 
| nocat    = 1
 
}}
 
}}

Revision as of 10:03, 9 May 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   = UIDataStoreSubscriber
| parent2   = Interface
}}
UT3 Interface >> Interface >> UIDataStoreSubscriber >> 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