Template:Lua function

From Official DarkRP Wiki
Jump to navigation Jump to search
Function
Function name Lua function()
Description:
No description provided
Returns: nil
Realm: NewerMissing.png
BBCode Link: [b][url=http://wiki.darkrp.com/index.php?title=Template:Lua function]Template:Lua function[/url][/b]

Example Usage

{{Lua_function |
	function_name	= concommand.Add |
	arguments	= {{Arg|String}} commandName, {{Arg|Function}} commandFunction, {{Arg|Function}}:{{Arg|Table}}:{{Arg|String}} autoCompleteFunc |
	description	= Creates a console command that runs a function in Lua. autoCompleteFunc is optional. |
	deprecated	= Message to display (only supply if the function is deprecated) |
	library		= {{Type|concommand}} |
	lua_state	= {{Shared}} |
	returns		= {{Arg|Nil}} |
        const           = any value if no arguments and brackets are required |
}}
  • Note that when a function returns nothing you should simply omit the returns field altogether, this is only included for your convenience as part of the example.