User:ArceusInator/Template:Function

From Legacy Roblox Wiki
Revision as of 03:38, 23 March 2011 by >ArceusInator (what a function template may be like)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
[[{{{name}}} (Method)|{{{name}}}]]( {{{arguments}}} )
Returns {{{returns}}}
Description: {{{description}}}
Type: Ifeq}}|}

Example Usage

This template has these properties:

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

These are the types that are used with the "type" property:

core
coroutine
string
table
math
roblox

Anything else acts as if it were set to "roblox"

Function

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

Results in


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