Difference between revisions of "Help.setPath"
From ComputerCraft Wiki
m (Moved to CAT:APIFunctions) |
(Update description and use type template) |
||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=help.setPath | |name=help.setPath | ||
| − | |args= | + | |args={{Type|string}} path |
|api=help | |api=help | ||
|addon=ComputerCraft | |addon=ComputerCraft | ||
| − | |desc= | + | |desc=Returns the list of locations the API will look in for help files. This should be a string containing one or more search paths separated by colons. |
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc=Sets the path of the help API to /disk/help | + | |desc=Sets the search path of the help API to /disk/help. |
|code=help.setPath("/disk/help") | |code=help.setPath("/disk/help") | ||
}} | }} | ||
Revision as of 19:53, 23 April 2013
 Function help.setPath | |
| Returns the list of locations the API will look in for help files. This should be a string containing one or more search paths separated by colons. | |
| Syntax | help.setPath(string path) |
| Returns | nil |
| Part of | ComputerCraft |
| API | help |
Examples
 Example | |
| Sets the search path of the help API to /disk/help. | |
| Code |
help.setPath("/disk/help")
|
