Skip to main content

IsConsoleActive

This function was added in DSL 1

Description​

Checks if the console is currently opened.

tip

Primarily intended for scripts to be able to limit certain inputs when the console is in focus.

function IsConsoleActive() --[[ ... ]] end

Parameters​

None.

Return Values​

  • active: boolean - Returns true if the console is currently opened, otherwise false.

Example​

if IsConsoleActive() then
  print('The console is currently active.')
else
  print('The console is not active.')
end