User:ArceusInator/Template:Function: Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>ArceusInator
No edit summary
>ArceusInator
No edit summary
Line 1: Line 1:
<onlyinclude><div style="float:left; padding:2px; width:600px; height:150px; overflow:auto; margin:2px;">
<div style="float:left; padding:2px; width:600px; height:150px; overflow:auto; margin:2px;">
{| cellspacing="0" cellpadding="4" style="-webkit-border-radius: 6px; -moz-border-radius: 6px; background: #ffdddd; margin:0; width: 100%; font-size: 90%; text-align: left; align: center; padding: 4px; border: solid 4px #B57EDC;"
{| cellspacing="0" cellpadding="4" style="-webkit-border-radius: 6px; -moz-border-radius: 6px; background: #ffdddd; margin:0; width: 100%; font-size: 90%; text-align: left; align: center; padding: 4px; border: solid 4px #B57EDC;"
|style="padding: 1;font-size:120%; font-weight:bold;" colspan="2"|[[Image:{{if|{{{protected|}}}|Protected_}}Method Icon.png]] [[{{{name}}} (Method)|{{{name}}}]]( {{{arguments<includeonly>|</includeonly>}}} )
|style="padding: 1;font-size:120%; font-weight:bold;" colspan="2"|[[Image:{{if|{{{protected|}}}|Protected_}}Method Icon.png]] [[{{{name}}} (Method)|{{{name}}}]]( {{{arguments<includeonly>|</includeonly>}}} )
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></onlyinclude><noinclude>{{clear floats}}
|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><noinclude>{{clear floats}}
== Example Usage ==
== Example Usage ==



Revision as of 03:40, 23 March 2011

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

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: Roblox Specific Function