Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
Line 1: Line 1:
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<noinclude>{{Documentation subpage}}</noinclude>
−
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
−
==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.
 
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==
 +
{{Infobox class
 +
| class  = UTCheatManager
 +
| package = UTGame
 +
| within  = PlayerController
 +
| game    = UT3
 +
| engine  = UE3
 +
| tree    =
 +
+ [[UE3:Object (UT3)|Object]]
 +
++ [[UE3:CheatManager (UT3)|CheatManager]]
 +
+++ [[UE3:UTCheatManager (UT3)|UTCheatManager]]
 +
| nocat  = 1
 +
}}
 
Example:
 
Example:
 
<pre>
 
<pre>
Line 11: Line 22:
 
| within  = PlayerController
 
| within  = PlayerController
 
| game    = UT3
 
| game    = UT3
 +
| engine  = UE3
 
| tree    =
 
| tree    =
 
+ [[UE3:Object (UT3)|]]
 
+ [[UE3:Object (UT3)|]]
Line 18: Line 30:
 
</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, for 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>
 
+ (...)
 
+ (...)
Line 32: Line 44:
 
++++ UTVWeap_StealthGunContent
 
++++ UTVWeap_StealthGunContent
 
+++++ UTVWeap_NightshadeGun_Content
 
+++++ UTVWeap_NightshadeGun_Content
 +
 +
{{infobox class
 +
| class      = UIComp_DrawImage
 +
| package    = Engine
 +
| within    = UIObject
 +
| interface1 = UIStyleResolver
 +
| interface2 = CustomPropertyItemHandler
 +
| game      = UT3
 +
| engine    = UE3
 +
| tree      =
 +
+ [[UE3:Object (UT3)|Object]]
 +
++ [[UE3:Component (UT3)|Component]]
 +
+++ [[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>
 +
{{infobox class
 +
| class      = UIComp_DrawImage
 +
| package    = Engine
 +
| within    = UIObject
 +
| interface1 = UIStyleResolver
 +
| interface2 = CustomPropertyItemHandler
 +
| game      = UT3
 +
| engine    = UE3
 +
| tree      =
 +
+ [[UE3:Object (UT3)|Object]]
 +
++ [[UE3:Component (UT3)|Component]]
 +
+++ [[UE3:UIComponent (UT3)|UIComponent]]
 +
++++ [[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]].
  
 
==See also==
 
==See also==
 
* [[Template:Infobox interface]]
 
* [[Template:Infobox interface]]
  
−
<includeonly><!--
+
<includeonly>
−
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
+
 
[[Category:Infobox templates|Class]]
 
[[Category:Infobox templates|Class]]
 
</includeonly>
 
</includeonly>

Revision as of 09:22, 7 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

UT3 UTCheatManager

Contents

Package: 
UTGame
Within class: 
PlayerController
This class in other games:
UT3, UDK

Example:

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

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:

+ (...)
++ UTVehicleWeapon
+++ UTVWeap_NightshadeGun
++++ UTVWeap_StealthGunContent
+++++ UTVWeap_NightshadeGun_Content

This will create the following tree:

(...)
\- UTVehicleWeapon
   \- UTVWeap_NightshadeGun
      \- UTVWeap_StealthGunContent
         \- UTVWeap_NightshadeGun_Content
UT3 UIComp_DrawImage
Package: 
Engine
Within class: 
UIObject
Implemented interfaces: 
UIStyleResolver, CustomPropertyItemHandler
Direct subclasses:
UIComp_DrawTeamColoredImage, UIComp_UTDrawStateImage
This class in other games:
UT3, UDK

If a class implements one or more interfaces, they can be specified as follows:

{{infobox class
| class      = UIComp_DrawImage
| package    = Engine
| within     = UIObject
| interface1 = UIStyleResolver
| interface2 = CustomPropertyItemHandler
| game       = UT3
| engine     = UE3
| tree       =
+ [[UE3:Object (UT3)|Object]]
++ [[UE3:Component (UT3)|Component]]
+++ [[UE3:UIComponent (UT3)|UIComponent]]
++++ [[UE3:UIComp_DrawComponents (UT3)|UIComp_DrawComponents]]
+++++ [[UE3:UIComp_DrawImage (UT3)|UIComp_DrawImage]]
}}

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=733"