Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
api [2016/06/17 05:43]
payonel [Standard Libraries] 		api [2017/08/12 14:40] (current)
guard13007 [Custom Libraries] guid was renamed to uuid
Line 26: Line 26:
   * [[api:​non-standard-lua-libs#​table_manipulation|table]]   * [[api:​non-standard-lua-libs#​table_manipulation|table]]
  
-Note that you now need to `require` all non-standard APIs (including the ones below) ​before you use them, i.e. all modules not listed in the [[http://​www.lua.org/​manual/​5.2/​manual.html|Lua reference manual]]. +Custom Libraries 
-For example, instead of simple going `local rs = component.redstone`,​ you now need to require the component API, like so:+---------------- 
 + 
 +Following is a description of the non-standard libraries, provided for convenience. 
 + 
 +Note that you need to `require` all non-standard APIs before you use them, i.e. all modules not listed in the [[http://​www.lua.org/​manual/​5.3/​manual.html|Lua reference manual]] nor in [#​standard_libraries]. For example, instead of simple going `local rs = component.redstone`,​ you now need to require the component API, like so:
  
 ```lua ```lua
Line 37: Line 41:
 local rs = mycomp.redstone local rs = mycomp.redstone
 ``` ```
-The same applies for all other APIs listed below (even Sides and Colors). +The same applies for all other APIs listed below (even `sides` ​and `colors`).
- +
-Custom Libraries +
-----------------+
  
 The standard libraries aside, OpenComputers comes with a couple of additional, built-in libraries. Here is a list of all these libraries. Note that some of these may not be usable depending on your configuration (HTTP) and context (Robot library on computers), but they'​ll still be there. The standard libraries aside, OpenComputers comes with a couple of additional, built-in libraries. Here is a list of all these libraries. Note that some of these may not be usable depending on your configuration (HTTP) and context (Robot library on computers), but they'​ll still be there.
  
-- [[api:​buffer|Buffer]]: a Lua `FILE*` API buffer implementation for wrapping streams. +- [[api:​buffer|buffer]]: a Lua `FILE*` API buffer implementation for wrapping streams. 
-- [[api:​colors|Colors]]: a global table that allows referencing standard Minecraft colors by name. +- [[api:​colors|colors]]: a global table that allows referencing standard Minecraft colors by name. 
-- [[api:​component|Component]]: look-up and management of components attached to the computer. +- [[api:​component|component]]: look-up and management of components attached to the computer. 
-- [[api:​computer|Computer]]: information on and interactions with the computer the Lua state is running on. +- [[api:​computer|computer]]: information on and interactions with the computer the Lua state is running on. 
-- [[api:​event|Event]]: an event system, often used by libraries, for pulling and registering handlers to signals. +- [[api:​event|event]]: an event system, often used by libraries, for pulling and registering handlers to signals. 
-- [[api:guid|GUID]]: creates long unique identifier strings in the common 8-4-4-4-12 format. +- [[api:uuid|uuid]]: creates long unique identifier strings in the common 8-4-4-4-12 format. 
-- [[api:​fileSystem|FileSystem]]: abstracted interaction with file system components. +- [[api:​fileSystem|filesystem]]: abstracted interaction with file system components. 
-- [[api:​internet|Internet]]: a wrapper for Internet Card functionality. +- [[api:​internet|internet]]: a wrapper for Internet Card functionality. 
-- [[api:​keyboard|Keyboard]]: a table of key codes by name and pressed key tracking. +- [[api:​keyboard|keyboard]]: a table of key codes by name and pressed key tracking. 
-- [[api:note|Note]]: converts music notes between their real name, their MIDI code and their frequency +- [[api:note|note]]: converts music notes between their real name, their MIDI code and their frequency 
-- [[api:package|Package]]: provides cached libraries and special loading. +- [[api:process|process]]: keeps track of running programs and their environments. 
-- [[api:process|Process]]: keeps track of running programs and their environments. +- [[api:rc|rc]]: provides automatic program execution and service management. 
-- [[api:rc|RC]]: provides automatic program execution and service management. +- [[api:​robot|robot]]: abstracted access to robot actions. 
-- [[api:​robot|Robot]]: abstracted access to robot actions. +- [[api:​serialization|serialization]]: allows serialization of values, e.g. for sending them via the network. 
-- [[api:​serialization|Serialization]]: allows serialization of values, e.g. for sending them via the network. +- [[api:​shell|shell]]: working path tracking and program execution. 
-- [[api:​shell|Shell]]: working path tracking and program execution. +- [[api:​sides|sides]]: a global table that allows referencing sides by name. 
-- [[api:​sides|Sides]]: a global table that allows referencing sides by name. +- [[api:term|term]]: provides the concept of the cursor, to read and write from keyboard input and screen output, respectively. 
-- [[api:term|Term]]: provides the concept of the cursor, to read and write from keyboard input and screen output, respectively. +- [[api:text|text]]: provides text utilities such as tab to space conversion. 
-- [[api:text|Text]]: provides text utilities such as tab to space conversion. +- [[api:​thread|thread]]:​ provides autonomous and non-blocking cooperative threads. 
-- [[api:​transforms|Transforms]]: provides helpful and advanced table manipulators. +- [[api:​transforms|transforms]]: provides helpful and advanced table manipulators. 
-- [[api:​unicode|Unicode]]: provides Unicode aware implementations of some functions in the string library.+- [[api:​unicode|unicode]]: provides Unicode aware implementations of some functions in the string library.