HOW TO USE THE CONSOLE

CONSOLE

The Console in the PIXELPLAN 3D viewer is a tool that enables you to set different engine parameters at the run time. It can be used to examine a map, to test if it is done in a proper way and is optimal from the point of view of performance. The console is activated with the ~key (tilde). Engine parameters are modified by writing commands in the console and confirming them with the Enterkey. Most commands consist of the name of a variable and a value that you want to assign to the variable. If you enter the name of a variable without a value you can examine its current value. You can use the Tabkey to automatically finish a command name or, if there are many possible command names, show all command names that match.

nocollision 0 / 1

A value that equals 1 means that the Playeractor will not collide with objects and walls and can freely move around a map.

r_showEdges 0 / 1

Enables and disables drawing the edges of triangles. When enabled, it allows you to observe how the visibility system rejects the currently invisible regions of a map while drawing and because of that it allows you to verify portal placement.

r_depthTestDebugs 0 / 1

Enables and disables the depth test (z-buffer) for rendering helpful information, such as light triangle edges or portals.

g_showClusterPortals 0 / 1

Enables and disables drawing portals of the cluster that the camera is currently in. It enables you to observe if clusters are built as intended or if they leak.

setLeakTestStartPosition

Sets the leak test start point at the current camera position.

setLeakTestEndPosition

Sets the leak test end point at the current camera position.

doLeakTest

This command runs the leak test. It searches for a path between the leak test start point and the end point that does no go through any portal. If such a path exists, it will be drawn as a red line. This allows you to detect little unintended gaps and cracks between different areas (clusters) – leaks.

How to use console