Always snap to grid
Difference between revisions of "Template:Infobox class/doc"
m |
|||
| Line 18: | Line 18: | ||
</pre> | </pre> | ||
| − | 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. | + | 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, for example: |
| + | <pre> | ||
| + | + (...) | ||
| + | ++ UTVehicleWeapon | ||
| + | +++ UTVWeap_NightshadeGun | ||
| + | ++++ UTVWeap_StealthGunContent | ||
| + | +++++ UTVWeap_NightshadeGun_Content | ||
| + | </pre> | ||
| + | This will create the following tree: | ||
| + | + (...) | ||
| + | ++ UTVehicleWeapon | ||
| + | +++ UTVWeap_NightshadeGun | ||
| + | ++++ UTVWeap_StealthGunContent | ||
| + | +++++ UTVWeap_NightshadeGun_Content | ||
==See also== | ==See also== | ||
Revision as of 09:47, 4 March 2008
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, for example:
+ (...) ++ UTVehicleWeapon +++ UTVWeap_NightshadeGun ++++ UTVWeap_StealthGunContent +++++ UTVWeap_NightshadeGun_Content
This will create the following tree:
UTVehicleWeapon
UTVWeap_NightshadeGunUTVWeap_StealthGunContentUTVWeap_NightshadeGun_Content