A Unity UI response button for use with UnityUIDialogueControls.
More...
|
UnityEngine.UI.Button | button |
| The UnityUI button.
|
|
UnityEngine.UI.Text | label |
| The UnityUI label that will display the response text.
|
|
Color | defaultColor = Color.white |
| The default color for response text.
|
|
bool | setButtonColor = false |
| Set true to set the button color when applying emphasis tags.
|
|
bool | setLabelColor = true |
| Set true to set the label color when applying emphasis tags.
|
|
|
virtual void | SetColor (Color currentColor) |
|
|
string | Text [get, set] |
| Gets or sets the response text.
|
|
bool | clickable [get, set] |
| Indicates whether the button is an allowable response.
|
|
bool | visible [get, set] |
| Indicates whether the button is shown or not.
|
|
Response | response [get, set] |
| Gets or sets the response associated with this button.
|
|
Transform | target [get, set] |
| Gets or sets the target that will receive click notifications.
|
|
A Unity UI response button for use with UnityUIDialogueControls.
Add this component to every response button in the dialogue UI.
◆ Awake()
void PixelCrushers.DialogueSystem.UnityUIResponseButton.Awake |
( |
| ) |
|
|
inline |
◆ OnClick()
void PixelCrushers.DialogueSystem.UnityUIResponseButton.OnClick |
( |
| ) |
|
|
inline |
Handles a button click by calling the response handler.
◆ Reset()
void PixelCrushers.DialogueSystem.UnityUIResponseButton.Reset |
( |
| ) |
|
|
inline |
◆ SetColor()
virtual void PixelCrushers.DialogueSystem.UnityUIResponseButton.SetColor |
( |
Color |
currentColor | ) |
|
|
inlineprotectedvirtual |
◆ SetFormattedText()
void PixelCrushers.DialogueSystem.UnityUIResponseButton.SetFormattedText |
( |
FormattedText |
formattedText | ) |
|
|
inline |
Sets the button's text using the specified formatted text.
- Parameters
-
formattedText | The formatted text for the button label. |
◆ SetUnformattedText()
void PixelCrushers.DialogueSystem.UnityUIResponseButton.SetUnformattedText |
( |
string |
unformattedText | ) |
|
|
inline |
Sets the button's text using plain text.
- Parameters
-
unformattedText | Unformatted text for the button label. |
◆ button
UnityEngine.UI.Button PixelCrushers.DialogueSystem.UnityUIResponseButton.button |
◆ defaultColor
Color PixelCrushers.DialogueSystem.UnityUIResponseButton.defaultColor = Color.white |
The default color for response text.
◆ label
UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUIResponseButton.label |
The UnityUI label that will display the response text.
◆ setButtonColor
bool PixelCrushers.DialogueSystem.UnityUIResponseButton.setButtonColor = false |
Set true
to set the button color when applying emphasis tags.
◆ setLabelColor
bool PixelCrushers.DialogueSystem.UnityUIResponseButton.setLabelColor = true |
Set true
to set the label color when applying emphasis tags.
◆ clickable
bool PixelCrushers.DialogueSystem.UnityUIResponseButton.clickable |
|
getset |
Indicates whether the button is an allowable response.
true
if clickable; otherwise, false
.
◆ response
Response PixelCrushers.DialogueSystem.UnityUIResponseButton.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.
The response.
◆ target
Transform PixelCrushers.DialogueSystem.UnityUIResponseButton.target |
|
getset |
Gets or sets the target that will receive click notifications.
The target.
◆ Text
string PixelCrushers.DialogueSystem.UnityUIResponseButton.Text |
|
getset |
Gets or sets the response text.
The text.
◆ visible
bool PixelCrushers.DialogueSystem.UnityUIResponseButton.visible |
|
getset |
Indicates whether the button is shown or not.
true
if visible; otherwise, false
.
The documentation for this class was generated from the following file:
- C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Unity UI/Dialogue/UnityUIResponseButton.cs