Multishell (API) - Revision history

MKlegoman357: Added argument to .getTitle

2014-04-10T13:39:12Z

Added argument to .getTitle

Bomb Bloke: Or rather, said program leaves part of itself loaded, as an API of sorts.

2014-04-10T11:15:11Z

Or rather, said program leaves part of itself loaded, as an API of sorts.

Oeed: moved Multishell (API) to Multishell: This is actually a program, not an API.

2014-03-28T22:20:17Z

moved Multishell (API) to Multishell: This is actually a program, not an API.

New page

#REDIRECT [[Multishell]]

@@ Line 14: / Line 14: @@
 {{API table/row
 |[[multishell.getCurrent]]()
-|{{type|number}} tab
+|{{type|number}} tabID
 |Returns the ID of the currently running tab.
 |odd}}
@@ Line 31: / Line 31: @@
 {{API table/row
-|[[multishell.setFocus]]({{type|number}} tab)
+|[[multishell.setFocus]]({{type|number}} tabID)
 |{{type|boolean}} success
 |Switches focus to the specified tab.
@@ Line 37: / Line 37: @@
 {{API table/row
-|[[multishell.setTitle]]({{type|number}} tab, {{type|string}} title)
+|[[multishell.setTitle]]({{type|number}} tabID, {{type|string}} title)
+|
 |Relabels the specified tab to use the specified title.
@@ Line 43: / Line 43: @@
 {{API table/row
-|[[multishell.getTitle]]()
+|[[multishell.getTitle]]({{type|number}} tabID)
 |{{type|string}} title
 |Returns the title of the specified tab.
@@ Line 50: / Line 50: @@
 {{API table/row
 |[[multishell.getFocus]]()
-|{{type|number}} tab
+|{{type|number}} tabID
 |Returns the ID of the currently focused tab.
 |odd}}

← Older revision		Revision as of 11:15, 10 April 2014
Line 1:		Line 1:
−	~~#REDIRECT~~ [[~~Multishell~~]]	+	{{lowercase}}
		+	Added by ComputerCraft 1.6, the '''Multishell API''' is used to manipulate tabs.
		+
		+	On boot, advanced systems will automatically launch the [[multishell\|multishell script]], which by default loads only a single tab running a standard shell ([[CraftOS]] or [[TurtleOS]]). Said script also loads a number of functions into memory to be used as an API by other scripts and/or functions, allowing them to add, switch between, or rename tabs.
		+
		+	Note that two related, higher-level commands are also available via the [[shell (API)\|shell API]] - [[shell.openTab\|shell.openTab()]] and [[shell.switchTab\|shell.switchTab()]].
		+
		+	Although this API isn't visible to the "apis" shell command, its existence (or lack thereof) provides an easy method to determine if a system has access to the multishell system (eg "if multishell then ...").
		+
		+	==API==
		+
		+	{{API table\|multishell\|image=Grid disk.png\|2=
		+
		+	{{API table/row
		+	\|[[multishell.getCurrent]]()
		+	\|{{type\|number}} tab
		+	\|Returns the ID of the currently running tab.
		+	\|odd}}
		+
		+	{{API table/row
		+	\|[[multishell.getCount]]()
		+	\|{{type\|number}} tabCount
		+	\|Returns the number of tabs currently being handled by the multishell system.
		+	}}
		+
		+	{{API table/row
		+	\|[[multishell.launch]]({{type\|table}} environment, {{type\|string}} program path [, {{type\|string}} arguments])
		+	\|{{type\|number}} newTabID
		+	\|Launches the specified script in a new tab.
		+	\|odd}}
		+
		+	{{API table/row
		+	\|[[multishell.setFocus]]({{type\|number}} tab)
		+	\|{{type\|boolean}} success
		+	\|Switches focus to the specified tab.
		+	}}
		+
		+	{{API table/row
		+	\|[[multishell.setTitle]]({{type\|number}} tab, {{type\|string}} title)
		+	\|
		+	\|Relabels the specified tab to use the specified title.
		+	\|odd}}
		+
		+	{{API table/row
		+	\|[[multishell.getTitle]]()
		+	\|{{type\|string}} title
		+	\|Returns the title of the specified tab.
		+	}}
		+
		+	{{API table/row
		+	\|[[multishell.getFocus]]()
		+	\|{{type\|number}} tab
		+	\|Returns the ID of the currently focused tab.
		+	\|odd}}
		+	}}
		+
		+	[[Category:APIs]]