User:ArceusInator/Template:Function: Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>ArceusInator
No edit summary
>ArceusInator
No edit summary
 
(6 intermediate revisions by the same user not shown)
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;"|Type:
|style="width: 10%; border-top: solid 1px black; border-right: solid 1px black; font-weight:bold;"|Type:
|style="border-top: solid 1px black;"|{{Ifeq|{{{type}}}|core|[[Function_Dump/Core_Functions|Core Function]]|{{Ifeq|{{{type}}}|coroutine|[[Function_Dump/Coroutine_Manipulation|Coroutine Function]]|{{Ifeq|{{{type}}}|string|[[String Function]]|{{Ifeq|{{{type}}}|table|[[Function_Dump/Table_Manipulation|Table Function]]|{{Ifeq|{{{type}}}|math|[[Function_Dump/Mathematical_Functions|Mathematical Function]]|[[Function_Dump/Roblox_Specific_Functions|Roblox Specific Function]]}}}}}}}}}}</div>
|style="border-top: solid 1px black;"|
{{Ifeq|{{{type}}}|core|[[Function_Dump/Core_Functions|Core Function]]|
{{Ifeq|{{{type}}}|coroutine|[[Function_Dump/Coroutine_Manipulation|Coroutine Function]]|
{{Ifeq|{{{type}}}|string|[[Function_Dump/String_Manipulation|String Function]]|
{{Ifeq|{{{type}}}|table|[[Function_Dump/Table_Manipulation|Table Function]]|
{{Ifeq|{{{type}}}|math|[[Function_Dump/Mathematical_Functions|Mathematical Function]]|
[[Function_Dump/Roblox_Specific_Functions|Roblox Specific Function]]
}}
}}
}}
}}
}}
|}</div><noinclude>{{clear floats}}
 
==Example Usage==
 
The following properties are valid:<pre>
property      : Value = Default
 
name          : String
description    : String
arguments      : String
returns        : String = nil
protected      : Boolean = false
type          : Type = roblox
 
Here's a list of inputs the "type" property can accept:
 
core
coroutine
math
string
table
roblox
 
Anything else will be treated as if it were roblox.</pre>
 
Here's what LoadLibrary may be written as:
 
<pre>
{{User:ArceusInator/Template:Function
|name = LoadLibrary
|arguments = [[String]] ''libraryName''
|returns = [[Userdata]]
|description = Returns a library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function.}}
</pre>
 
this would result in:
 
 
{{User:ArceusInator/Template:Function
|name = LoadLibrary
|arguments = [[String]] ''libraryName''
|returns = [[Userdata]]
|description = Returns a library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function.}}
 
</noinclude>

Latest revision as of 03:58, 23 March 2011

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

Roblox Specific Function


Example Usage

The following properties are valid:

property       : Value = Default

name           : String
description    : String
arguments      : String
returns        : String = nil
protected      : Boolean = false
type           : Type = roblox

Here's a list of inputs the "type" property can accept:

core
coroutine
math
string
table
roblox

Anything else will be treated as if it were roblox.

Here's what LoadLibrary may be written as:

{{User:ArceusInator/Template:Function
|name = LoadLibrary
|arguments = [[String]] ''libraryName''
|returns = [[Userdata]]
|description = Returns a library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function.}} 

this would result in:


LoadLibrary( String libraryName )
Returns Userdata
Description: Returns a library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function.
Type:

Roblox Specific Function