Bomb Bloke: Created page with "{{lowercase}} {{Function |name=shell.getCompletionInfo |returns={{Type|table}} completion function info |api=shell |addon=ComputerCraft |desc=Added by ComputerCraft 1.74, shel..."

2015-08-02T00:34:48Z

Created page with "{{lowercase}} {{Function |name=shell.getCompletionInfo |returns={{Type|table}} completion function info |api=shell |addon=ComputerCraft |desc=Added by ComputerCraft 1.74, shel..."

New page

{{lowercase}}
{{Function
|name=shell.getCompletionInfo
|returns={{Type|table}} completion function info
|api=shell
|addon=ComputerCraft
|desc=Added by ComputerCraft 1.74, shell.getCompletionInfo() returns a pointer to the table tracking completion functions set using [[shell.setCompletionFunction]]().

Within the table are keys named after the programs that've been registered. These lead to sub-tables, with "fnComplete" keys which point to the registered functions. Note that the returned pointer leads to the original table, and not a copy, meaning that manipulating it will directly affect the [[shell.complete]]() function which relies upon it.

See also: [[textutils.complete]](), [[shell.complete]](), [[shell.completeProgram]](), [[shell.setCompletionFunction]](), [[fs.complete]]() and [[help.completeTopic]]().
|examples=
{{Example
|desc=Returns the table containing function info for the current set of registered scripts.
|code=
shell.getCompletionInfo()
|output=A table formatted along these lines:
{
["rom/programs/help"] = { ["fnComplete"] = <function> },
["rom/programs/cd"] = { ["fnComplete"] = <function> },
["rom/programs/gps"] = { ["fnComplete"] = <function> },
-- etc
}

The paths defined by default are set by [https://github.com/alekso56/ComputercraftLua/blob/master/rom/startup the startup file in the rom directory].
}}
}}

[[Category:API_Functions]]

Shell.getCompletionInfo - Revision history

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=shell.getCompletionInfo |returns={{Type|table}} completion function info |api=shell |addon=ComputerCraft |desc=Added by ComputerCraft 1.74, shel..."