I love the smell of UnrealEd crashing in the morning. – tarquin
Difference between revisions of "Template:Infobox interface/doc"
m (→Usage: adjusted example to reflect new parent order) |
m (→Usage: adjusted example to reflect Interface always being linked now) |
||
| Line 10: | Line 10: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent = UIDataStoreSubscriber |
| − | + | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 19: | Line 18: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent = UIDataStoreSubscriber |
| − | + | ||
| nocat = 1 | | 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 '''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== | ==See also== | ||
Revision as of 09:48, 9 May 2008
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
| parent = UIDataStoreSubscriber
}}
 |
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. 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.
