My program doesn't have bugs. It just develops random features.

Difference between revisions of "Template:Infobox interface"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(added support for custom parent interfaces)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| class="infobox infobox-class"
+
{{Infobox interface/core
! [[Interface]]:
+
| i = {{{interface|{{classname}}}}}
| {{#if:{{{package|}}}|{{{package}}}.}}{{{interface|{{classname}}}}} {{#if:{{{custom|}}}|(custom)}}
+
| e = {{{engine|{{ARTICLESPACE}}}}}
|{{#if: {{{game|{{gamename}}}}}
+
| g = {{{game|{{gamename}}}}}
|-
+
| ge = {{#if:{{{game|{{gamename}}}}}|{{{game|{{gamename}}}}}|{{{engine|{{ARTICLESPACE}}}}}}}
! Game:
+
| p = {{{package|}}}
{{!}} [[{{{game|{{gamename}}}}}]]
+
| p1 = {{{parent1|{{{parent|}}}}}}
{{!}}|{{#if: {{#pos: UE1UE2UE3 | {{{engine|{{ARTICLESPACE}}}}}}}
+
| p2 = {{{parent2|}}}
|-
+
| p3 = {{{parent3|}}}
! Engine:
+
| custom = {{{custom|}}}
{{!}} [[{{{engine|{{ARTICLESPACE}}}}}]]
+
| cp1 = {{{customparent1|{{{customparent|}}}}}}
{{!}}}}}}{{#if: {{{tree|}}}
+
| cp2 = {{{customparent2|}}}
|-
+
| cp3 = {{{customparent3|}}}
! colspan="2" {{!}} Interface tree:
+
| notoc = {{{notoc|}}}
{{!}}-
+
| nocat = {{#ifeq:{{ARTICLESPACE}}|Template|1|{{{nocat|}}}}}
{{!}} colspan="2" {{!}}
+
| inline = {{#ifeq:{{ARTICLESPACE}}|Template|1|{{{interface|}}}}}
{{{tree}}}
+
}}<noinclude>
{{!}}}}-
+
| colspan="2" class="plainlinks" style="font-size:smaller;text-align:center;" | <includeonly>[{{fullurl:Category:Classes implementing {{{interface|{{classname}}}}}{{#if: {{{game|{{gamename}}}}}|_({{{game|{{gamename}}}}})|{{#if: {{#pos: UE1UE2UE3 | {{{engine|{{ARTICLESPACE}}}}}}}|_({{{engine|{{ARTICLESPACE}}}}})}}}}}} Classes implementing {{{interface|{{classname}}}}}]</includeonly><noinclude>[Classes implementing this interface]</noinclude>
+
|}<includeonly>{{DISPLAYTITLE:{{{interfacepage|{{classpage|c={{{interface|{{classname}}}}}}}}}}}}{{DEFAULTSORT:{{PAGENAME}} {{{game|}}} {{{engine|{{ARTICLESPACE}}}}}}}{{#if:{{{interfacepage|{{{nocat|}}}}}}||{{#if: {{{custom|}}}|{{#if: {{{game|{{gamename}}}}}|[[Category:Custom {{{game|{{gamename}}}}}-specific interfaces]]|{{#if: {{{engine|{{ARTICLESPACE}}}}}|[[Category:Custom {{{engine|{{ARTICLESPACE}}}}}-specific interfaces]]|[[Category:Custom interfaces]]}}}}|{{#if: {{{game|{{gamename}}}}}|[[Category:{{{game|{{gamename}}}}}-specific interfaces]]|{{#if: {{{engine|{{ARTICLESPACE}}}}}|[[Category:{{{engine|{{ARTICLESPACE}}}}}-specific interfaces]]|[[Category:Interfaces]]}}}}{{#if: {{{package|}}}|{{#if: {{{game|{{gamename}}}}}|[[Category:Interfaces in {{{game|{{gamename}}}}} package {{{package}}}]]|{{#if: {{{engine|{{ARTICLESPACE}}}}}|[[Category:Interfaces in {{{engine|{{ARTICLESPACE}}}}} package {{{package}}}]]|[[Category:Interfaces in package {{{package}}}]]}}}}}}}}[[Category:Classes implementing {{{interface|{{classname}}}}}{{#if: {{{game|{{gamename}}}}}|_({{{game|{{gamename}}}}})|{{#if: {{#pos: UE1UE2UE3 | {{{engine|{{ARTICLESPACE}}}}}}}|_({{{engine|{{ARTICLESPACE}}}}})}}}}| ]]}}</includeonly><noinclude>
+
 
{{documentation}}
 
{{documentation}}
 
</noinclude>
 
</noinclude>

Latest revision as of 07:23, 17 March 2010

Template:Template Interface >> Infobox_interface

Contents

[edit] Documentation

This template provides an info box for an interface class. The info box can contain relevant information like parent interfaces.

Usage

Example:

{{Infobox interface
| interface = UIDataStorePublisher
| package   = Engine
| game      = UT3
| engine    = UE3
| parent    = UIDataStoreSubscriber
}}
UT3 Interface >> UIDataStoreSubscriber >> UIDataStorePublisher
Package: 
Engine
Known implementing classes:
UICheckbox, UIComboBox, UIContextMenu, UIEditBox, UIImage, UILabelButton, UIList, UINumericEditBox, UINumericOptionList, UIOptionList, UIOptionListBase, UIProgressBar, UISlider, UITabButton, UIToggleButton, UTMapBackgroundImage, UTMapRoundImage, UTUIButtonBarButton, UTUICollectionCheckBox, UTUIComboBox, UTUIEditBox, UTUIList, UTUINumericEditBox, UTUIOptionButton, UTUISlider, UTUI_ContextMenu
This interface in other games:
UT3, UDK

If interface, game or engine are missing, they are derived from the current page name. Engine and game are only used for page and category links. It's usually better to let the template derive class, game and engine from the page name. If the interface has a super interface other than "Interface" itself, the list of parent interfaces up to (but excluding) "Interface" should be specified. If more than one parent needs to be specified, use parent1, parent2, etc., with parent1 being a synonym for parent.

For the interface "Interface" itself the class "Object" is given as parent, because technically "Interface" is an abstract class extending "Object" and all other interfaces are abstract classes extending either class "Interface" or their parent interface.

See also