Difference between revisions of "Shell (API)"
From ComputerCraft Wiki
m (Added NeedsWork note) |
(Added shell.switchTab and shell.openTab) |
||
| Line 49: | Line 49: | ||
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.getRunningProgram]]()</td> | <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.getRunningProgram]]()</td> | ||
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the absolute path to the currently-executing program.</td></tr> | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the absolute path to the currently-executing program.</td></tr> | ||
| + | |||
| + | <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.openTab]]({{type|string}} program, {{type|string}} arguments)</td> | ||
| + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs a program in another [[multishell]] tab. ''Requires version 1.6 or newer and an advanced computer.''</td></tr> | ||
| + | |||
| + | <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.switchTab]]({{type|number}} tab ID)</td> | ||
| + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Switches the [[multishell]] tab to tab with the given ID. ''Requires version 1.6 or newer and an advanced computer.''</td></tr> | ||
</table> | </table> | ||
[[Category:APIs]] | [[Category:APIs]] | ||
Revision as of 11:13, 28 March 2014
| This page needs some serious TLC, stat! Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: New 1.6 functions and changes should be added. - Oeed 06:02, 28 March 2014 (GMT)) |
The shell API allows you to interface with the shell.
| Method Name | Description |
| shell.exit() | Exits the current shell |
| shell.dir() | Returns the directory |
| shell.setDir(string path) | Sets the directory |
| shell.path() | Returns the path |
| shell.setPath(string path) | Sets the path |
| shell.resolve(string localpath) | Resolves a local path to an absolute path. |
| shell.resolveProgram(string name) | Resolves the absolute path to the program whose name you provided. |
| shell.aliases() | Returns aliases. |
| shell.setAlias(string alias, string program) | Sets an alias. |
| shell.clearAlias(string alias) | Clears an alias. |
| shell.programs([boolean hidden]) | Returns a table of programs. |
| shell.run(string program, string arguments) | Runs a program. |
| shell.getRunningProgram() | Returns the absolute path to the currently-executing program. |
| shell.openTab(string program, string arguments) | Runs a program in another multishell tab. Requires version 1.6 or newer and an advanced computer. |
| shell.switchTab(number tab ID) | Switches the multishell tab to tab with the given ID. Requires version 1.6 or newer and an advanced computer. |