I don't need to test my programs. I have an error-correcting modem.
Difference between revisions of "Template:Infobox class/doc"
m (→Usage: adjusted examples to reflect new parent order) |
m (nocat no longer necessary here) |
||
| Line 23: | Line 23: | ||
| parent1 = CheatManager | | parent1 = CheatManager | ||
| parent2 = Object | | parent2 = Object | ||
| − | |||
}} | }} | ||
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. | 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. | ||
| Line 53: | Line 52: | ||
| parent2 = UIComponent | | parent2 = UIComponent | ||
| parent3 = Component | | parent3 = Component | ||
| − | |||
}} | }} | ||
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 11:50, 9 May 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 = CheatManager
| parent2 = Object
}}
 |
Object >> CheatManager >> 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 ten parent classes can be specified, but if the list gets too long, consider cutting it off at a "well-known" class, like in the following example:
{{infobox class
| class = UIComp_DrawImage
| package = Engine
| within = UIObject
| interface1 = UIStyleResolver
| interface2 = CustomPropertyItemHandler
| game = UT3
| engine = UE3
| parent1 = UIComp_DrawComponents
| parent2 = UIComponent
| parent3 = Component
}}
|
Component >> UIComponent >> UIComp_DrawComponents >> 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.
