Difference between revisions of "Help (API)"
From ComputerCraft Wiki
m (moved HELP to Help (API)) |
Scarfacial (Talk | contribs) |
||
| Line 6: | Line 6: | ||
!style="background:#EEE" width="*"|Description | !style="background:#EEE" width="*"|Description | ||
|- | |- | ||
| − | |help. | + | |[[help.path|path]]() |
| − | | | + | |Returns the path the help api has been set to |
|- | |- | ||
| − | |help. | + | |[[help.setPath|setPath]]([[string (type)|string]] path ) |
| − | | | + | |Sets the path of the api to ''path'' |
|- | |- | ||
| − | |help.topics() | + | |[[help.lookup|lookup]]([[string (type)|string]] topic ) |
| − | | | + | |Looks up the help file for ''topic'' |
| + | |- | ||
| + | |[[help.topics|topic]]() | ||
| + | |Returns a table of valid help topics | ||
|} | |} | ||
[[Category:APIs]] | [[Category:APIs]] | ||
Revision as of 03:56, 27 February 2012
The Help API allows you to mess around with the help files.
Its functions are:
| Method name | Description |
|---|---|
| path() | Returns the path the help api has been set to |
| setPath(string path ) | Sets the path of the api to path |
| lookup(string topic ) | Looks up the help file for topic |
| topic() | Returns a table of valid help topics |
