Difference between revisions of "Help (API)"
From ComputerCraft Wiki
(Fix a bit more formatting) |
m (→Methods fix.) |
||
| Line 6: | Line 6: | ||
!style="background:#EEE" width="*"|Description | !style="background:#EEE" width="*"|Description | ||
|- | |- | ||
| − | |[[help. | + | |[[help.path]]() |
|Returns the path the help API has been set to | |Returns the path the help API has been set to | ||
|- | |- | ||
| − | |[[help. | + | |[[help.setPath]]([[string (type)|string]] path) |
|Sets the path of the API to ''path'' | |Sets the path of the API to ''path'' | ||
|- | |- | ||
| − | |[[help. | + | |[[help.lookup]]([[string (type)|string]] topic) |
|Looks up the help file for ''topic'' | |Looks up the help file for ''topic'' | ||
|- | |- | ||
| − | |[[help.topics | + | |[[help.topics]]() |
|Returns a table of valid help topics | |Returns a table of valid help topics | ||
|} | |} | ||
[[Category:APIs]] | [[Category:APIs]] | ||
Revision as of 08:29, 25 November 2012
The Help API allows you to mess around with the help files.
Methods
| Method name | Description |
|---|---|
| help.path() | Returns the path the help API has been set to |
| help.setPath(string path) | Sets the path of the API to path |
| help.lookup(string topic) | Looks up the help file for topic |
| help.topics() | Returns a table of valid help topics |
