Debugging

Functions

void

backtrace()

void

debug()

void

debugDumpAllObjects()

void

debugv(string variableName)

void

dumpAlloc(int allocNum)

void

dumpMemSnapshot(string fileName)

void

dumpUnflaggedAllocs(string fileName)

void

flagCurrentAllocs()

void

freeMemoryDump()

int

getAppVersionNumber()

string

getAppVersionString()

string

getBuildString()

string

getCompileTimeString()

string

getEngineName()

int

getVersionNumber()

string

getVersionString()

void

profilerDump()

void

profilerDumpToFile(string fileName)

void

profilerEnable(bool enable)

void

profilerMarkerEnable(string markerName, bool enable)

void

profilerReset()

int

sizeof(string objectOrClass)

void

telnetSetParameters(int port, string consolePass, string listenPass, bool remoteEcho)

void

trace(bool enable)

void

validateMemory()

Functions

backtrace()

Prints the scripting call stack to the console log.

Used to trace functions called from within functions. Can help discover what functions were called (and not yet exited) before the current point in scripts.

debug()

Drops the engine into the native C++ debugger.

This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms.

note:

This function is not available in shipping builds.

debugDumpAllObjects()

Dumps all current EngineObject instances to the console.

note:

This function is only available in debug builds.

debugv(string variableName)

Logs the value of the given variable to the console.

Prints a string of the form " = " to the console.

Parameters:

%var = 1;
debugv( "%var" ); // Prints "%var = 1"

dumpAlloc(int allocNum)

Dumps information about the given allocated memory block.

Parameters:

note:

Available in debug builds only. In torqueConfig.h, TORQUE_DISABLE_MEMORY_MANAGER must be undefined to use this function.

dumpMemSnapshot(string fileName)

Dumps a snapshot of current memory to a file.

The total memory used will also be output to the console. This function will attempt to create the file if it does not already exist. Parameters:

dumpMemSnapshot( "C:/Torque/ProfilerLogs/profilerlog1.txt" );

note:

Available in debug builds only. In torqueConfig.h, TORQUE_DISABLE_MEMORY_MANAGER must be undefined to use this function.

dumpUnflaggedAllocs(string fileName)

Dumps all unflagged memory allocations.

Dumps all memory allocations that were made after a call to flagCurrentAllocs(). Helpful when used with flagCurrentAllocs() for detecting memory leaks and analyzing general memory usage.

Parameters:

dumpMemSnapshot(); // dumps info to console
dumpMemSnapshot( "C:/Torque/profilerlog1.txt" ); // dumps info to file

note:

Available in debug builds only. In torqueConfig.h, TORQUE_DISABLE_MEMORY_MANAGER must be undefined to use this function.

flagCurrentAllocs()

Flags all current memory allocations.

Flags all current memory allocations for exclusion in subsequent calls to dumpUnflaggedAllocs(). Helpful in detecting memory leaks and analyzing memory usage.

freeMemoryDump()

Dumps some useful statistics regarding free memory.

Dumps an analysis of 'free chunks' of memory. Does not print how much memory is free.

getAppVersionNumber()

Get the version of the application build, as a string.

getAppVersionString()

Get the version of the aplication build, as a human readable string.

getBuildString()

Get the type of build, "Debug" or "Release".

getCompileTimeString()

Get the time of compilation.

getEngineName()

Get the name of the engine product that this is running from, as a string.

getVersionNumber()

Get the version of the engine build, as a string.

getVersionString()

Get the version of the engine build, as a human readable string.

profilerDump()

Dumps current profiling stats to the console window.

note:

Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled.

profilerDumpToFile(string fileName)

Dumps current profiling stats to a file.

note:

If the profiler is currently running, it will be disabled.

profilerDumpToFile( "C:/Torque/log1.txt" );

profilerEnable(bool enable)

Enables or disables the profiler.

Data is only gathered while the profiler is enabled.

note:

Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros.

profilerMarkerEnable(string markerName, bool enable)

Enable or disable a specific profile.

Parameters:

note:

Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default.

profilerReset()

Resets the profiler, clearing it of all its data.

If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status.

sizeof(string objectOrClass)

Determines the memory consumption of a class or object.

Parameters:

telnetSetParameters(int port, string consolePass, string listenPass, bool remoteEcho)

Initializes and open the telnet console.

Parameters:

trace(bool enable)

Enable or disable tracing in the script code VM.

When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program.

Parameters:

validateMemory()

Used to validate memory space for the game.