Class engine.DebugConsole
Debug Console
Tables
engine.DebugConsole.history
History of debug console defaults to help text for easy usage
engine.DebugConsole.commands
Registered commands
Fields
engine.DebugConsole.line
String representation of current line
engine.DebugConsole.line_pos
Integer Position in current line
engine.DebugConsole.com_sel
Integer command selection
Local Functions
engine.DebugConsole.find_base (remaining)
Parses a string for autocompletion
Methods
engine.DebugConsole:init ()
Init the debug console
engine.DebugConsole:display ()
Display function
engine.DebugConsole:drawDialog (s, w, h)
engine.DebugConsole:scrollUp (i)
Scroll the zone
engine.DebugConsole:autoComplete ()
Autocomplete the current line
Will handle either tables (eg.
engine.DebugConsole:functionHelp (func, verbose)
Prints comments for a function
engine.DebugConsole:historyColumns (strings, offset)
Add a list of strings to the history with multiple columns
Tables
- engine.DebugConsole.history
-
History of debug console defaults to help text for easy usage
Fields:
- <<<<<------------------------------------------------------------------------------------->>>>>
- < Welcome to the T-Engine Lua Console >
- <--------------------------------------------------------------------------------------------->
- <--------------------------------------------------------------------------------------------->
- < Here are some useful keyboard shortcuts: >
- < Left/right arrows :=: Move the cursor position left/right >
- < Ctrl+A or Home :=: Move the cursor to the beginning of the line >
- < Ctrl+E or End :=: Move the cursor to the end of the line >
- < Ctrl+K or Ctrl+End :=: Move the cursor to the end of the line >
- < Up/down arrows :=: Move between previous/later executed lines >
- < Ctrl+Space :=: Print help for the function to the left of the cursor >
- < Ctrl+Shift+Space :=: Print the entire definition for the function >
- < Tab :=: Auto-complete path strings or tables at the cursor >
- < Page Up :=: Scrolls up 75% of the history >
- < Page Down :=: Scrolls down 75% of the history >
- <<<<<------------------------------------------------------------------------------------->>>>>
- engine.DebugConsole.commands
- Registered commands
Fields
- engine.DebugConsole.line
- String representation of current line
- engine.DebugConsole.line_pos
- Integer Position in current line
- engine.DebugConsole.com_sel
- Integer command selection
Local Functions
Methods- engine.DebugConsole.find_base (remaining)
-
Parses a string for autocompletion
Parameters:
- remaining string the string to parse, also used for recursion
Returns:
- nil
- error object
Or
- nil
- "%s does not exist."
Or
- nil
- "%s is not a valid path"
Or
- head
- tail
Methods
- engine.DebugConsole:init ()
- Init the debug console
- engine.DebugConsole:display ()
- Display function
- engine.DebugConsole:drawDialog (s, w, h)
-
Parameters:
- s screen
- w width
- h height
- engine.DebugConsole:scrollUp (i)
-
Scroll the zone
Parameters:
- i int number representing how many lines to scroll
- engine.DebugConsole:autoComplete ()
-
Autocomplete the current line
Will handle either tables (eg. mod.cla -> mod.class) or paths (eg. "/mod/cla" -> "/mod/class/") - engine.DebugConsole:functionHelp (func, verbose)
-
Prints comments for a function
Parameters:
- func func only works on a function obviously
- verbose boolean give extra junk
- engine.DebugConsole:historyColumns (strings, offset)
-
Add a list of strings to the history with multiple columns
Parameters:
- strings table Array of strings to add to the history
- offset int Number of spaces to add on the left-hand side