Unity UI text field UI implementation. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityUITextFieldUI:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityUITextFieldUI:

[legend]

Public Member Functions
void	StartTextInput (string labelText, string text, int maxLength, AcceptedTextDelegate acceptedText)
	Starts the text input field. More...

void	Update ()

void	CancelTextInput ()
	Cancels the text input field. More...

void	AcceptTextInput ()
	Accepts the text input and calls the accept handler delegate. More...

Public Attributes
UnityEngine.UI.Graphic	panel
	The (optional) panel. More...

UnityEngine.UI.Text	label
	The label that will contain any label text prompting the user what to enter. More...

UnityEngine.UI.InputField	textField
	The text field. More...

KeyCode	acceptKey = KeyCode.Return
	The accept key. More...

KeyCode	cancelKey = KeyCode.Escape
	The cancel key. More...

bool	showTouchScreenKeyboard = false

UnityEvent	onAccept = new UnityEvent()

UnityEvent	onCancel = new UnityEvent()

Detailed Description

Unity UI text field UI implementation.

Member Function Documentation

◆ AcceptTextInput()

void PixelCrushers.DialogueSystem.UnityUITextFieldUI.AcceptTextInput ( )

Accepts the text input and calls the accept handler delegate.

◆ CancelTextInput()

void PixelCrushers.DialogueSystem.UnityUITextFieldUI.CancelTextInput ( )

Cancels the text input field.

Implements PixelCrushers.DialogueSystem.ITextFieldUI.

◆ StartTextInput()

void PixelCrushers.DialogueSystem.UnityUITextFieldUI.StartTextInput	(	string	labelText,
		string	text,
		int	maxLength,
		AcceptedTextDelegate	acceptedText
	)

Starts the text input field.

Parameters

labelText	The label text.
text	The current value to use for the input field.
maxLength	Max length, or `0` for unlimited.
acceptedText	The delegate to call when accepting text.

Implements PixelCrushers.DialogueSystem.ITextFieldUI.

◆ Update()

void PixelCrushers.DialogueSystem.UnityUITextFieldUI.Update ( )

Member Data Documentation

◆ acceptKey

KeyCode PixelCrushers.DialogueSystem.UnityUITextFieldUI.acceptKey = KeyCode.Return

The accept key.

◆ cancelKey

KeyCode PixelCrushers.DialogueSystem.UnityUITextFieldUI.cancelKey = KeyCode.Escape

The cancel key.

◆ label

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUITextFieldUI.label

The label that will contain any label text prompting the user what to enter.

◆ onAccept

UnityEvent PixelCrushers.DialogueSystem.UnityUITextFieldUI.onAccept = new UnityEvent()

◆ onCancel

UnityEvent PixelCrushers.DialogueSystem.UnityUITextFieldUI.onCancel = new UnityEvent()

◆ panel

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUITextFieldUI.panel

The (optional) panel.

If your text field UI contains more than a label and text field, you should assign the panel, too.

◆ showTouchScreenKeyboard

bool PixelCrushers.DialogueSystem.UnityUITextFieldUI.showTouchScreenKeyboard = false

◆ textField

UnityEngine.UI.InputField PixelCrushers.DialogueSystem.UnityUITextFieldUI.textField

The text field.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Release/Assets/Dialogue System/Scripts/Supplemental/UI/Dialogue UI/UnityUITextFieldUI.cs

Public Member Functions

Public Attributes