Topics
	Diag menu API definition

Classes
class	DbgUI
class	Debug
class	DebugText
	Used for creating on screen texts in world. More...
class	DebugTextScreenSpace
class	DebugTextWorldSpace
class	DiagMenu
	Diagnostic and developer menu system. More...
class	Shape
	Instance of created debug visualizer. More...
class	ShapeUtils

Enumerations
enum	DebugTextFlags { DEFAULT , CENTER , FACE_CAMERA , ONCE , IN_WORLD , DONT_SCALE_POS , DONT_SCALE , DEFAULT , CENTER , FACE_CAMERA , ONCE , IN_WORLD , DONT_SCALE_POS , DONT_SCALE }
enum	DebugTextFlags { DEFAULT , CENTER , FACE_CAMERA , ONCE , IN_WORLD , DONT_SCALE_POS , DONT_SCALE , DEFAULT , CENTER , FACE_CAMERA , ONCE , IN_WORLD , DONT_SCALE_POS , DONT_SCALE }
enum	LogLevel { SPAM , VERBOSE , DEBUG , NORMAL , WARNING , ERROR , FATAL , SPAM , VERBOSE , DEBUG , NORMAL , WARNING , ERROR , FATAL }
	Enum with severity of the logging message. More...
enum	LogLevel { SPAM , VERBOSE , DEBUG , NORMAL , WARNING , ERROR , FATAL , SPAM , VERBOSE , DEBUG , NORMAL , WARNING , ERROR , FATAL }
enum	ShapeFlags { DEFAULT , NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP , DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE , NOCULL , VISIBLE , ADDITIVE , DEPTH_DITHER , CULL_FAR , SHOW_ERRORS , NOINSERT , FLAT , SVF_NORMAL , SVF_COLOR , DEFAULT , NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP , DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE , NOCULL , VISIBLE , ADDITIVE , DEPTH_DITHER , CULL_FAR , SHOW_ERRORS , NOINSERT , FLAT , SVF_NORMAL , SVF_COLOR }
enum	ShapeFlags { DEFAULT , NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP , DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE , NOCULL , VISIBLE , ADDITIVE , DEPTH_DITHER , CULL_FAR , SHOW_ERRORS , NOINSERT , FLAT , SVF_NORMAL , SVF_COLOR , DEFAULT , NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP , DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE , NOCULL , VISIBLE , ADDITIVE , DEPTH_DITHER , CULL_FAR , SHOW_ERRORS , NOINSERT , FLAT , SVF_NORMAL , SVF_COLOR }
enum	ShapeType { NONE = 0 , BBOX , LINE , BRUSH , PIVOT , POINT , MESH , POLYGON , INDEXEDMESH , SPHERE , CYLINDER , DIAMOND , PYRAMID , ARROW , LINE_LIST , LINE_STRIP , NONE = 0 , BBOX , LINE , BRUSH , PIVOT , POINT , MESH , POLYGON , INDEXEDMESH , SPHERE , CYLINDER , DIAMOND , PYRAMID , ARROW , LINE_LIST , LINE_STRIP }
enum	ShapeType { NONE = 0 , BBOX , LINE , BRUSH , PIVOT , POINT , MESH , POLYGON , INDEXEDMESH , SPHERE , CYLINDER , DIAMOND , PYRAMID , ARROW , LINE_LIST , LINE_STRIP , NONE = 0 , BBOX , LINE , BRUSH , PIVOT , POINT , MESH , POLYGON , INDEXEDMESH , SPHERE , CYLINDER , DIAMOND , PYRAMID , ARROW , LINE_LIST , LINE_STRIP }

Functions
proto void	Print (void var, LogLevel level=LogLevel.NORMAL)
	Prints content of variable to console/log.
proto void	PrintFormat (string fmt, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL, LogLevel level=LogLevel.NORMAL)

Detailed Description

Enumeration Type Documentation

◆ DebugTextFlags [1/2]

enum DebugTextFlags

Enumerator
DEFAULT	Use currently set main RT format (based on game options). Entry is controlled by the game automatically. Most common flag set.
CENTER	Text will be centered.
FACE_CAMERA
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
IN_WORLD
DONT_SCALE_POS	disable automatic position scaling, always present on world-space debug texts
DONT_SCALE	disable both automatic position and size scaling
DEFAULT	Use currently set main RT format (based on game options). Entry is controlled by the game automatically. Most common flag set.
CENTER	Text will be centered.
FACE_CAMERA
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
IN_WORLD
DONT_SCALE_POS	disable automatic position scaling, always present on world-space debug texts
DONT_SCALE	disable both automatic position and size scaling

Definition at line 12 of file DebugTextFlags.c.

◆ DebugTextFlags [2/2]

enum DebugTextFlags

Enumerator
DEFAULT	Use currently set main RT format (based on game options). Entry is controlled by the game automatically. Most common flag set.
CENTER	Text will be centered.
FACE_CAMERA
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
IN_WORLD
DONT_SCALE_POS	disable automatic position scaling, always present on world-space debug texts
DONT_SCALE	disable both automatic position and size scaling
DEFAULT	Use currently set main RT format (based on game options). Entry is controlled by the game automatically. Most common flag set.
CENTER	Text will be centered.
FACE_CAMERA
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
IN_WORLD
DONT_SCALE_POS	disable automatic position scaling, always present on world-space debug texts
DONT_SCALE	disable both automatic position and size scaling

Definition at line 12 of file DebugTextFlags.c.

◆ LogLevel [1/2]

enum LogLevel

Enum with severity of the logging message.

Enumerator
SPAM
VERBOSE
DEBUG
NORMAL
WARNING
ERROR	Same as DELETE, but global error count for OnAfterLoad is affected.
FATAL
SPAM
VERBOSE
DEBUG
NORMAL
WARNING
ERROR	Same as DELETE, but global error count for OnAfterLoad is affected.
FATAL

Definition at line 13 of file LogLevel.c.

◆ LogLevel [2/2]

enum LogLevel

Enumerator
SPAM
VERBOSE
DEBUG
NORMAL
WARNING
ERROR	Same as DELETE, but global error count for OnAfterLoad is affected.
FATAL
SPAM
VERBOSE
DEBUG
NORMAL
WARNING
ERROR	Same as DELETE, but global error count for OnAfterLoad is affected.
FATAL

Definition at line 13 of file LogLevel.c.

◆ ShapeFlags [1/2]

enum ShapeFlags

Enumerator
DEFAULT
NOZBUFFER	Do not compare z-buffer when render.
NOZWRITE	Do not update z-buffer when render.
WIREFRAME	Render just wire-frame outline. No solid faces.
TRANSP	Is translucent.
DOUBLESIDE	Double-sided (do not cull back-faces).
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
NOOUTLINE	Render just solid faces. No wire-frame outline.
BACKFACE	Render just back faces.
NOCULL	Do not cull shapes by view frustum.
VISIBLE	Make it visible. Set by default. When set, widget and his children are visible. Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
ADDITIVE	Additive blending (works with SS_TRANSP). Alpha-blending will be additive.
DEPTH_DITHER	dither according depth
CULL_FAR	More aggressive culling of far shapes with this flag.
SHOW_ERRORS	Draw double sided, highlighting backfaces to visualize vertex winding order errors.
NOINSERT	Do not insert it to shape-collection.
FLAT	Flat shading (no vertex normals are required).
SVF_NORMAL
SVF_COLOR
DEFAULT
NOZBUFFER	Do not compare z-buffer when render.
NOZWRITE	Do not update z-buffer when render.
WIREFRAME	Render just wire-frame outline. No solid faces.
TRANSP	Is translucent.
DOUBLESIDE	Double-sided (do not cull back-faces).
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
NOOUTLINE	Render just solid faces. No wire-frame outline.
BACKFACE	Render just back faces.
NOCULL	Do not cull shapes by view frustum.
VISIBLE	Make it visible. Set by default. When set, widget and his children are visible. Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
ADDITIVE	Additive blending (works with SS_TRANSP). Alpha-blending will be additive.
DEPTH_DITHER	dither according depth
CULL_FAR	More aggressive culling of far shapes with this flag.
SHOW_ERRORS	Draw double sided, highlighting backfaces to visualize vertex winding order errors.
NOINSERT	Do not insert it to shape-collection.
FLAT	Flat shading (no vertex normals are required).
SVF_NORMAL
SVF_COLOR

Definition at line 12 of file ShapeFlags.c.

◆ ShapeFlags [2/2]

enum ShapeFlags

Enumerator
DEFAULT
NOZBUFFER	Do not compare z-buffer when render.
NOZWRITE	Do not update z-buffer when render.
WIREFRAME	Render just wire-frame outline. No solid faces.
TRANSP	Is translucent.
DOUBLESIDE	Double-sided (do not cull back-faces).
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
NOOUTLINE	Render just solid faces. No wire-frame outline.
BACKFACE	Render just back faces.
NOCULL	Do not cull shapes by view frustum.
VISIBLE	Make it visible. Set by default. When set, widget and his children are visible. Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
ADDITIVE	Additive blending (works with SS_TRANSP). Alpha-blending will be additive.
DEPTH_DITHER	dither according depth
CULL_FAR	More aggressive culling of far shapes with this flag.
SHOW_ERRORS	Draw double sided, highlighting backfaces to visualize vertex winding order errors.
NOINSERT	Do not insert it to shape-collection.
FLAT	Flat shading (no vertex normals are required).
SVF_NORMAL
SVF_COLOR
DEFAULT
NOZBUFFER	Do not compare z-buffer when render.
NOZWRITE	Do not update z-buffer when render.
WIREFRAME	Render just wire-frame outline. No solid faces.
TRANSP	Is translucent.
DOUBLESIDE	Double-sided (do not cull back-faces).
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
NOOUTLINE	Render just solid faces. No wire-frame outline.
BACKFACE	Render just back faces.
NOCULL	Do not cull shapes by view frustum.
VISIBLE	Make it visible. Set by default. When set, widget and his children are visible. Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
ADDITIVE	Additive blending (works with SS_TRANSP). Alpha-blending will be additive.
DEPTH_DITHER	dither according depth
CULL_FAR	More aggressive culling of far shapes with this flag.
SHOW_ERRORS	Draw double sided, highlighting backfaces to visualize vertex winding order errors.
NOINSERT	Do not insert it to shape-collection.
FLAT	Flat shading (no vertex normals are required).
SVF_NORMAL
SVF_COLOR

Definition at line 12 of file ShapeFlags.c.

◆ ShapeType [1/2]

enum ShapeType

Enumerator
NONE	When Shape is created and not initialized yet. No revision is locally available/downloaded and not subscribed (cannot download until subscribed). ordered randomly. Manual shifting, manual reverse, manual engine startup, manual persistent handbrake. Gadget anim variable. body is not in simulation, nor in collision world
BBOX	Just box.
LINE	One lines.
BRUSH	Not implemented.
PIVOT	3D orientation visualizer
POINT	Not implemented.
MESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
POLYGON	Polygon.
INDEXEDMESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
SPHERE	Sphere represented by triangle mesh. sphere interpolation
CYLINDER	Cylinder represented by triangle mesh.
DIAMOND	Eight faced pyramid. Defined by bound-box, where middle part is equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
PYRAMID	Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
ARROW	Arrow pointing down.
LINE_LIST	List of multiple lines.
LINE_STRIP	Multiple lines in a single winding.
NONE	When Shape is created and not initialized yet. No revision is locally available/downloaded and not subscribed (cannot download until subscribed). ordered randomly. Manual shifting, manual reverse, manual engine startup, manual persistent handbrake. Gadget anim variable. body is not in simulation, nor in collision world
BBOX	Just box.
LINE	One lines.
BRUSH	Not implemented.
PIVOT	3D orientation visualizer
POINT	Not implemented.
MESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
POLYGON	Polygon.
INDEXEDMESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
SPHERE	Sphere represented by triangle mesh. sphere interpolation
CYLINDER	Cylinder represented by triangle mesh.
DIAMOND	Eight faced pyramid. Defined by bound-box, where middle part is equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
PYRAMID	Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
ARROW	Arrow pointing down.
LINE_LIST	List of multiple lines.
LINE_STRIP	Multiple lines in a single winding.

Definition at line 12 of file ShapeType.c.

◆ ShapeType [2/2]

enum ShapeType

Enumerator
NONE	When Shape is created and not initialized yet. No revision is locally available/downloaded and not subscribed (cannot download until subscribed). ordered randomly. Manual shifting, manual reverse, manual engine startup, manual persistent handbrake. Gadget anim variable. body is not in simulation, nor in collision world
BBOX	Just box.
LINE	One lines.
BRUSH	Not implemented.
PIVOT	3D orientation visualizer
POINT	Not implemented.
MESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
POLYGON	Polygon.
INDEXEDMESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
SPHERE	Sphere represented by triangle mesh. sphere interpolation
CYLINDER	Cylinder represented by triangle mesh.
DIAMOND	Eight faced pyramid. Defined by bound-box, where middle part is equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
PYRAMID	Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
ARROW	Arrow pointing down.
LINE_LIST	List of multiple lines.
LINE_STRIP	Multiple lines in a single winding.
NONE	When Shape is created and not initialized yet. No revision is locally available/downloaded and not subscribed (cannot download until subscribed). ordered randomly. Manual shifting, manual reverse, manual engine startup, manual persistent handbrake. Gadget anim variable. body is not in simulation, nor in collision world
BBOX	Just box.
LINE	One lines.
BRUSH	Not implemented.
PIVOT	3D orientation visualizer
POINT	Not implemented.
MESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
POLYGON	Polygon.
INDEXEDMESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
SPHERE	Sphere represented by triangle mesh. sphere interpolation
CYLINDER	Cylinder represented by triangle mesh.
DIAMOND	Eight faced pyramid. Defined by bound-box, where middle part is equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
PYRAMID	Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
ARROW	Arrow pointing down.
LINE_LIST	List of multiple lines.
LINE_STRIP	Multiple lines in a single winding.

Definition at line 12 of file ShapeType.c.

Function Documentation

◆ Print()

proto void Print	(	void	var,
		LogLevel	level = LogLevel.NORMAL )

Prints content of variable to console/log.

◆ PrintFormat()

proto void PrintFormat	(	string	fmt,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL,
		LogLevel	level = LogLevel.NORMAL )

Prints formated text to console/log.

string c = "Peter";

PrintFormat("Hello %1, how are you?", c); // prints "Hello 'Peter', how are you?"

PrintFormat

proto void PrintFormat(string fmt, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL, LogLevel level=LogLevel.NORMAL)

Examples: F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

Topics

Classes

Enumerations

Functions