Highroad Engine v1.3
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
MoreMountains.Tools.MMDebugOnScreenConsole Class Reference
Inheritance diagram for MoreMountains.Tools.MMDebugOnScreenConsole:

Public Member Functions

virtual void Toggle ()
 
virtual void SetScreenOffset (int top=10, int left=10)
 Sets the screen offset, from the top left corner More...
 
virtual void SetMessage (string newMessage)
 Replaces the content of the current message stack with the specified string More...
 
virtual void AddMessage (string label, object value, int fontSize)
 Adds the specified message to the message stack. More...
 

Public Attributes

RectTransform Container
 
Image BackgroundImage
 
Text ConsoleText
 
Color LabelColor = Color.white
 
string ValueColor = "#FFC400"
 
float ValueSizeRatio = 1.35f
 

Protected Member Functions

virtual void Awake ()
 
virtual void Initialization ()
 
virtual void SetFontSize (int fontSize)
 Sets the size of the font, and automatically deduces the character's height and width. More...
 
virtual void LateUpdate ()
 Draws a box containing the current stack of messages on top of the screen. More...
 

Protected Attributes

RectTransform _rectTransform
 
int _numberOfMessages = 0
 
bool _messageStackHasBeenDisplayed = false
 
bool _newMessageThisFrame = false
 
int _largestMessageLength = 0
 
StringBuilder _stringBuilder
 
string _valueTagStart
 
string _valueTagEnd
 
Vector2 _closedSize = new Vector2(60, 80)
 
Vector2 _openBackgroundWidth
 
int _last_append_at_frame = -1
 

Static Protected Attributes

const string space = " "
 

Member Function Documentation

◆ AddMessage()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.AddMessage ( string  label,
object  value,
int  fontSize 
)
virtual

Adds the specified message to the message stack.

Parameters
labelNew message.

◆ Awake()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.Awake ( )
protectedvirtual

◆ Initialization()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.Initialization ( )
protectedvirtual

◆ LateUpdate()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.LateUpdate ( )
protectedvirtual

Draws a box containing the current stack of messages on top of the screen.

◆ SetFontSize()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.SetFontSize ( int  fontSize)
protectedvirtual

Sets the size of the font, and automatically deduces the character's height and width.

Parameters
fontSizeFont size.

◆ SetMessage()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.SetMessage ( string  newMessage)
virtual

Replaces the content of the current message stack with the specified string

Parameters
newMessageNew message.

◆ SetScreenOffset()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.SetScreenOffset ( int  top = 10,
int  left = 10 
)
virtual

Sets the screen offset, from the top left corner

Parameters
top
left

◆ Toggle()

virtual void MoreMountains.Tools.MMDebugOnScreenConsole.Toggle ( )
virtual

Member Data Documentation

◆ _closedSize

Vector2 MoreMountains.Tools.MMDebugOnScreenConsole._closedSize = new Vector2(60, 80)
protected

◆ _largestMessageLength

int MoreMountains.Tools.MMDebugOnScreenConsole._largestMessageLength = 0
protected

◆ _last_append_at_frame

int MoreMountains.Tools.MMDebugOnScreenConsole._last_append_at_frame = -1
protected

◆ _messageStackHasBeenDisplayed

bool MoreMountains.Tools.MMDebugOnScreenConsole._messageStackHasBeenDisplayed = false
protected

◆ _newMessageThisFrame

bool MoreMountains.Tools.MMDebugOnScreenConsole._newMessageThisFrame = false
protected

◆ _numberOfMessages

int MoreMountains.Tools.MMDebugOnScreenConsole._numberOfMessages = 0
protected

◆ _openBackgroundWidth

Vector2 MoreMountains.Tools.MMDebugOnScreenConsole._openBackgroundWidth
protected

◆ _rectTransform

RectTransform MoreMountains.Tools.MMDebugOnScreenConsole._rectTransform
protected

◆ _stringBuilder

StringBuilder MoreMountains.Tools.MMDebugOnScreenConsole._stringBuilder
protected

◆ _valueTagEnd

string MoreMountains.Tools.MMDebugOnScreenConsole._valueTagEnd
protected

◆ _valueTagStart

string MoreMountains.Tools.MMDebugOnScreenConsole._valueTagStart
protected

◆ BackgroundImage

Image MoreMountains.Tools.MMDebugOnScreenConsole.BackgroundImage

◆ ConsoleText

Text MoreMountains.Tools.MMDebugOnScreenConsole.ConsoleText

◆ Container

RectTransform MoreMountains.Tools.MMDebugOnScreenConsole.Container

◆ LabelColor

Color MoreMountains.Tools.MMDebugOnScreenConsole.LabelColor = Color.white

◆ space

const string MoreMountains.Tools.MMDebugOnScreenConsole.space = " "
staticprotected

◆ ValueColor

string MoreMountains.Tools.MMDebugOnScreenConsole.ValueColor = "#FFC400"

◆ ValueSizeRatio

float MoreMountains.Tools.MMDebugOnScreenConsole.ValueSizeRatio = 1.35f

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