CommandWindow - stingray.CommandWindow namespace reference - Stingray Lua API Reference

stingray.CommandWindow namespace 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.

Functions

Parameters

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.
Returns
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.

Parameters
This function does not accept any parameters.
Returns
This function does not return any values.
Parameters

title :

string

Specifies the title of the window.

Returns
This function does not return any values.
Parameters
This function does not accept any parameters.
Returns

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.

Parameters
This function does not accept any parameters.
Returns
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.