Difference between revisions of "Help (API)"
From ComputerCraft Wiki
m (→Methods fix.) |
(Updated to API overview v2) |
||
| Line 1: | Line 1: | ||
The Help API allows you to mess around with the help files. | The Help API allows you to mess around with the help files. | ||
| − | = | + | <table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"> |
| − | + | <tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;"> | |
| − | + | [[File:Grid_disk.png|24px]] | |
| − | + | Help (API) | |
| − | + | </td></tr> | |
| − | + | ||
| − | + | <tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr> | |
| − | + | ||
| − | + | <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.path]]()</td> | |
| − | + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the path the help API has been set to </td></tr> | |
| − | + | ||
| − | + | <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.setPath]]([[string (type)|string]] path)</td> | |
| − | + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the path of the API to ''path''</td></tr> | |
| − | + | ||
| − | + | <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.lookup]]([[string (type)|string]] topic)</td> | |
| − | + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Looks up the help file for ''topic''</td></tr> | |
| − | + | ||
| + | <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.topics]]()</td> | ||
| + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of valid help topics</td></tr> | ||
| + | |||
| + | |||
| + | </table> | ||
| + | |||
| + | |||
[[Category:APIs]] | [[Category:APIs]] | ||
Revision as of 22:11, 30 November 2012
The Help API allows you to mess around with the help files.
|
| |
| 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 |
