chaos.console:

ChaosConsole

Types Summary

Types

Type TChaosConsole

Methods Summary
clear	Clear all text from the console.
output	Output a line.
registerFunction	Register a function to use with the console.
registerObject	Register an object for use with the console.
setBackgroundColor	Set the background color.
setBackgroundImage	Set an image to draw as console's background.
setDimensions	Set console's dimensions.
setFont	Sets a different font for display.
setFontColor	Set a color for the font.
setLuaState	Sets a custom lua state, e.g. when you use lua yourself in your application.
update	Updates the console.

Functions Summary
getPerLuaState	Returns an instance of TChaosConsole utilizing the given Lua state.

Method clear()
Returns	-
Description	Clear all text from the console.

Method output(line:String)
Returns	-
Description	Output a line.

Method registerFunction(name:String, argCount:Int, func:Int(ls:Byte Ptr))
Returns	-
Description	Register a function to use with the console.
Information	argCount defines how many arguments the function takes at least.

Method registerObject(name:String, obj:Object)
Returns	-
Description	Register an object for use with the console.

Method setBackgroundColor(r:Byte, g:Byte, b:Byte, a:Float)
Returns	-
Description	Set the background color.

Method setBackgroundImage(img:TImage)
Returns	-
Description	Set an image to draw as console's background.

Method setDimensions(w:Int, h:Int)
Returns	-
Description	Set console's dimensions.
Information	Set width and height of the console.

Method setFont(imgFont:TImageFont)
Returns	-
Description	Sets a different font for display.

Method setFontColor(r:Byte, g:Byte, b:Byte)
Returns	-
Description	Set a color for the font.

Method setLuaState(ls:Byte Ptr)
Returns	-
Description	Sets a custom lua state, e.g. when you use lua yourself in your application.
Information	Sets a custom lua state, e.g. when you use lua yourself in your application. ChaosConsole will inject its functions and terminate the old state automatically.

Method update:Int(key:Int)
Returns	True, if the console is active.
Description	Updates the console.
Information	Call this in your main loop. key defines a key that should be used to toggle the console.

Function getPerLuaState:TChaosConsole(ls:Byte Ptr)
Returns	TChaosConsole.
Description	Returns an instance of TChaosConsole utilizing the given Lua state.

Module Information

Version	0.3-rel_1
Author	hamZta
License	Public Domain
Contact	hamZta@chaos-interactive.de
Homepage	www.chaos-interactive.de
History	0.1-rel_1 Erster Release (19.07.2009)
History	0.3-rel_1 Umstellung des Parsers auf Lua (19.07.2009)