StandardDialogueUI input field implementation. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIInputField:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIInputField:

[legend]

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

virtual void	CancelTextInput ()
	Cancels the text input field.

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

Public Member Functions inherited from PixelCrushers.UIPanel
void	RefreshSelectablesList ()

void	RefreshAfterOneFrame ()

void	TakeFocus ()
	Move this panel to the top of the stack.

virtual void	Open ()

virtual void	Close ()

virtual void	SetOpen (bool value)

virtual void	Toggle ()

virtual void	SetFocus (GameObject selectable)

virtual void	CheckFocus ()

Public Attributes
UnityEngine.UI.Graphic	panel

UITextField	label

UIInputField	inputField

KeyCode	acceptKey = KeyCode.Return

string	acceptButton = string.Empty

KeyCode	cancelKey = KeyCode.Escape

string	cancelButton = string.Empty

bool	showTouchScreenKeyboard = false

bool	allowBlankInput = true

UnityEvent	onAccept = new UnityEvent()

UnityEvent	onCancel = new UnityEvent()

Public Attributes inherited from PixelCrushers.UIPanel
GameObject	firstSelected

float	focusCheckFrequency = 0.2f

float	refreshSelectablesFrequency = 0

bool	selectPreviousOnDisable = true

string	showAnimationTrigger = "Show"

string	hideAnimationTrigger = "Hide"

StartState	startState = StartState.GameObjectState

bool	waitForShowAnimationToSetOpen = false

UnityEvent	onOpen = new UnityEvent()

UnityEvent	onClose = new UnityEvent()

UnityEvent	onClosed = new UnityEvent()

UnityEvent	onBackButtonDown = new UnityEvent()

Protected Member Functions
virtual void	OnApplicationQuit ()

override void	Start ()

override void	Update ()

virtual void	Show ()

virtual void	ShowTouchScreenKeyboard ()

virtual void	Hide ()

virtual void	SetActive (bool value)

Protected Member Functions inherited from PixelCrushers.UIPanel
void	PushToPanelStack ()

void	PopFromPanelStack ()

virtual void	OnEnable ()

virtual void	OnDisable ()

virtual void	OnVisible ()

virtual void	OnHidden ()

GameObject	GetFirstInteractableButton ()

Protected Attributes
AcceptedTextDelegate	m_acceptedText = null
	Call this delegate when the player accepts the input in the text field.

bool	m_isAwaitingInput = false

TouchScreenKeyboard	m_touchScreenKeyboard = null

bool	m_isQuitting = false

Protected Attributes inherited from PixelCrushers.UIPanel
bool	m_deactivateOnHidden = true

GameObject	m_previousSelected = null

GameObject	m_lastSelected = null

List< GameObject >	selectables = new List<GameObject>()

Additional Inherited Members
Public Types inherited from PixelCrushers.UIPanel
enum	StartState { GameObjectState , Open , Closed }

enum	PanelState { Uninitialized , Opening , Open , Closing , Closed }

Static Public Attributes inherited from PixelCrushers.UIPanel
static bool	monitorSelection = true
	If false, turns off checking of current selection to make sure a valid selectable is selected.

Static Protected Attributes inherited from PixelCrushers.UIPanel
static List< UIPanel >	panelStack = new List<UIPanel>()

Properties inherited from PixelCrushers.UIPanel
bool	deactivateOnHidden `[get, set]`

static UIPanel	topPanel `[get]`

PanelState	panelState `[get, set]`

virtual bool	waitForShowAnimation `[get, set]`

bool	isOpen `[get]`

UIAnimatorMonitor	animatorMonitor `[get]`

UnityEngine.EventSystems.EventSystem	eventSystem `[get, set]`

Properties inherited from PixelCrushers.IEventSystemUser

Detailed Description

StandardDialogueUI input field implementation.

Member Function Documentation

◆ AcceptTextInput()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.AcceptTextInput ( )

inlinevirtual

Accepts the text input and calls the accept handler delegate.

◆ CancelTextInput()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.CancelTextInput ( )

inlinevirtual

Cancels the text input field.

Implements PixelCrushers.DialogueSystem.ITextFieldUI.

◆ Hide()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.Hide ( )

inlineprotectedvirtual

◆ OnApplicationQuit()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.OnApplicationQuit ( )

inlineprotectedvirtual

◆ SetActive()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.SetActive ( bool value )

inlineprotectedvirtual

◆ Show()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.Show ( )

inlineprotectedvirtual

◆ ShowTouchScreenKeyboard()

virtual void PixelCrushers.DialogueSystem.StandardUIInputField.ShowTouchScreenKeyboard ( )

inlineprotectedvirtual

◆ Start()

override void PixelCrushers.DialogueSystem.StandardUIInputField.Start ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.UIPanel.

◆ StartTextInput()

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

inlinevirtual

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()

override void PixelCrushers.DialogueSystem.StandardUIInputField.Update ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.UIPanel.

Member Data Documentation

◆ acceptButton

string PixelCrushers.DialogueSystem.StandardUIInputField.acceptButton = string.Empty

◆ acceptKey

KeyCode PixelCrushers.DialogueSystem.StandardUIInputField.acceptKey = KeyCode.Return

◆ allowBlankInput

bool PixelCrushers.DialogueSystem.StandardUIInputField.allowBlankInput = true

◆ cancelButton

string PixelCrushers.DialogueSystem.StandardUIInputField.cancelButton = string.Empty

◆ cancelKey

KeyCode PixelCrushers.DialogueSystem.StandardUIInputField.cancelKey = KeyCode.Escape

◆ inputField

UIInputField PixelCrushers.DialogueSystem.StandardUIInputField.inputField

◆ label

UITextField PixelCrushers.DialogueSystem.StandardUIInputField.label

◆ m_acceptedText

AcceptedTextDelegate PixelCrushers.DialogueSystem.StandardUIInputField.m_acceptedText = null

protected

Call this delegate when the player accepts the input in the text field.

◆ m_isAwaitingInput

bool PixelCrushers.DialogueSystem.StandardUIInputField.m_isAwaitingInput = false

protected

◆ m_isQuitting

bool PixelCrushers.DialogueSystem.StandardUIInputField.m_isQuitting = false

protected

◆ m_touchScreenKeyboard

TouchScreenKeyboard PixelCrushers.DialogueSystem.StandardUIInputField.m_touchScreenKeyboard = null

protected

◆ onAccept

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

◆ onCancel

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

◆ panel

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.StandardUIInputField.panel

◆ showTouchScreenKeyboard

bool PixelCrushers.DialogueSystem.StandardUIInputField.showTouchScreenKeyboard = 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/Standard/Dialogue/StandardUIInputField.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AcceptTextInput()

◆ CancelTextInput()

◆ Hide()

◆ OnApplicationQuit()

◆ SetActive()

◆ Show()

◆ ShowTouchScreenKeyboard()

◆ Start()

◆ StartTextInput()

◆ Update()

Member Data Documentation

◆ acceptButton

◆ acceptKey

◆ allowBlankInput

◆ cancelButton

◆ cancelKey

◆ inputField

◆ label

◆ m_acceptedText

◆ m_isAwaitingInput

◆ m_isQuitting

◆ m_touchScreenKeyboard

◆ onAccept

◆ onCancel

◆ panel

◆ showTouchScreenKeyboard