Docs / Console

Console

External Windows console — allocated on first use.

Library#04 of 23 Functions10
rconsolecreate()
Show the console window.
aliasesconsolecreate, rconsoleshow, consoleshow
lua
rconsolecreate()
rconsoledestroy()
Hide the console window.
aliasesconsoledestroy, rconsolehide, consolehide
lua
rconsoledestroy()
rconsolesettitle(title: string)
Set the console window title.
aliasesrconsolename, consolesettitle, consolename
lua
rconsolesettitle("Velocity — Debug")
rconsoleclear()
Clear the console buffer.
aliasesconsoleclear
lua
rconsoleclear()
rconsoleprint(text: string)
Print without a trailing newline. Supports color codes via prefix.
aliasesconsoleprint
lua
rconsoleprint("progress: ")
for i = 1, 5 do
    rconsoleprint(i .. " ")
    task.wait(0.1)
end
rconsoleprint("\n")
rconsoleinput() → string yields
Read one line of input from the console.
aliasesconsoleinput
lua
rconsoleprint("name > ")
local name = rconsoleinput()
print("hello " .. name)
rconsoleinfo(text: string)
Print an info-tagged line.
aliasesconsoleinfo
lua
rconsoleinfo("loaded 42 items")
rconsolewarn(text: string)
Print a warning-tagged line (yellow).
aliasesconsolewarn
lua
rconsolewarn("slow response from server")
rconsoleerr(text: string)
Print an error-tagged line (red).
aliasesrconsoleerror, consoleerr, consoleerror
lua
rconsoleerr("failed: connection reset")
messagebox(text: string, title: string, buttons: number) → number yields
Native Win32 MessageBoxW. Returns the button pressed.
lua
-- buttons: 0=OK, 1=OK/Cancel, 4=Yes/No
local r = messagebox("Continue?", "Confirm", 4)
if r == 6 then print("yes") end