I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX
Difference between revisions of "Template:Infobox class/doc"
From Unreal Wiki, The Unreal Engine Documentation Site
m (updated for new layout) |
|||
| Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
| + | Example: | ||
| + | <pre> | ||
{{Infobox class | {{Infobox class | ||
| class = UTCheatManager | | class = UTCheatManager | ||
| Line 9: | Line 11: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent1 = Object |
| − | + | | parent2 = CheatManager | |
| − | + | ||
| − | + | ||
| − | + | ||
}} | }} | ||
| − | + | </pre> | |
| − | <pre> | + | |
{{Infobox class | {{Infobox class | ||
| class = UTCheatManager | | class = UTCheatManager | ||
| Line 23: | Line 21: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent1 = Object |
| − | + | | parent2 = CheatManager | |
| − | + | | nocat = 1 | |
| − | + | ||
}} | }} | ||
| − | + | If '''class''', '''game''' or '''engine''' are missing, they are derived from the current page name. (You can see this effect in the default output on the [[Template:Infobox class|template page]].) Engine and game are only used for linking pages and categories. | |
| + | |||
| + | The classes and interfaces in the '''within''', '''parent'''''x'' and '''interface'''''x'' parameters are automatically linked. The list of parent classes should always be given as complete as possible. For Actor-derived classes the list should start with the Actor class, otherwise it should start with the Object class. Up to nine parent classes can be specified, but if the list gets too long, consider cutting it off at a "well-known" class. In this case, start with '''parent2''' to indicate the incomplete class tree, like in the following example: | ||
| − | |||
<pre> | <pre> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{infobox class | {{infobox class | ||
| class = UIComp_DrawImage | | class = UIComp_DrawImage | ||
| Line 53: | Line 38: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent2 = Component |
| − | + | | parent3 = UIComponent | |
| − | + | | parent4 = UIComp_DrawComponents | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
}} | }} | ||
| − | + | </pre> | |
| − | <pre> | + | |
{{infobox class | {{infobox class | ||
| class = UIComp_DrawImage | | class = UIComp_DrawImage | ||
| Line 71: | Line 51: | ||
| game = UT3 | | game = UT3 | ||
| engine = UE3 | | engine = UE3 | ||
| − | | | + | | parent2 = Component |
| − | + | | parent3 = UIComponent | |
| − | + | | parent4 = UIComp_DrawComponents | |
| − | + | | nocat = 1 | |
| − | + | ||
| − | + | ||
}} | }} | ||
| − | |||
Classes implementing one or more interfaces will automatically be added to relevant categories, which are also linked from the corresponding interface page if it contains an [[Template:Infobox interface|interface infobox]]. | Classes implementing one or more interfaces will automatically be added to relevant categories, which are also linked from the corresponding interface page if it contains an [[Template:Infobox interface|interface infobox]]. | ||
Revision as of 16:12, 18 March 2008
This template provides an info box for a class. The info box can contain relevant information like parent classes, implemented interfaces or the within class.
Usage
Example:
{{Infobox class
| class = UTCheatManager
| package = UTGame
| within = PlayerController
| game = UT3
| engine = UE3
| parent1 = Object
| parent2 = CheatManager
}}
 |
CheatManager >> Object >> UTCheatManager |
Contents
- Package:
- UTGame
- Within class:
- PlayerController
- This class in other games:
- UT3, UDK
If class, game or engine are missing, they are derived from the current page name. (You can see this effect in the default output on the template page.) Engine and game are only used for linking pages and categories.
The classes and interfaces in the within, parentx and interfacex parameters are automatically linked. The list of parent classes should always be given as complete as possible. For Actor-derived classes the list should start with the Actor class, otherwise it should start with the Object class. Up to nine parent classes can be specified, but if the list gets too long, consider cutting it off at a "well-known" class. In this case, start with parent2 to indicate the incomplete class tree, like in the following example:
{{infobox class
| class = UIComp_DrawImage
| package = Engine
| within = UIObject
| interface1 = UIStyleResolver
| interface2 = CustomPropertyItemHandler
| game = UT3
| engine = UE3
| parent2 = Component
| parent3 = UIComponent
| parent4 = UIComp_DrawComponents
}}
|
UIComp_DrawComponents >> UIComponent >> Component >> UIComp_DrawImage |
- Package:
- Engine
- Within class:
- UIObject
- Implemented interfaces:
- UIStyleResolver, CustomPropertyItemHandler
- Direct subclasses:
- UIComp_DrawTeamColoredImage, UIComp_UTDrawStateImage
- This class in other games:
- UT3, UDK
Classes implementing one or more interfaces will automatically be added to relevant categories, which are also linked from the corresponding interface page if it contains an interface infobox.
