Difference between revisions of "Help.lookup"
From ComputerCraft Wiki
m (Moved to CAT:APIFunctions) |
(Update description and use type template) |
||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=help.lookup | |name=help.lookup | ||
| − | |args= | + | |args={{Type|string}} topic |
|api=help | |api=help | ||
| − | |returns= | + | |returns={{Type|string}} path of help file for <var>topic</var> or [[nil]] |
|addon=ComputerCraft | |addon=ComputerCraft | ||
| − | |desc= | + | |desc=Returns the path to the file containing the help page for <var>topic</var>, or [[nil]] if the topic cannot be found. Each element of the string returned by [[help.path]] is searched, in order, for a file named <var>topic</var>. |
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc=Looks up the path for the disk | + | |desc=Looks up the path for help on the disk API. |
|code=print(help.lookup("disk")) | |code=print(help.lookup("disk")) | ||
|output=/rom/help/disk | |output=/rom/help/disk | ||
Latest revision as of 19:53, 23 April 2013
 Function help.lookup | |
| Returns the path to the file containing the help page for topic, or nil if the topic cannot be found. Each element of the string returned by help.path is searched, in order, for a file named topic. | |
| Syntax | help.lookup(string topic) |
| Returns | string path of help file for topic or nil |
| Part of | ComputerCraft |
| API | help |
Examples
 Example | |
| Looks up the path for help on the disk API. | |
| Code |
print(help.lookup("disk"))
|
| Output | /rom/help/disk |
