Difference between revisions of "Area 51"

Revision as of 14:38, 17 May 2021

This page is for the development of documentation for Lua API functions that are currently being worked on. Ideally the entries here can be created in the same format as will be eventually used in Lua Functions and its sub-sites.

Please use the Area_51_documentation/Template to add new entries in the sections below.

The following headings reflect those present in the main Wiki area of the Lua API functions. It is suggested that new entries are added so as to maintain a sorted alphabetical order under the appropriate heading.

Basic Essential Functions

These functions are generic functions used in normal scripting. These deal with mainly everyday things, like sending stuff and echoing to the screen.

Database Functions

A collection of functions for helping deal with the database.

Date/Time Functions

A collection of functions for handling date & time.

File System Functions

A collection of functions for interacting with the file system.

Mapper Functions

A collection of functions that manipulate the mapper and its related features.

Miscellaneous Functions

Miscellaneous functions.

Scripting Object Functions

A collection of arrows that manipulate Mudlets scripting objects - triggers, aliases, and so forth.

Networking Functions

A collection of functions for managing networking.

String Functions

These functions are used to manipulate strings.

Table Functions

These functions are used to manipulate tables. Through them you can add to tables, remove values, check if a value is present in the table, check the size of a table, and more.

Text to Speech Functions

These functions are used to create sound from written words. Check out our Text-To-Speech Manual for more detail on how this all works together.

UI Functions

These functions are used to construct custom user GUIs. They deal mainly with miniconsole/label/gauge creation and manipulation as well as displaying or formatting information on the screen.

@@ Line 1: / Line 1: @@
-This page is for the development of documentation for Lua API functions that are currently being worked on. Ideally the entries here can be created in the same format as will be eventually used in [[Manual:Lua_Functions|Lua Functions]]. There is a heavily commented (as Lua comments that won't work on a Wiki page!) ''template'' included here as a HTML comment that can be copied and pasted and used as a framework for a new entry;  it probably does not cover every eventuality but I guess we can discuss revisions on the discussion page. --[[User:Slysven|slysven]] ([[User talk:Slysven|talk]]) 22:32, 12 May 2021 (UTC)
+{{TOC right}}
-<!-- You can copy the following, remembering to generally strip out the explanatory comments put in here!
+This page is for the development of documentation for Lua API functions that are currently being worked on. Ideally the entries here can be created in the same format as will be eventually used in [[Manual:Lua_Functions|Lua Functions]] and its sub-sites.
-==function==
-;function(argument1[, optional argument 2])
--- the above first line will get scraped to form the auto completion text in the editor - so it should, ideally show all the arguments in all their form - though this may be awkward to do and a better method when there are significant alternative forms is still to be found.
-:Description of what this function will do.
+Please use the [[Area_51_documentation/Template]] to add new entries in the sections below.
-;Parameters
+The following headings reflect those present in the main Wiki area of the Lua API functions. It is suggested that new entries are added so as to maintain a sorted alphabetical order under the appropriate heading.
-* ''argument1:''
-: Type and description of this argument.
-* ''arguement2:''
-: Type and description of this argument..
-* ''toID:''
-: See also: [[#internalLinkWithNoSpacesToOtherRelatedFunction1|displayed name of related function1 with braces but no indication of arguments()]], [[#internalLinkToOtherRelatedFunction2|displayed name of related function2()]]
-;Example
-<syntaxhighlight lang="lua">
--- a comment explaining what is going on, if there is multiple functionalities (or optional arguments) the examples should start simple and progress in complexity if needed!
-local something = function(argument1)
-if something then
-  -- do something with something (assuming there is a meaningful return value)
-end
-</syntaxhighlight>
--- If the version when the functionality is to be introduced is know it should be given using this (assuming a major.minor.patch version number - though a major.minor format may be sufficient:
-{{MudletVersion|0.0.1}}
-=== Additional development notes ===
--- not for inclusion when item transferred to final location, could include revisions or input from others - it would be a good idea to use the ''signature with timestamp'' if commenting on other peoples stuff - i.e two hyphens '-' followed by four tildes '~'...
--->
-The following headings (under the following ''table of contents'') reflect those present in the main Wiki area of the Lua API functions, it is suggested that new entries are added so as to maintain a sorted alphabetical order under the appropriate heading.
 ===Basic Essential Functions===