A GUI control that contains text. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl:

[legend]

Public Member Functions
override void	Awake ()

virtual void	Start ()

void	UseLocalizedText (LocalizedTextTable localizedText)

void	ApplyAlphaToGUIColor ()

void	RestoreGUIColor ()

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

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	DrawSelf (Vector2 relativeMousePosition)
	Draws the control, but not 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	Refresh ()

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

Public Attributes
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...

Protected Member Functions
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...

Properties
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...

Detailed Description

A GUI control that contains text.

This is the parent class of GUILabel, GUIButton, and GUIWindow.

Member Function Documentation

◆ ApplyAlphaToGUIColor()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.ApplyAlphaToGUIColor ( )

◆ ApplyFormatting()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.ApplyFormatting ( )

protected

Applies the formatting recorded in formattingToApply by SetFormattedText().

SetFormattedText() can't apply the formatting directly because it needs to run in OnGUI.

◆ AutoSizeSelf()

override void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.AutoSizeSelf ( )

virtual

Auto-sizes the control according to the autoSize settings.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ Awake()

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

virtual

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ PlaySound()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.PlaySound ( AudioClip audioClip )

Plays an audio clip.

If the control itself has an AudioSource, it uses it. Otherwise it uses the AudioSource on the main camera, adding one if the main camera doesn't already have one.

Parameters

audioClip Audio clip.

◆ RestoreGUIColor()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.RestoreGUIColor ( )

◆ SetFormattedText()

virtual void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.SetFormattedText ( FormattedText formattedText )

virtual

Sets the control's text and formatting.

Parameters

formattedText Formatted text.

Reimplemented in PixelCrushers.DialogueSystem.UnityGUI.GUILabel.

◆ SetGUIStyle()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.SetGUIStyle ( )

protected

Makes sure the guiStyle property is up-to-date.

◆ SetUnformattedText()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.SetUnformattedText ( string text )

Sets the control's text and formatting using just raw text.

Parameters

text Text.

◆ Start()

virtual void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.Start ( )

virtual

◆ UpdateLayoutSelf()

override void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.UpdateLayoutSelf ( )

virtual

Updates the control's layout but not its children.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ UseLocalizedText()

void PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.UseLocalizedText ( LocalizedTextTable localizedText )

Member Data Documentation

◆ guiStyleName

string PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.guiStyleName

The name of the GUI style to use to draw the text.

◆ localizedText

LocalizedTextTable PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.localizedText

The (optional) localized text table to use.

◆ text

string PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.text

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

Property Documentation

◆ Alpha

float PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.Alpha

getset

Gets or sets the alpha (transparency) value.

The alpha.

◆ DefaultGUIStyle

virtual GUIStyle PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.DefaultGUIStyle

getprotected

Gets the default GUI style to use for this type of control.

It can be overridden on a per-control basis using guiStyleName.

The default GUI style.

◆ GuiStyle

GUIStyle PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.GuiStyle

getsetprotected

The current GUI style.

The GUI style.

◆ HasAlpha

bool PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.HasAlpha

get

Gets a value indicating whether this instance has an alpha that isn't fully opaque.

true if this instance has alpha; otherwise, false.

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/GUIVisibleControl.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ApplyAlphaToGUIColor()

◆ ApplyFormatting()

◆ AutoSizeSelf()

◆ Awake()

◆ PlaySound()

◆ RestoreGUIColor()

◆ SetFormattedText()

◆ SetGUIStyle()

◆ SetUnformattedText()

◆ Start()

◆ UpdateLayoutSelf()

◆ UseLocalizedText()

Member Data Documentation

◆ guiStyleName

◆ localizedText

◆ text

Property Documentation

◆ Alpha

◆ DefaultGUIStyle

◆ GuiStyle

◆ HasAlpha