PixelCrushers.DialogueSystem.UnityGUI Namespace Reference

Classes

class  AudioEffect
 Applies an audio effect (sound) to a GUI control. More...
 
class  AutoSize
 Specifies a control's auto-size settings. More...
 
class  ContinueButtonFastForward
 This script replaces the normal continue button functionality with a two-stage process. More...
 
class  FadeEffect
 Applies a fade effect to a GUI control. More...
 
class  Fit
 Specifies how to fit a control in with its siblings. More...
 
class  FlashEffect
 Applies a flash effect to a GUI control, alternating between visible and invisible. More...
 
class  GUIButton
 A GUI control that implements GUI.Button with optional additional textures. More...
 
class  GUIControl
 The basic GUI control, which simply contains child controls. More...
 
class  GUIEffect
 The base abstract class for GUI effect "decorators" that can be added to GUI controls. More...
 
class  GUIImage
 A GUI control that implements GUI.DrawTexture[WithTexCoords] to display a texture. More...
 
class  GUIImageParams
 Parameters for using GUI.DrawTexture[WithTexCoords]. More...
 
class  GUILabel
 A GUI control that implements GUI.Label to display text and/or a texture. More...
 
class  GUIProgressBar
 A GUI control that implements a flexible progress bar. More...
 
class  GUIRoot
 The root of a GUI layout. More...
 
class  GUIScrollView
 A GUI control that implements GUI.ScrollView. More...
 
class  GUITextField
 A GUI control that implements GUI.TextField for text input. More...
 
class  GUIVisibleControl
 A GUI control that contains text. More...
 
class  GUIWindow
 A GUI control that implements GUI.Window, a draggable window. More...
 
class  ImageAnimation
 Specifies image animation settings. More...
 
class  Navigation
 Specifies keyboard and/or controller navigation settings. More...
 
class  ScaledRect
 Scaled rects allow you to specify resolution-independent rects with a variety of positioning options. More...
 
class  ScaledValue
 A scaled value, which is used by ScaledRect. More...
 
class  SlideEffect
 Applies a slide effect to the GUI control, making it slide onscreen from a direction. More...
 
class  TimerEffect
 Applies a timer effect to a GUIProgressBar that counts down from 1 to 0. More...
 
class  TypewriterEffect
 Applies a typewriter effect to the text of a GUI control. More...
 
class  UnityAlertControls
 GUI controls for UnityDialogueUI's alert message. More...
 
class  UnityBarkUI
 Implements IBarkUI using Unity GUI to show bark text above a character's head. More...
 
class  UnityBarkUIOnGUI
 This is a "child" component created by UnityBarkUI. More...
 
class  UnityDialogueControls
 Contains all dialogue (conversation) controls for a Unity Dialogue UI. More...
 
class  UnityDialogueUI
 This component implements IDialogueUI using Unity GUI. More...
 
class  UnityDialogueUIControls
 Static utility class for Unity GUI Dialogue UI. More...
 
class  UnityGUIQuestLogWindow
 This is a Unity GUI implementation of QuestLogWindow. More...
 
class  UnityGUITools
 Static utility class that provides methods for drawing Unity GUI controls. More...
 
class  UnityQTEControls
 Unity QTE indicator controls. More...
 
class  UnityResponseMenuControls
 Response menu controls for UnityDialogueUI. More...
 
class  UnitySubtitleControls
 Subtitle GUI controls for UnityDialogueUI. More...
 
class  UnityTextFieldUI
 This is a Unity GUI implementation of ITextFieldUI. More...
 
class  UnityUIRoot
 Unity UI root, implemented as a container for GUIRoot. More...
 

Enumerations

enum  GUIEffectTrigger { GUIEffectTrigger.OnEnable }
 The triggers that can start GUI effects. More...
 
enum  ScaledRectAlignment {
  ScaledRectAlignment.TopLeft, ScaledRectAlignment.TopCenter, ScaledRectAlignment.TopRight, ScaledRectAlignment.MiddleLeft,
  ScaledRectAlignment.MiddleCenter, ScaledRectAlignment.MiddleRight, ScaledRectAlignment.BottomLeft, ScaledRectAlignment.BottomCenter,
  ScaledRectAlignment.BottomRight
}
 Specifies an alignment for the origin or alignment of a ScaledRect. More...
 
enum  ValueScale { ValueScale.Pixel, ValueScale.Normalized }
 Specifies the scale of a ScaledValue, which is used by ScaledRect. More...
 
enum  TextStyle { TextStyle.None, TextStyle.Shadow, TextStyle.Outline }
 The TextStyle enum is used by several dialogue system components that draw text using Unity GUI. More...
 

Enumeration Type Documentation

◆ GUIEffectTrigger

The triggers that can start GUI effects.

Currently only OnEnable, but we may add more in the future.

Enumerator
OnEnable 

◆ ScaledRectAlignment

Specifies an alignment for the origin or alignment of a ScaledRect.

Enumerator
TopLeft 

Top left

TopCenter 

Top center

TopRight 

Top right

MiddleLeft 

Middle left

MiddleCenter 

Middle center

MiddleRight 

Middle right

BottomLeft 

Bottom left

BottomCenter 

Bottom center

BottomRight 

Bottom right

◆ TextStyle

The TextStyle enum is used by several dialogue system components that draw text using Unity GUI.

The meanings of the enum values are:

  • None: Draw the text plain, without any special effects.
  • Shadow: Draw a black drop-shadow to the lower right of the text.
  • Outline: Draw a black outline around the text.
Enumerator
None 

Draw the text plain, without any special effects

Shadow 

Draw a black drop-shadow to the lower right of the text

Outline 

Draw a black outline around the text

◆ ValueScale

Specifies the scale of a ScaledValue, which is used by ScaledRect.

  • Pixel: The value is in screen pixels.
  • Normalized: The value is normalized [0..1] to the size of the window/screen.
Enumerator
Pixel 

Value is in screen pixels

Normalized 

Value is normalized [0..1] to the size of the window/screen