CommandWindow - stingray.CommandWindow namespace reference - Stingray Lua API Reference
Description
Interface to output to the command window.
This interface only exists on platforms that have a command line window like Windows or Unix.
Other related reference items 
Functions
 |
print ( parameters )
Prints all the parameters to the command window after converting them to strings.
|
parameters : | any+ |
Specifies the parameters that you want to print. The + notation indicates that there may be one or more instances of the specified type. |
| This function does not return any values. |
You can pass "\n" as an argument to insert a line break.
Windows only
The functions in this group are only available on Windows platforms.
| |
close ( )
Closes an open command window.
|
| This function does not accept any parameters. |
| This function does not return any values. |
| |
open ( title )
Opens a new command window for output.
|
title : | string |
Specifies the title of the window. |
| This function does not return any values. |
| |
read_line ( ) : string
Reads a line of text that is typed into the console window.
|
| This function does not accept any parameters. |
string |
A line of text that is typed into the console window. |
The text is fetched after the Enter key is pressed. For this function to work, you need to call stingray.CommandWindow.update() in each frame.
Other related reference items
| |
update ( )
This function fetches the key presses in the console.
|
| This function does not accept any parameters. |
| This function does not return any values. |
Call the update() function in each frame if you need to call stingray.CommandWindow.read_line(), otherwise you do not need to call this function at all.
Other related reference items