Template:Property: Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
>JulienDethurens
Fixed appearance. I agree it wasn't looking really that good.
>JulienDethurens
Added hidden category so we can find all of these quickly and correct them eventually, even though it isn't an emergency.
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<onlyinclude><div style="float:left; max-width:600px; width: 50%; overflow:auto">
{{if|{{{property|}}}|[[Category:Properties using the old property argument]]}}{{if|1={{{name<includeonly>|</includeonly>}}}|2={{if|1={{{type<includeonly>|</includeonly>}}}|2={{if|1={{{description<includeonly>|</includeonly>}}}|2=<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}};"
|style="padding: 1; font-size:120%; font-weight:bold;" colspan="2"|[[Image:{{if|{{{protected|}}}|Protected}}Property Icon.png]][[{{{name}}} (Property)|{{{name}}}]]
{{!}}style="padding: 1; font-size:120%; font-weight:bold;" colspan="2"{{!}}[[File:{{if|{{{protected|}}}|Protected}}Property Icon.png|link={{{name}}} (Property)]][[{{{name}}} (Property){{!}}{{{name}}}]]
|-style="background: {{color|blue|light}};"
{{!}}-style="background: {{color|blue|light}};"
|style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold;"|{{if|{{{property|}}}|Property|Type}}
{{!}}style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold;"{{!}}{{if|{{{type|}}}|Type|Property}}
|style="border-top: solid 1px {{color|blue|dark}};"|{{{property|{{{type|}}}}}}
{{!}}style="border-top: solid 1px {{color|blue|dark}};"{{!}}{{{type|{{{property|}}}}}}
|-
{{!}}-
|style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold;"|Description
{{!}}style="width: 10%; border-top: solid 1px {{color|blue|dark}}; border-right: solid 1px {{color|blue|dark}}; font-weight:bold;"{{!}}Description
|style="border-top: solid 1px {{color|blue|dark}};"|{{{description}}}
{{!}}style="border-top: solid 1px {{color|blue|dark}};"{{!}}{{{description}}}
|-style="background: {{color|blue|light}};"
{{!}}-style="background: {{color|blue|light}};"
|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|}}}|{{type|{{{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><noinclude>
{{!}}}</div></onlyinclude>|3=<p class="error">The description must be specified.</p>[[Category:Pages with template errors]]}}|3=<p class="error">The type must be specified.</p>[[Category:Pages with template errors]]}}|3=<p class="error">The name must be specified.</p>[[Category:Pages with template errors]]}}<noinclude>{{documentation}}[[Category:Object Documentation Templates]]</noinclude>
{{clear floats}}
 
== Example Usage ==
 
<pre>
{{Property
|name        = Name
|type       = String
|description = The name of the object.
|object      = Instance
}}
</pre>
 
{{Property
|name        = Name
|type        = String
|description = The name of the object.
|object      = Instance
}}
{{clear floats}}
<pre>
{{Property
|name        = Protected Property
|type        = ProtectedProperty
|description = A protected property that cannot be read or written from scripts.
|object      = NonExistantObject
|protected  = yes}}</pre>
 
{{Property
|name        = Protected Property
|type        = ProtectedProperty
|description = A protected property that cannot be read or written from scripts.
|object      = NonExistantObject
|protected  = yes}}
 
[[Category:Object Documentation Templates]]
</noinclude>

Latest revision as of 12:09, 26 April 2012

link={{{name}}} (Property)[[{{{name}}} (Property)|{{{name}}}]]
Property
Description {{{description}}}
Member of
[purge] Template documentation
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.
Retrieved from "https://rbxlegacy.wiki/index.php?title=Template:Property&oldid=66200"