Template:Method: Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>NXTBoy
Fixed
>JulienDethurens
No edit summary
Line 10: Line 10:
|-style="background: #FFFFFF;"
|-style="background: #FFFFFF;"
|style="width: 10%; border-top: solid 1px black; border-right: solid 1px black; font-weight:bold;"|In Object{{if|{{{object2|}}}|s}}:
|style="width: 10%; border-top: solid 1px black; border-right: solid 1px black; font-weight:bold;"|In Object{{if|{{{object2|}}}|s}}:
|style="border-top: solid 1px black;"|{{if|{{{object|}}}|[[RBX.lua.{{{object}}} (Object)|{{{object}}}]]}}{{if|{{{objects|}}}|{{{objects|}}}}}
|style="border-top: solid 1px black;"|{{if|{{{object|}}}|{{type|instance={{object|}}}}}}{{if|{{{objects|}}}|{{{objects|}}}}}
|}</div><noinclude>{{clear floats}}
|}</div><noinclude>{{clear floats}}
== Example Usage ==
== Example Usage ==
Line 18: Line 18:
{{Method
{{Method
|name                = FindFirstChild
|name                = FindFirstChild
|arguments            = [[string]] <var>name</var>, [[bool]] <var>recursive = false</var>
|arguments            = {{type|string}} <var>name</var>, {{type|bool}} <var>recursive = false</var>
|returns              = [[Instance]]
|returns              = {{Instance|Instance}}
|description          = Returns the first child found with a name of <var>name</var>. Returns [[nil]] if no such child exists. If the optional <var>recursive</var> argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
|description          = Returns the first child found with a name of <var>name</var>. Returns {{nil}} if no such child exists. If the optional <var>recursive</var> argument is {{true}}, will recursively descend the hierarchy while searching rather than only searching the immediate object.
|object              = Instance
|object              = Instance
}}
}}
Line 26: Line 26:


=== Multiple Objects ===
=== Multiple Objects ===
<pre>
<code>
{{Method
{{Method
|name                = BreakJoints
|name                = BreakJoints
|arguments            =  
|arguments            =  
|description          = Breaks any surface connection with any adjacent part, including [[RBX.lua.Weld (Object)|Welds]] and other [[RBX.lua.JointInstance (Object)|JointInstances]].
|description          = Breaks any surface connection with any adjacent {{type|instance=Part}}, including {{type|instance=Weld|Welds}} and other {{type|instance=JointInstance|JointInstances}}.
|objects              = [[RBX.lua.BasePart (Object)|BasePart]], [[RBX.lua.Model (Object)|Model]]
|objects              = {{type|instance=BasePart}}, {{type|instance=Model}}
}}
}}
</pre>
</code>
[[Category:Object Documentation Templates]]
[[Category:Object Documentation Templates]]
</noinclude>
</noinclude>

Revision as of 03:34, 15 February 2012

[[{{{name}}} (Method)|{{{name}}}]]( {{{arguments}}} )
Returns {{{returns}}}
Description: {{{description}}}
In Object:

Example Usage

Single Object

FindFirstChild( string name, bool recursive = false )
Returns Template:Instance
Description: Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
In Object: [[RBX.lua.
[[]]
(Object)|
[[]]
]]

Multiple Objects

BreakJoints( )
Returns nil
Description: Breaks any surface connection with any adjacent Part, including Welds and other JointInstances.
In Object: BasePart, Model