Console

Write an information message made from one or more values. Values are converted to strings and separated by tabs. Use it to log a status together with several values without manually joining them into one string.

Print text using an RGB color in the console. Use a color to distinguish a category of output or emphasize a short status message. RGB components here use 0–255, unlike normalized Drawing color components.

Remove all accumulated text from the script console. Use it to start a fresh log view without hiding the console. Previous output is removed, so clear before printing the new session heading.

Write an error message to the script console. The supplied value is converted to text. Use it to report an operation that failed. Printing the message does not itself raise an exception or stop the script.

Check whether the script console is currently hidden. Use it before showing a prompt or when updating a console visibility indicator. A true result means the console is hidden.

Hide the script console. Use rconsoleshow to display it again. Use it to dismiss the console after an interaction. It changes visibility; rconsoleclear is the operation for removing accumulated output.

Write an informational message to the script console. The supplied value is converted to text. Use it for successful steps and routine progress that should be distinguishable from warnings or errors.

Read a line submitted through the script console. Show the console before calling when you want to wait for user input. Use the returned line as text input for a prompt. Parse or validate it before treating it as a number, filename, or setting.

Set the title displayed by the script console. Give the console a title that identifies the current tool or task. This changes the heading rather than adding a line to the output.

Write a plain message to the script console. The supplied value is converted to text. Use it for ordinary output and prompts where a severity label is unnecessary.

Show the script console, creating its interface if necessary. Call it before interactive prompts or when a script needs a visible place for status messages. It does not clear existing output.

Show the console if it is hidden, or hide it if it is visible. Use it for a single Show/Hide action in your own controls, avoiding a separate visibility check.

Set the console topmost preference and show the console. Use it to change the console display priority when working with other on-screen windows. Supply true or false explicitly; calling it also shows the console.

Write a warning message to the script console. The supplied value is converted to text. Use it for a recoverable problem, such as falling back to default settings, while the script continues.