Template:Property: Difference between revisions
From Legacy Roblox Wiki
Jump to navigationJump to search
>JulienDethurens No edit summary |
>JulienDethurens No edit summary |
||
Line 1: | Line 1: | ||
<includeonly><onlyinclude><div style="float:left; max-width:600px; width: 50%; overflow:auto"> | <includeonly><onlyinclude><div style="float:left; max-width:600px; width: 50%; overflow:auto"> | ||
{| cellspacing="0" cellpadding="4" style="margin: 2px; display: block; {{border-radius|6px}}; background: {{color|blue}}; font-size: 90%; text-align: left; border: 4px solid {{color|blue|dark}};" | {| cellspacing="0" cellpadding="4" style="margin: 2px; display: block; {{border-radius|6px}}; background: {{color|blue}}; font-size: 90%; text-align: left; border: 4px solid {{color|blue|dark}};" | ||
Line 44: | Line 11: | ||
|style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold; border-bottom: solid 1px {{color|blue|dark}};"|Member of | |style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold; border-bottom: solid 1px {{color|blue|dark}};"|Member of | ||
|style="border-bottom: solid 1px {{color|blue|dark}}; border-top: solid 1px {{color|blue|dark}};"|{{if|{{{object|}}}|[[RBX.lua.{{{object|}}} (Object)|{{{object|}}}]]|{{{objects|}}}}} | |style="border-bottom: solid 1px {{color|blue|dark}}; border-top: solid 1px {{color|blue|dark}};"|{{if|{{{object|}}}|[[RBX.lua.{{{object|}}} (Object)|{{{object|}}}]]|{{{objects|}}}}} | ||
|}</div></onlyinclude></includeonly> | |}</div></onlyinclude></includeonly><noinclude>{{documentation}}</noinclude> |
Revision as of 23:39, 7 April 2012
This template is used to document properties. It should only be used to document properties that are part of the ROBLOX API.
Usage
<onlyinclude>{{Property |name=name |type=type |description=description [|protected=bool] [|object=object] [|objects=objects] }}</onlyinclude>
Note: text between brackets ([ and ]) is optional, text in bold represents a certain value (something you must replace) and the rest represents things that must be present as-is.
Parameters
- name
- The name of the property.
- type
- The type of the property. Should be either a link to the page of the type, either be displayed through the {{type}} template.
- description
- A description of the property.
- protected
- If specified, the icon of the property will indicate that the property is protected.
- object
- The name of the object this property belongs to, if there is only one. Otherwise, use the objects argument.
- objects
- Links to the objects this property belongs to, if there are more than one. Otherwise, use the object argument.
Notes
- The property should always be at the top of the page.
- If you need to put things after the property, make sure to use the {{clear floats}} template between the property and the rest of the page.
- All properties should be categorized under the Properties category.