There is no spoon

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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
−
| tree    =
+
| parent1 = Object
−
+ [[UE3:Object (UT3)|Object]]
+
| parent2 = CheatManager
−
++ [[UE3:CheatManager (UT3)|CheatManager]]
+
−
+++ [[UE3:UTCheatManager (UT3)|UTCheatManager]]
+
−
| nocat  = 1
+
 
}}
 
}}
−
Example:
+
</pre>
−
<pre>
+
 
{{Infobox class
 
{{Infobox class
 
| class  = UTCheatManager
 
| class  = UTCheatManager
Line 23: Line 21:
 
| game    = UT3
 
| game    = UT3
 
| engine  = UE3
 
| engine  = UE3
−
| tree    =
+
| parent1 = Object
−
+ [[UE3:Object (UT3)|]]
+
| parent2 = CheatManager
−
++ [[UE3:CheatManager (UT3)|]]
+
| nocat  = 1
−
+++ [[UE3:UTCheatManager (UT3)|]]
+
 
}}
 
}}
−
</pre>
+
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:
  
−
If '''class''', '''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 is always used for linking pages and categories. The class in the '''within''' parameter is automatically linked, if possible. A '''tree''' should be specified for all classes (except Object, which has no parent), although Actor-derived classes need not include the Object class here. If the tree would become too deep, the first few classes can be replaced with a single "(...)" to signal that there are more classes further up in the tree, for example:
 
 
<pre>
 
<pre>
−
+ (...)
 
−
++ UTVehicleWeapon
 
−
+++ UTVWeap_NightshadeGun
 
−
++++ UTVWeap_StealthGunContent
 
−
+++++ UTVWeap_NightshadeGun_Content
 
−
</pre>
 
−
This will create the following tree:
 
−
+ (...)
 
−
++ UTVehicleWeapon
 
−
+++ UTVWeap_NightshadeGun
 
−
++++ UTVWeap_StealthGunContent
 
−
+++++ UTVWeap_NightshadeGun_Content
 
−
 
 
{{infobox class
 
{{infobox class
 
| class      = UIComp_DrawImage
 
| class      = UIComp_DrawImage
Line 53: Line 38:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
−
| tree      =
+
| parent2    = Component
−
+ [[UE3:Object (UT3)|Object]]
+
| parent3    = UIComponent
−
++ [[UE3:Component (UT3)|Component]]
+
| parent4    = UIComp_DrawComponents
−
+++ [[UE3:UIComponent (UT3)|UIComponent]]
+
−
++++ [[UE3:UIComp_DrawComponents (UT3)|UIComp_DrawComponents]]
+
−
+++++ [[UE3:UIComp_DrawImage (UT3)|UIComp_DrawImage]]
+
−
| nocat      = 1
+
 
}}
 
}}
−
If a class implements one or more interfaces, they can be specified as follows:
+
</pre>
−
<pre>
+
 
{{infobox class
 
{{infobox class
 
| class      = UIComp_DrawImage
 
| class      = UIComp_DrawImage
Line 71: Line 51:
 
| game      = UT3
 
| game      = UT3
 
| engine    = UE3
 
| engine    = UE3
−
| tree      =
+
| parent2    = Component
−
+ [[UE3:Object (UT3)|Object]]
+
| parent3    = UIComponent
−
++ [[UE3:Component (UT3)|Component]]
+
| parent4    = UIComp_DrawComponents
−
+++ [[UE3:UIComponent (UT3)|UIComponent]]
+
| nocat      = 1
−
++++ [[UE3:UIComp_DrawComponents (UT3)|UIComp_DrawComponents]]
+
−
+++++ [[UE3:UIComp_DrawImage (UT3)|UIComp_DrawImage]]
+
 
}}
 
}}
−
</pre>
 
 
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 17:12, 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 class.

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
}}
UT3 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
}}
UT3 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.

See also


Retrieved from "https://wiki.beyondunreal.com/Template:Infobox_class/doc?oldid=946"