DebugTextWorldSpace Class Reference

Private Member Functions
private void	DebugTextWorldSpace ()
void	~DebugTextWorldSpace ()
proto external vector	GetPosition ()
proto external void	SetPosition (float x, float y, float z)
proto external void	SetTransform (vector mat[4])
	Sets the transformation matrix of the text. Useful only for texts created with CreateInWorld().
proto void	GetTransform (out vector mat[4])
	Returns the transformation matrix of the text. Useful only for texts created with CreateInWorld().
private void	DebugTextWorldSpace ()
void	~DebugTextWorldSpace ()
proto external vector	GetPosition ()
proto external void	SetPosition (float x, float y, float z)
proto external void	SetTransform (vector mat[4])
	Sets the transformation matrix of the text. Useful only for texts created with CreateInWorld().
proto void	GetTransform (out vector mat[4])
	Returns the transformation matrix of the text. Useful only for texts created with CreateInWorld().

Static Private Member Functions
static proto DebugTextWorldSpace	Create (string text, DebugTextFlags flags, float x, float y, float z, float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
static proto DebugTextWorldSpace	CreateInWorld (string text, DebugTextFlags flags, vector transform[4], float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
static proto DebugTextWorldSpace	Create (string text, DebugTextFlags flags, float x, float y, float z, float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
static proto DebugTextWorldSpace	CreateInWorld (string text, DebugTextFlags flags, vector transform[4], float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)

Constructor & Destructor Documentation

DebugTextWorldSpace() [1/2]

private void DebugTextWorldSpace ( )

private

~DebugTextWorldSpace() [1/2]

void ~DebugTextWorldSpace ( )

private

DebugTextWorldSpace() [2/2]

private void DebugTextWorldSpace ( )

private

~DebugTextWorldSpace() [2/2]

void ~DebugTextWorldSpace ( )

private

Member Function Documentation

Create() [1/2]

static proto DebugTextWorldSpace Create ( string  text, DebugTextFlags  flags, float  x, float  y, float  z, float  size = 20.0, int  color = 0xFFFFFFFF, int  bgColor = 0x00000000, int  priority = 1000  )

staticprivate

Creates a text instance.

Warning

Returned instance should be saved to ref, otherwise it is impossible to remove from screen (unless DebugTextFlags.ONCE is used).

Parameters

text	Text to draw on screen
flags	DebugTextFlags
x	X coordinate of the top left corner of the text in world space
y	Y coordinate of the top left corner of the text in world space
z	Z coordinate of the top left corner of the text in world space
size	Size of the font in pixels
color	Color of the text
bgColor	Color of the back background behind the text
priority	Z order priority. Note: texts with background are always rendered under texts without background.

Returns

DebugText Instance of debug text with given properties set, if flags contains DebugTextFlags.ONCE null is returned

Referenced by Debug::DrawTextWS().

Create() [2/2]

static proto DebugTextWorldSpace Create ( string  text, DebugTextFlags  flags, float  x, float  y, float  z, float  size = 20.0, int  color = 0xFFFFFFFF, int  bgColor = 0x00000000, int  priority = 1000  )

staticprivate

Creates a text instance.

Warning

Returned instance should be saved to ref, otherwise it is impossible to remove from screen (unless DebugTextFlags.ONCE is used).

Parameters

text	Text to draw on screen
flags	DebugTextFlags
x	X coordinate of the top left corner of the text in world space
y	Y coordinate of the top left corner of the text in world space
z	Z coordinate of the top left corner of the text in world space
size	Size of the font in pixels
color	Color of the text
bgColor	Color of the back background behind the text
priority	Z order priority. Note: texts with background are always rendered under texts without background.

Returns

DebugText Instance of debug text with given properties set, if flags contains DebugTextFlags.ONCE null is returned

CreateInWorld() [1/2]

static proto DebugTextWorldSpace CreateInWorld ( string  text, DebugTextFlags  flags, vector  transform[4], float  size = 20.0, int  color = 0xFFFFFFFF, int  bgColor = 0x00000000, int  priority = 1000  )

staticprivate

The text is placed in world and is occluded by other objects. The size is in meters (approximately).

Parameters

size	Size of the font in meters (approximately)

See also

DebugTextWorldSpace.Create

CreateInWorld() [2/2]

static proto DebugTextWorldSpace CreateInWorld ( string  text, DebugTextFlags  flags, vector  transform[4], float  size = 20.0, int  color = 0xFFFFFFFF, int  bgColor = 0x00000000, int  priority = 1000  )

staticprivate

The text is placed in world and is occluded by other objects. The size is in meters (approximately).

Parameters

size	Size of the font in meters (approximately)

See also

DebugTextWorldSpace.Create

GetPosition() [1/2]

proto external vector GetPosition ( )

private

GetPosition() [2/2]

proto external vector GetPosition ( )

private

GetTransform() [1/2]

proto void GetTransform ( out vector  mat[4] )

private

Returns the transformation matrix of the text. Useful only for texts created with CreateInWorld().

GetTransform() [2/2]

proto void GetTransform ( out vector  mat[4] )

private

Returns the transformation matrix of the text. Useful only for texts created with CreateInWorld().

SetPosition() [1/2]

proto external void SetPosition ( float  x, float  y, float  z  )

private

SetPosition() [2/2]

proto external void SetPosition ( float  x, float  y, float  z  )

private

SetTransform() [1/2]

proto external void SetTransform ( vector  mat[4] )

private

Sets the transformation matrix of the text. Useful only for texts created with CreateInWorld().

SetTransform() [2/2]

proto external void SetTransform ( vector  mat[4] )

private

Sets the transformation matrix of the text. Useful only for texts created with CreateInWorld().

---

The documentation for this class was generated from the following file:

• P:/scripts/1_Core/Debug/DebugTextWorldSpace.c