Shell

Methods
1
Fields
None

Getting one

Shell

Methods

MethodReturnsDescription
open(string?)()Open this plugin's Luau shell, or bring it forward with the caret in its editor when it is open already. One shell per plugin, titled with…

Method details

open

open: (string?) -> ()

Open this plugin's Luau shell, or bring it forward with the caret in its editor when it is open already. One shell per plugin, titled with the plugin's id and then title (or "Shell"): a script editor that completes this API, over a console. Run (Ctrl+R or F10) runs the editor's text, or its selection, in this plugin's VM on its next tick, in a fresh environment each run that reads the plugin's globals: a lone expression shows its values, print writes to the console, an error is shown there and the plugin carries on, and a run is stopped after 300 ms. Returns nothing; nothing typed or shown there is ever handed to the plugin.

title
The window's title after the plugin's id; at most 80 characters.