A GUI control that implements GUI.Label to display text and/or a texture. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.GUILabel:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.GUILabel:

[legend]

Public Member Functions
override void	Awake ()

void	ResetClosureTags ()
	Resets the stack of rich text tags to close. More...

void	PushClosureTag (string tag)
	Adds a closure tag to the stack. More...

void	PopClosureTag ()
	Pops the top closure tag from the stack. More...

override void	SetFormattedText (FormattedText formattedText)
	Sets the control's text and formatting. More...

override void	DrawSelf (Vector2 relativeMousePosition)
	Draws the control, but not its children. More...

override void	Refresh ()

Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
override void	Awake ()

virtual void	Start ()

void	UseLocalizedText (LocalizedTextTable localizedText)

void	ApplyAlphaToGUIColor ()

void	RestoreGUIColor ()

void	SetUnformattedText (string text)
	Sets the control's text and formatting using just raw text. More...

override void	UpdateLayoutSelf ()
	Updates the control's layout but not its children. More...

override void	AutoSizeSelf ()
	Auto-sizes the control according to the autoSize settings. More...

void	PlaySound (AudioClip audioClip)
	Plays an audio clip. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void	OnEnable ()
	Checks if the control needs to enable the first child for key/controller navigation. More...

void	Draw (Vector2 relativeMousePosition)
	Draw the control and its children. More...

virtual void	DrawChildren (Vector2 relativeMousePosition)
	Draws the children, taking into account key/controller navigation if enabled. More...

virtual void	Update ()
	If navigation is enabled, check if the selection button was pressed. More...

virtual void	Refresh (Vector2 windowSize)
	Marks a control as needing to update its layout. More...

virtual void	UpdateLayout ()
	Updates the layout (size, position, formatting, etc.) of the control and its children. More...

Public Attributes
TextStyle	textStyle = TextStyle.None
	The text style for the text. More...

Color	textStyleColor = Color.black
	The color of the text style's outline or shadow. More...

Color	imageColor = Color.white
	The color to tint the image. More...

Texture2D	image
	An image to display (may be unassigned). More...

ImageAnimation	imageAnimation = new ImageAnimation()
	The image animation settings. More...

Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
LocalizedTextTable	localizedText
	The (optional) localized text table to use. More...

string	text
	The text content, or the name of the field in the localized text table. More...

string	guiStyleName
	The name of the GUI style to use to draw the text. More...

Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
int	depth = 0
	The drawing order depth. More...

bool	depthSortChildren = false
	If `true`, children are drawn in depth order; otherwise no specific order. More...

ScaledRect	scaledRect = new ScaledRect(ScaledRect.wholeScreen)
	The scaled rect defining the position of the control. More...

AutoSize	autoSize
	Auto-size settings. More...

Fit	fit
	Fit settings. More...

Navigation	navigation
	Keyboard/controller navigation settings. More...

bool	visible = true
	If `true`, this control and its children are visible. More...

bool	clipChildren = true
	Clip children to the control's bounds? More...

Properties
int	currentLength `[get, set]`
	Gets or sets the length of the current amount of text to display. More...

Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
float	Alpha `[get, set]`
	Gets or sets the alpha (transparency) value. More...

bool	HasAlpha `[get]`
	Gets a value indicating whether this instance has an alpha that isn't fully opaque. More...

virtual GUIStyle	DefaultGUIStyle `[get]`
	Gets the default GUI style to use for this type of control. More...

GUIStyle	GuiStyle `[get, set]`
	The current GUI style. More...

Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
Rect	rect `[get, set]`
	The pixel rect represented by scaledRect. More...

Vector2	Offset `[get, set]`
	Gets or sets the offset to apply to the screen rect for this control; useful for manual repositioning outside the normal GUI control system. More...

List< GUIControl >	Children `[get]`
	The child controls. More...

bool	NeedToUpdateLayout `[get, set]`
	When `true`, the control needs to update its style, size, position, etc. More...

Vector2	WindowSize `[get, set]`
	The size of the window most recently passed to Refresh(). More...

bool	IsNavigationEnabled `[get]`
	Gets a value indicating whether keyboard/controller navigation is enabled. More...

string	FullName `[get]`
	Gets the full name of the GameObject, used to focus the control when using keyboard/controller navigation. More...

Vector2	dRect `[get, set]`
	Gets or sets dRect, which offsets the rect when the parent window isn't clipping. More...

Additional Inherited Members
Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
void	SetGUIStyle ()
	Makes sure the guiStyle property is up-to-date. More...

void	ApplyFormatting ()
	Applies the formatting recorded in formattingToApply by SetFormattedText(). More...

Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void	FitSelf ()
	Fits the control according to the fit settings. More...

Detailed Description

A GUI control that implements GUI.Label to display text and/or a texture.

Member Function Documentation

◆ Awake()

override void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.Awake ( )

virtual

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ DrawSelf()

override void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.DrawSelf ( Vector2 relativeMousePosition )

virtual

Draws the control, but not its children.

Parameters

relativeMousePosition Relative mouse position within the window containing this control.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ PopClosureTag()

void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.PopClosureTag ( )

Pops the top closure tag from the stack.

Parameters

tag Tag.

◆ PushClosureTag()

void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.PushClosureTag ( string tag )

Adds a closure tag to the stack.

Parameters

tag Tag.

◆ Refresh()

override void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.Refresh ( )

virtual

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ ResetClosureTags()

void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.ResetClosureTags ( )

Resets the stack of rich text tags to close.

◆ SetFormattedText()

override void PixelCrushers.DialogueSystem.UnityGUI.GUILabel.SetFormattedText ( FormattedText formattedText )

virtual

Sets the control's text and formatting.

Also resets the rich text tag count.

Parameters

formattedText Formatted text.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.

Member Data Documentation

◆ image

Texture2D PixelCrushers.DialogueSystem.UnityGUI.GUILabel.image

An image to display (may be unassigned).

◆ imageAnimation

ImageAnimation PixelCrushers.DialogueSystem.UnityGUI.GUILabel.imageAnimation = new ImageAnimation()

The image animation settings.

◆ imageColor

Color PixelCrushers.DialogueSystem.UnityGUI.GUILabel.imageColor = Color.white

The color to tint the image.

◆ textStyle

TextStyle PixelCrushers.DialogueSystem.UnityGUI.GUILabel.textStyle = TextStyle.None

The text style for the text.

◆ textStyleColor

Color PixelCrushers.DialogueSystem.UnityGUI.GUILabel.textStyleColor = Color.black

The color of the text style's outline or shadow.

Property Documentation

◆ currentLength

int PixelCrushers.DialogueSystem.UnityGUI.GUILabel.currentLength

getset

Gets or sets the length of the current amount of text to display.

This is a support property for effects like TypewriterEffect.

The length of the current substring.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Unity GUI/GUI Controls/GUILabel.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ DrawSelf()

◆ PopClosureTag()

◆ PushClosureTag()

◆ Refresh()

◆ ResetClosureTags()

◆ SetFormattedText()

Member Data Documentation

◆ image

◆ imageAnimation

◆ imageColor

◆ textStyle

◆ textStyleColor

Property Documentation

◆ currentLength