Template:Infobox interface: Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
m linked package to category
m added custom interface
Line 3: Line 3:
|[[Image:Icon-{{{engine|{{ARTICLESPACE}}}}}.png|{{{engine|{{ARTICLESPACE}}}}} interface]]}}}}
|[[Image:Icon-{{{engine|{{ARTICLESPACE}}}}}.png|{{{engine|{{ARTICLESPACE}}}}} interface]]}}}}
{{links|{{{parent1|{{{parent|{{#ifeq:{{{interface|{{classname}}}}}|Interface|Object|Interface}}}}}}}}|{{{parent2|}}}|{{{parent3|}}}|{{{parent4|}}}|{{{parent5|}}}|{{{parent6|}}}|{{{parent7|}}}|{{{parent8|}}}|{{{parent9|}}}|
{{links|{{{parent1|{{{parent|{{#ifeq:{{{interface|{{classname}}}}}|Interface|Object|Interface}}}}}}}}|{{{parent2|}}}|{{{parent3|}}}|{{{parent4|}}}|{{{parent5|}}}|{{{parent6|}}}|{{{parent7|}}}|{{{parent8|}}}|{{{parent9|}}}|
prefix={{#if:{{{engine|{{ARTICLESPACE}}}}}|{{{engine|{{ARTICLESPACE}}}}}:}}|suffix={{#if: {{{game|{{gamename}}}}}|_({{{game|{{gamename}}}}})}}|sep=&#32;>>&nbsp;}} >> '''{{{interface|{{classname}}}}}'''</div>
prefix={{#if:{{{engine|{{ARTICLESPACE}}}}}|{{{engine|{{ARTICLESPACE}}}}}:}}|suffix={{#if: {{{game|{{gamename}}}}}|_({{{game|{{gamename}}}}})}}|sep=&#32;>>&nbsp;}} >> '''{{{interface|{{classname}}}}}''' {{#if:{{{custom|}}}|''(custom)''}}</div>
{{#if:{{{notoc|}}}||<div style="float:right;padding:0 0 1em 1em;">__TOC__</div>}}{{#if:{{{package|}}}|
{{#if:{{{notoc|}}}||<div style="float:right;padding:0 0 1em 1em;">__TOC__</div>}}{{#if:{{{package|}}}|
;Package&#58; : {{#if:{{{custom|}}}|{{{package}}}|{{#if:{{{game|{{gamename}}}}}|[[:Category:Classes in {{{game|{{gamename}}}}} package {{{package}}}|{{{package}}}]]|{{#if:{{{engine|{{ARTICLESPACE}}}}}|[[:Category:Classes in {{{engine|{{ARTICLESPACE}}}}} package {{{package}}}|{{{package}}}]]|[[:Category:Classes in package {{{package}}}|{{{package}}}]]}}}}}}}}
;Package&#58; : {{#if:{{{custom|}}}|{{{package}}}|{{#if:{{{game|{{gamename}}}}}|[[:Category:Classes in {{{game|{{gamename}}}}} package {{{package}}}|{{{package}}}]]|{{#if:{{{engine|{{ARTICLESPACE}}}}}|[[:Category:Classes in {{{engine|{{ARTICLESPACE}}}}} package {{{package}}}|{{{package}}}]]|[[:Category:Classes in package {{{package}}}|{{{package}}}]]}}}}}}}}

Revision as of 17:42, 18 March 2008

Template interface Interface >> Infobox_interface
Known implementing classes
[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

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

Warning: Default sort key "Infobox interface" overrides earlier default sort key "Infobox interface UT3 UE3".