View source for Template:Method/doc

{{Documentation subpage}}
This template is used to document methods. It should only be used to document methods that are part of the ROBLOX API and should <strong>never</strong> be used to document functions or anything that isn't a method.
== Usage ==
 <only<nowiki></nowiki>include>{{Method
 |name='''name'''
 |description='''description'''
 [|arguments='''arguments''']
 [|returns='''types''']
 [|protected='''bool''']
 [|object='''object''']
 [|objects='''objects''']
 <nowiki>}}</only</nowiki>include>

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 method.
;arguments
: The arguments received by the method. See the section on [[#arguments|arguments]] for more info on arguments.
;returns
: The <em>types</em> of the values returned by the function. Do not give them a name, only give their type. If they can be confusing, explain them in the description. If this argument is not specified, it will be indicated that the method does not return anything.
;description
: A description of the method.
;protected
: If specified, the icon of the method will indicate that the method is protected.
;object
: The name of the object this method belongs to, if there is only one. Otherwise, use the objects argument.
;objects
: Links to the objects this method belongs to, if there are more than one. Otherwise, use the object argument.
== Arguments ==
Arguments should be separated by commas. Their type should <strong>always</strong> be written before their name and should <strong>always</strong> be identical to the one written in the object browser, the only exception being if the error messages given by the method specify a more specific type. The type should either be in raw text, either be a link to the page of the type or either be displayed with the {{Tl|type}} template. The name should always either be contained in a {{Tag|var}} tag, which is preferrable, either be italicized with wiki markup.

Default values for arguments should be indicated outside of the {{Tag|var}} or outside of the italicization and be indicated the same way as they are in the object browser.
== Notes ==
* The method should always be at the top of the page.
* If you need to put things after the method, make sure to use the {{tl|clear floats}} template between the method and the rest of the page.
* All methods should be categorized under the [[:Category:Methods|Methods]] category.
== Example ==
This is an example of an use of this template with the [[FindFirstChild]] method:
 <nowiki>{{Method</nowiki>
 <nowiki>|name        = FindFirstChild</nowiki>
 <nowiki>|arguments   = {{Type|string}} <var>name</var>, {{Type|bool}} <var>recursive</var> = false</nowiki>
 <nowiki>|returns     = {{Type|instance=Instance}}</nowiki>
 <nowiki>|description = Returns the first child of this Instance that matches the first argument <var>name</var>. The second argument <var>recursive</var> is an optional boolean (defaults to {{false}}) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the <var>name</var> argument. The function will return {{nil}} if no Instance is found.</nowiki>
 <nowiki>|object      = Instance</nowiki>
 <nowiki>}}</nowiki>
Here is the result it would produce:
{{Method
|name        = FindFirstChild
|arguments   = {{Type|string}} <var>name</var>, {{Type|bool}} <var>recursive</var> = false
|returns     = {{Type|instance=Instance}}
|description = Returns the first child of this Instance that matches the first argument <var>name</var>. The second argument <var>recursive</var> is an optional boolean (defaults to {{False}}) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the <var>name</var> argument. The function will return {{Nil}} if no Instance is found.
|object      = Instance
}}
<includeonly>
[[Category:Templates]]
</includeonly>