Difference between revisions of "Help (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Add return column, use type template, and update descriptions)
(Removed unnecessary duplicate table code on bottom)
Line 24: Line 24:
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.topics]]()</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.topics]]()</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a list of all available help topics.</td></tr>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a list of all available help topics.</td></tr>
 
  
 
</table>
 
</table>
Line 30: Line 29:
  
 
[[Category:APIs]]
 
[[Category:APIs]]
td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the list of locations the API will look in for help files.
 

Revision as of 15:53, 2 May 2013

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.