help.setPath

From ComputerCraft Wiki
Revision as of 21:07, 1 May 2015 by MKlegoman357 (Talk | contribs) (Fixed description, added an example)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Grid Redstone.png  Function help.setPath
Sets 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

Grid paper.png  Example
Sets the search path of the help API to /disk/help/. This replaces the original help lookup path.
Code
help.setPath( "/disk/help/" )



Grid paper.png  Example
Adds /myfolder/help/ path to the current help path.
Code
help.setPath( help.path() .. ":/myfolder/help/" )