A GUI control that contains text. More...
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. | |
void | SetUnformattedText (string text) |
Sets the control's text and formatting using just raw text. | |
override void | UpdateLayoutSelf () |
Updates the control's layout but not its children. | |
override void | AutoSizeSelf () |
Auto-sizes the control according to the autoSize settings. | |
void | PlaySound (AudioClip audioClip) |
Plays an audio clip. | |
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. | |
void | Draw (Vector2 relativeMousePosition) |
Draw the control and its children. | |
virtual void | DrawSelf (Vector2 relativeMousePosition) |
Draws the control, but not its children. | |
virtual void | DrawChildren (Vector2 relativeMousePosition) |
Draws the children, taking into account key/controller navigation if enabled. | |
virtual void | Update () |
If navigation is enabled, check if the selection button was pressed. | |
virtual void | Refresh (Vector2 windowSize) |
Marks a control as needing to update its layout. | |
virtual void | Refresh () |
virtual void | UpdateLayout () |
Updates the layout (size, position, formatting, etc.) of the control and its children. | |
Public Attributes | |
LocalizedTextTable | localizedText |
The (optional) localized text table to use. | |
string | text |
The text content, or the name of the field in the localized text table. | |
string | guiStyleName |
The name of the GUI style to use to draw the text. | |
Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl | |
int | depth = 0 |
The drawing order depth. | |
bool | depthSortChildren = false |
If true , children are drawn in depth order; otherwise no specific order. | |
ScaledRect | scaledRect = new ScaledRect(ScaledRect.wholeScreen) |
The scaled rect defining the position of the control. | |
AutoSize | autoSize |
Auto-size settings. | |
Fit | fit |
Fit settings. | |
Navigation | navigation |
Keyboard/controller navigation settings. | |
bool | visible = true |
If true , this control and its children are visible. | |
bool | clipChildren = true |
Clip children to the control's bounds? | |
Protected Member Functions | |
void | SetGUIStyle () |
Makes sure the guiStyle property is up-to-date. | |
void | ApplyFormatting () |
Applies the formatting recorded in formattingToApply by SetFormattedText(). | |
Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl | |
virtual void | FitSelf () |
Fits the control according to the fit settings. | |
Properties | |
float | Alpha [get, set] |
Gets or sets the alpha (transparency) value. | |
bool | HasAlpha [get] |
Gets a value indicating whether this instance has an alpha that isn't fully opaque. | |
virtual GUIStyle | DefaultGUIStyle [get] |
Gets the default GUI style to use for this type of control. | |
GUIStyle | GuiStyle [get, set] |
The current GUI style. | |
Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl | |
Rect | rect [get, set] |
The pixel rect represented by scaledRect. | |
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. | |
List< GUIControl > | Children [get] |
The child controls. | |
bool | NeedToUpdateLayout [get, set] |
When true , the control needs to update its style, size, position, etc. | |
Vector2 | WindowSize [get, set] |
The size of the window most recently passed to Refresh(). | |
bool | IsNavigationEnabled [get] |
Gets a value indicating whether keyboard/controller navigation is enabled. | |
string | FullName [get] |
Gets the full name of the GameObject, used to focus the control when using keyboard/controller navigation. | |
Vector2 | dRect [get, set] |
Gets or sets dRect, which offsets the rect when the parent window isn't clipping. | |
A GUI control that contains text.
This is the parent class of GUILabel, GUIButton, and GUIWindow.
|
inline |
|
inlineprotected |
Applies the formatting recorded in formattingToApply by SetFormattedText().
SetFormattedText() can't apply the formatting directly because it needs to run in OnGUI.
|
inlinevirtual |
Auto-sizes the control according to the autoSize settings.
Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.
|
inlinevirtual |
Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.
|
inline |
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.
audioClip | Audio clip. |
|
inline |
|
inlinevirtual |
Sets the control's text and formatting.
formattedText | Formatted text. |
Reimplemented in PixelCrushers.DialogueSystem.UnityGUI.GUILabel.
|
inlineprotected |
Makes sure the guiStyle property is up-to-date.
|
inline |
Sets the control's text and formatting using just raw text.
text | Text. |
|
inlinevirtual |
|
inlinevirtual |
Updates the control's layout but not its children.
Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.
|
inline |
string PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.guiStyleName |
The name of the GUI style to use to draw the text.
LocalizedTextTable PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.localizedText |
The (optional) localized text table to use.
string PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl.text |
The text content, or the name of the field in the localized text table.
|
getset |
Gets or sets the alpha (transparency) value.
The alpha.
|
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.
|
getsetprotected |
The current GUI style.
The GUI style.
|
get |
Gets a value indicating whether this instance has an alpha that isn't fully opaque.
true
if this instance has alpha; otherwise, false
.