Difference between revisions of "Help.topics"
From ComputerCraft Wiki
Scarfacial (Talk | contribs) (Created page with "{{lowercase}} {{Function |name=help.path |args= |api=help |returns=table all valid topics |addon=ComputerCraft |examples= {{Example |desc=Lists all valid help topics |code...") |
Smiley43210 (Talk | contribs) m (Corrected grammar) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{lowercase}} | {{lowercase}} | ||
{{Function | {{Function | ||
| − | |name=help. | + | |name=help.topics |
| − | + | ||
|api=help | |api=help | ||
| − | |returns= | + | |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. | ||
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc=Lists all valid help topics | + | |desc=Lists all valid help topics. |
| − | |code=for | + | |code=for _, v in ipairs(help.topics()) do |
| + | print(v) | ||
| + | end | ||
|output=List of all valid help topics | |output=List of all valid help topics | ||
}} | }} | ||
}} | }} | ||
| + | |||
| + | [[Category:API_Functions]] | ||
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 |
