Enfusion Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
DebugTextScreenSpace Interface Reference
Inheritance diagram for DebugTextScreenSpace:
[legend]

Public Member Functions

void ~DebugTextScreenSpace ()
 
proto external void SetPosition (float x, float y)
 
proto external vector GetPosition ()
 
- 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 DebugTextScreenSpace Create (BaseWorld world, string text, DebugTextFlags flags, float x, float y, float size=20.0, int color=0xFFFFFFFF, int bgColor=0x00000000, int priority=1000)
 Creates a text instance.
 

Constructor & Destructor Documentation

◆ ~DebugTextScreenSpace()

void DebugTextScreenSpace.~DebugTextScreenSpace ( )

Member Function Documentation

◆ Create()

static proto DebugTextScreenSpace DebugTextScreenSpace.Create ( BaseWorld  world,
string  text,
DebugTextFlags  flags,
float  x,
float  y,
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
worldIn which world should be the text drawn
textText to draw on screen
flagsDebugTextFlags
xX coordinate of the top left corner of the text
yY coordinate of the top left corner of the text
sizeSize of the font in pixels
colorColor of the text
bgColorColor of the back background behind the text
priorityZ 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

◆ GetPosition()

proto external vector DebugTextScreenSpace.GetPosition ( )

◆ SetPosition()

proto external void DebugTextScreenSpace.SetPosition ( float  x,
float  y 
)

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