Always snap to grid

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
Line 10: Line 10:
 
| package = UTGame
 
| package = UTGame
 
| within  = PlayerController
 
| within  = PlayerController
| tree    =
 
+ [[{{classpage|c=Object}}|Object]]
 
++ [[{{classpage|c=CheatManager}}|CheatManager]]
 
+++ [[{{classpage|c=UTCheatManager}}|UTCheatManager]]
 
 
| game    = UT3
 
| game    = UT3
 +
| tree    =
 +
+ [[UE3:Object (UT3)|]]
 +
++ [[UE3:CheatManager (UT3)|]]
 +
+++ [[UE3:UTCheatManager (UT3)|]]
 
}}
 
}}
 
</pre>
 
</pre>
  
Only '''package''' is mandatory. If '''class''', '''game''' or '''engine''' are missing, it they are derived from the current page name. The parameter '''engine''' is only used if no game could be derived from parameter or page name. The class in the '''within''' parameter is automatically linked, if possible.
+
Only '''package''' is mandatory. If '''class''', '''game''' or '''engine''' are missing, they are derived from the current page name. The parameter '''engine''' is only used if no game could be derived from parameter or page name. 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.
 +
 
 +
==See also==
 +
* [[Template:Infobox interface]]
  
 
<includeonly><!--
 
<includeonly><!--

Revision as of 08:55, 4 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.

Usage

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.

Example:

{{Infobox class
| class   = UTCheatManager
| package = UTGame
| within  = PlayerController
| game    = UT3
| tree    =
+ [[UE3:Object (UT3)|]]
++ [[UE3:CheatManager (UT3)|]]
+++ [[UE3:UTCheatManager (UT3)|]]
}}

Only package is mandatory. If class, game or engine are missing, they are derived from the current page name. The parameter engine is only used if no game could be derived from parameter or page name. 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.

See also