Debug
Debug

The Debug object adds useful debugging tools to JAM, including windows console support, realtime information on visible objects, message boxes and saving log files.

Creation
 
DebugCreates a new Debug object
Functions
 
Debug switch
DebugOnTurns the debug object ON
DebugOffTurns the debug object OFF
SetDebugTurns the debug object ON or OFF
IsDebugReturns TRUE if the debug object is ON
Dialogues
MessageDisplays a message in a simple message box
AssertDisplays a message if a given condition is FALSE
ResetAssertIf the Assert messages have been turned off at runtime, this re-enables them
Console
OpenConsoleOpens a console for the game
WriteToConsoleWrites text to the game console
WriteLnToConsoleWrites a line of text to the game console
ClearConsoleClears the game console
CloseConsoleCloses the game console
Realtime debug
SetRealtimeDebugTurns on or off the realtime information on the game
SetRealtimeDebugPosSets the position of the realtime debug text
IsRealtimeDebugReturns TRUE if realtime debug is on
Network debug
SetNetworkDebugTurns on or off the network debug information in the console
IsNetworkDebugReturns TRUE if network debug is on
Log files
SetOutFileSets the target file to save log files to
GetOutFileReturns the target file where logs are saved
RecordAllRecords information about every object in the game, and optionally saves the data
AppendDataAdds data to the end of the current log file
ObjectInfoReturns a string containing information about the given object
GlobalsInfoReturns a string containing information about the current frame
SaveDataSaves the current log file
ClearResets the current log file to be blank
SetAutoLogTurns auto logging ON or OFF
Collision mask
ShowMaskSets the JAM object to display the collision mask when refreshing
HideMaskTurns off the visual collision mask
Debug break
DebugBreakShows a message and pauses the game



JAM © 2005 no one in partiular
Project started by David Evans in 2005