Difference between revisions of "Help.path"
From ComputerCraft Wiki
Scarfacial (Talk | contribs) (Created page with "{{lowercase}} {{Function |name=help.path |args= |api=help |returns=string path of help API |addon=ComputerCraft |examples= {{Example |desc=Prints the current...") |
(Update description and use type template) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=help.path | |name=help.path | ||
| − | |||
|api=help | |api=help | ||
| − | |returns= | + | |returns={{Type|string}} the path list, separated by colons |
|addon=ComputerCraft | |addon=ComputerCraft | ||
| + | |desc=Returns the list of locations the API will look in for help files. This is returned in the form of a string containing multiple search paths separated by colons. | ||
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc=Prints the current path for the help API | + | |desc=Prints the current path list for the help API. |
|code=print(help.path()) | |code=print(help.path()) | ||
|output=/rom/help | |output=/rom/help | ||
}} | }} | ||
}} | }} | ||
| + | |||
| + | [[Category:API_Functions]] | ||
Latest revision as of 19:53, 23 April 2013
 Function help.path | |
| Returns the list of locations the API will look in for help files. This is returned in the form of a string containing multiple search paths separated by colons. | |
| Syntax | help.path() |
| Returns | string the path list, separated by colons |
| Part of | ComputerCraft |
| API | help |
Examples
 Example | |
| Prints the current path list for the help API. | |
| Code |
print(help.path()) |
| Output | /rom/help |
