Help (API)

From ComputerCraft Wiki
Revision as of 19:53, 23 April 2013 by Hawk777 (Talk | contribs) (Add return column, use type template, and update descriptions)

Jump to: navigation, search

The Help API allows you to mess around with the help files.


Grid disk.png   Help (API)

ReturnMethod NameDescription
string path help.path() Returns the list of locations the API will look in for help files.
nil help.setPath(string path) Sets the list of locations the API will look in for help files.
string path, or nil help.lookup(string topic) Returns the path to the file containing the help page for topic, or nil if the topic cannot be found.
table topics help.topics() Returns a list of all available help topics.

td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the list of locations the API will look in for help files.