Difference between revisions of "Help (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Removed unnecessary duplicate table code on bottom)
(use API table template)
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;">
+
{{API table|Help|image=Grid disk.png|2=
−
<tr><td colspan="3" 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]]&nbsp;&nbsp;
+
−
Help (API)
+
−
</td></tr>
+
  
−
<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><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>
+
{{API table/row
 +
|[[help.path]]()|{{Type|string}} path
 +
|Returns the list of locations the API will look in for help files.
 +
|odd}}
  
−
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} path</td>
+
{{API table/row
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.path]]()</td>
+
|[[help.setPath]]({{type|string}} path)|{{Type|nil}}
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the list of locations the API will look in for help files.</td></tr>
+
|Sets the list of locations the API will look in for help files.
 +
|}}
  
−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
+
{{API table/row
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.setPath]]({{Type|string}} path)</td>
+
|[[help.lookup]]({{Type|string}} topic)|{{Type|string}}/{{type|nil}} path
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the list of locations the API will look in for help files.</td></tr>
+
|Returns the path to the file containing the help page for <var>topic</var>, or {{type|nil}} if the topic cannot be found.
 +
|odd}}
  
−
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} path, or [[nil]]</td>
+
{{API table/row
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[help.lookup]]({{Type|string}} topic)</td>
+
|[[help.topics]]()|{{Type|table}} topics
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the path to the file containing the help page for <var>topic</var>, or [[nil]] if the topic cannot be found.</td></tr>
+
|Returns a list of all available help topics.
 +
|}}
  
−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} 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>
+
−
 
+
−
</table>
+
  
  
 
[[Category:APIs]]
 
[[Category:APIs]]

Revision as of 21:33, 14 September 2013

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

Grid disk.png  Help (API)
Function Return values Description
help.path() string path Returns the list of locations the API will look in for help files.
help.setPath(string path) nil Sets the list of locations the API will look in for help files.
help.lookup(string topic) string/nil path Returns the path to the file containing the help page for topic, or nil if the topic cannot be found.
help.topics() table topics Returns a list of all available help topics.
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Help_(API)&oldid=5999"