Console APIs

Functions

rconsoletop

void rconsoletop(should_be_top: bool)

Enables or disables the internal console window being topmost.

rconsoleprint

void rconsoleprint(data: string, async?: bool, escape?: bool)

Writes text to the internal console. If async is true, the function does not block (useful when printing large amounts of text). If escape is false, null terminators will not be escaped. Defaults to true.

rconsoleinfo

void rconsoleinfo(data: string, async?: bool)

Writes info text to the internal console. If async is true, the function does not block (useful when printing large amounts of text).

rconsolewarn

void rconsolewarn(data: string, async?: bool)

Writes warning text to the internal console. If async is true, the function does not block (useful when printing large amounts of text).

rconsoleerr

void rconsoleerr(data: string, async?: bool)

Writes error text to the internal console. If async is true, the function does not block (useful when printing large amounts of text).

rconsoleclear

void rconsoleclear()

Clears the internal console.

rconsolename

void rconsolename()

Sets the title of the internal console's window.

rconsoleinput

string rconsoleinput() [yields]

Waits for a line of user input from the internal console and returns the result. Truncated to 4096 characters.

Keep in mind that if a different thread tries to do other console-related functions while this one is running, the game will stop responding until you give the console an input.

rconsolehide

void rconsolehide()

Hides the console.

rconsoleshow

void rconsoleshow()

Makes the console visible if it wasn't already.

rconsoletoggle

void rconsoletoggle()

Toggles whether the console is hidden or not.

rconsolehidden

bool rconsolehidden()

Returns whether or not the console is currently hidden.

printconsole

void printconsole(data: string, r: int, g: int, b: int) [parallel_safe]

Prints colored text to the Synapse console.

void printconsole(data: string) [parallel_safe]

Prints text to the Synapse console.

void printconsole(data: string, color: Color3) [parallel_safe]

Prints colored text to the Synapse console.

clearconsole

void clearconsole()

Clears the internal and external consoles.