Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
PixelCrushers.DialogueSystem.StandardUIResponseButton Class Reference

Response button for use with Standard Dialogue UI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIResponseButton:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIResponseButton:
Collaboration graph
[legend]

Public Member Functions

virtual void Reset ()
 Clears the button.
 
virtual void Awake ()
 
virtual void Start ()
 
virtual void SetFormattedText (FormattedText formattedText)
 Sets the button's text using the specified formatted text.
 
virtual void SetUnformattedText (string unformattedText)
 Sets the button's text using plain text.
 
virtual void OnClick ()
 Handles a button click by calling the response handler.
 
virtual void OnSelect (BaseEventData eventData)
 

Public Attributes

UnityEngine.UI.Button button
 
UITextField label
 
bool setLabelColor = true
 
Color defaultColor = Color.white
 

Protected Member Functions

virtual void SetColor (Color currentColor)
 
virtual void SetCurrentResponse ()
 

Properties

virtual string text [get, set]
 Gets or sets the response text element.
 
virtual bool isClickable [get, set]
 Indicates whether the button is an allowable response.
 
virtual bool isVisible [get, set]
 Indicates whether the button is shown or not.
 
virtual Response response [get, set]
 Gets or sets the response associated with this button.
 
virtual Transform target [get, set]
 Gets or sets the target that will receive click notifications.
 

Detailed Description

Response button for use with Standard Dialogue UI.

Add this component to every response button in the dialogue UI.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.Awake ( )
inlinevirtual

◆ OnClick()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.OnClick ( )
inlinevirtual

Handles a button click by calling the response handler.

◆ OnSelect()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.OnSelect ( BaseEventData  eventData)
inlinevirtual

◆ Reset()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.Reset ( )
inlinevirtual

Clears the button.

◆ SetColor()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.SetColor ( Color  currentColor)
inlineprotectedvirtual

◆ SetCurrentResponse()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.SetCurrentResponse ( )
inlineprotectedvirtual

◆ SetFormattedText()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.SetFormattedText ( FormattedText  formattedText)
inlinevirtual

Sets the button's text using the specified formatted text.

◆ SetUnformattedText()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.SetUnformattedText ( string  unformattedText)
inlinevirtual

Sets the button's text using plain text.

◆ Start()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseButton.Start ( )
inlinevirtual

Member Data Documentation

◆ button

UnityEngine.UI.Button PixelCrushers.DialogueSystem.StandardUIResponseButton.button

◆ defaultColor

Color PixelCrushers.DialogueSystem.StandardUIResponseButton.defaultColor = Color.white

◆ label

UITextField PixelCrushers.DialogueSystem.StandardUIResponseButton.label

◆ setLabelColor

bool PixelCrushers.DialogueSystem.StandardUIResponseButton.setLabelColor = true

Property Documentation

◆ isClickable

virtual bool PixelCrushers.DialogueSystem.StandardUIResponseButton.isClickable
getset

Indicates whether the button is an allowable response.

◆ isVisible

virtual bool PixelCrushers.DialogueSystem.StandardUIResponseButton.isVisible
getset

Indicates whether the button is shown or not.

◆ response

virtual Response PixelCrushers.DialogueSystem.StandardUIResponseButton.response
getset

Gets or sets the response associated with this button.

If the player clicks this button, this response is sent back to the dialogue system.

◆ target

virtual Transform PixelCrushers.DialogueSystem.StandardUIResponseButton.target
getset

Gets or sets the target that will receive click notifications.

◆ text

virtual string PixelCrushers.DialogueSystem.StandardUIResponseButton.text
getset

Gets or sets the response text element.

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