Template:Object: Difference between revisions
>NXTBoy No edit summary |
>JulienDethurens Why are we even keeping the old object documentation pages? |
||
| (38 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<!--<table class="object-data collapsible autocollapse sortable wikitable objectlist" style="width: auto; height: auto; float: none; margin: 4px 0px;{{{2|}}}">--><table class="object-data collapsible autocollapse sortable wikitable objectlist" style="{{{ | <includeonly><!-- | ||
<tr> | OLDER CODE: | ||
<th class="unsortable" style="width:60px"> | |||
<th>[[ | <table class="object-data collapsible autocollapse sortable wikitable objectlist" style="width: auto; height: auto; float: none; margin: 4px 0px;{{{2|}}}"> | ||
--><table class="object-data collapsible autocollapse sortable wikitable objectlist" style="{{{3|}}}"> | |||
<tr style="background-color: #ffcccc"> | |||
<th class="unsortable" style="width:60px">{{Object/image|{{{1|Instance}}}}}</th> | |||
<th>[[{{{1|Instance}}}]] {{ifeq|{{superclass|{{{1|Instance}}}}}|no=<small style="font-weight: normal">(extends [[RBX.lua.{{superclass|{{{1|Instance}}}}} (Object)|{{superclass|{{{1|Instance}}}}}]])</small>}}</th> | |||
</tr> | </tr> | ||
{{Members|{{{1|Instance}}}|methods|row}} | {{Members|{{{1|Instance}}}|methods|row}} | ||
{{Members|{{{1|Instance}}}|properties|row}} | {{Members|{{{1|Instance}}}|properties|row}} | ||
{{Members|{{{1|Instance}}}|events|row}} | {{Members|{{{1|Instance}}}|events|row}} | ||
</table><noinclude>[[Category:Templates]]</noinclude> | </table></includeonly><noinclude>{{Object/doc}}[[Category:Templates]]</noinclude> | ||
Latest revision as of 19:48, 5 May 2012
This template is used for documenting object classes. This template will require setting four or less subpages, depending on your object. The four subpages that you can set are:
- /superclass (This is for the class that your object inherits)
- /methods (These hold all of the methods that originate from your object)
- /properties (These hold all of the properties that originate from your object)
- /events (These hold all of the events that originate from your object)
How to use the template
The template that we are using has three arguments. These arguments are shown below with the template:
{{Object|classname|object or service|style}}
For example, look at the following code:
{{Object|Instance}}
would generate
providing that the four subpages are set properly.
How do I set the four subpages?
Superclass
This page is simply just the classname of the object this object inherits. For example, the superclass of Part would be BasePart.
Methods
This page is for all of the methods that originate from this object. They have to be set specifically according to the code above.
Properties
This page is for all of the methods that originate from this object. Like methods, they have to be set specifically according to the code above.
Events
This page is for all of the methods that originate from this object. They too have to be set specifically according to the code above.
Why use this template?
This template is useful for a lot of reasons. It cuts down on code. You can produce many objects in less time if you set the pages correctly and properly. Finally, the code is easy to understand.
