PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput Class Reference

Implements sequencer command: TextInput(textFieldUI, label, luaVariableName[, maxLength[, clear]]). More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput:

Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput:

Public Member Functions
void	Start ()
	Start the sequence and its corresponding text field UI. More...
void	OnAcceptedText (string text)
	When the text field UI calls our OnAcceptedText delegate, record the value into the Lua variable and stop this sequence. More...
void	OnDestroy ()
	Finishes this sequence. More...
Public Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void	Initialize (Sequencer sequencer, string endMessage, Transform speaker, Transform listener, params string[] parameters)
	Initializes the base properties. More...
void	Initialize (Sequencer sequencer, Transform speaker, Transform listener, params string[] parameters)
	Initializes the base properties. More...

Additional Inherited Members
Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void	Stop ()
	Call this method to indicate that the command is done playing. More...
Transform	GetSubject (string specifier, Transform defaultSubject=null)
	Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera). More...
Transform	GetSubject (int i, Transform defaultSubject=null)
	Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera). More...
string	GetParameter (int i, string defaultValue=null)
	Gets the i-th parameter (zero-based). More...
T	GetParameterAs< T > (int i, T defaultValue)
	Gets the i-th parameter (zero-based) as a specified type. More...
float	GetParameterAsFloat (int i, float defaultValue=0)
	Gets the i-th parameter as a float. More...
int	GetParameterAsInt (int i, int defaultValue=0)
	Gets the i-th parameter as an int. More...
bool	GetParameterAsBool (int i, bool defaultValue=false)
	Gets the i-th parameter as a bool. More...
string	GetParameters ()
	Gets the parameters as a comma-separated string. More...
bool	IsAudioMuted ()
	Checks whether a Lua variable "Mute" is defined and true. More...
Properties inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool	IsPlaying [get, protected set]
	Indicates whether the command is still playing. More...
Sequencer	Sequencer [get]
	Reference to the Sequencer, so you can access its properties such as SequencerCamera and CameraAngles. More...
string[]	Parameters [get]
	The parameters for the command. More...
string	endMessage [get]
	Optional message to send the sequencer when the command completes. More...
Transform??	speaker [get]
Transform??	listener [get]

Detailed Description

Implements sequencer command: TextInput(textFieldUI, label, luaVariableName[, maxLength[, clear]]).

• textFieldUI: the name of GameObject with an ITextFieldUI.
• label: the label text, or var=varName to use a variable value as the label.
• luaVariableName: where to store the input
• maxLength: max length of input to accept
• clear: optional; specifies to start with an empty string instead of variable value.

Member Function Documentation

OnAcceptedText()

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput.OnAcceptedText

(

string

text

)

When the text field UI calls our OnAcceptedText delegate, record the value into the Lua variable and stop this sequence.

Parameters

text

Text.

OnDestroy()

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput.OnDestroy

(

)

Finishes this sequence.

If we haven't accepted text yet, tell the text field UI to cancel.

Start()

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandTextInput.Start

(

)

Start the sequence and its corresponding text field UI.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Core/Model-View-Controller/View/Sequencer/Sequencer Commands/SequencerCommandTextInput.cs