DebugTextWorldSpace Interface Reference

Inheritance diagram for DebugTextWorldSpace:

Public Member Functions
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().
Public Member Functions inherited from DebugText
void	~DebugText ()
proto external string	GetText ()
proto external float	GetFontSize ()
proto external int	GetTextColor ()
proto external int	GetBackgroundColor ()
proto external int	GetPriority ()
proto external void	SetText (string text)
proto external void	SetTextColor (int color)
proto external void	SetFontSize (float size)
proto external void	SetBackgroundColor (int color)
proto external void	SetPriority (int priority)
	Sets Z order priority.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Static Public Member Functions
static proto DebugTextWorldSpace	Create (BaseWorld world, string text, DebugTextFlags flags, float x, float y, float z, float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
	Creates a text instance.
static proto DebugTextWorldSpace	CreateInWorld (BaseWorld world, string text, DebugTextFlags flags, vector transform[4], float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
	The text is placed in world and is occluded by other objects.

Constructor & Destructor Documentation

~DebugTextWorldSpace()

void DebugTextWorldSpace.~DebugTextWorldSpace

(

)

Member Function Documentation

Create()

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

static

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

world	In which world should be the text drawn
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()

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

static

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()

proto external vector DebugTextWorldSpace.GetPosition

(

)

GetTransform()

proto void DebugTextWorldSpace.GetTransform

(

out vector

mat[4]

)

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

SetPosition()

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

SetTransform()

proto external void DebugTextWorldSpace.SetTransform

(

vector

mat[4]

)

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

---

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

• Core/generated/Debug/DebugTextWorldSpace.c