Difference between revisions of "Help.topics"
From ComputerCraft Wiki
(Update description, reformat example and use ipairs to get sorted output, and use type template) |
Smiley43210 (Talk | contribs) m (Corrected grammar) |
||
| Line 3: | Line 3: | ||
|name=help.topics | |name=help.topics | ||
|api=help | |api=help | ||
| − | |returns={{Type|table}} all valid topics | + | |returns={{Type|table}} of all valid topics |
|addon=ComputerCraft | |addon=ComputerCraft | ||
|desc=Returns a list of all available help topics. This is all files found in the directories in the search path returned by [[help.path]]. The returned table is sorted. | |desc=Returns a list of all available help topics. This is all files found in the directories in the search path returned by [[help.path]]. The returned table is sorted. | ||
Latest revision as of 15:56, 2 May 2013
 Function help.topics | |
| Returns a list of all available help topics. This is all files found in the directories in the search path returned by help.path. The returned table is sorted. | |
| Syntax | help.topics() |
| Returns | table of all valid topics |
| Part of | ComputerCraft |
| API | help |
Examples
 Example | |
| Lists all valid help topics. | |
| Code |
for _, v in ipairs(help.topics()) do print(v) end |
| Output | List of all valid help topics |
