PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE Class Reference

Implements sequencer command: "QTE(index, duration, luaVariable, luaValue)", which presents a timed opportunity to perform a Quick Time Event. More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE:
Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE:

Public Member Functions

virtual void Start ()
 
virtual void Update ()
 
virtual void OnDestroy ()
 
- 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.
 
void Initialize (Sequencer sequencer, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties.
 

Protected Member Functions

virtual FieldType GetVariableType ()
 
virtual string ValueAsString (FieldType fieldType, string fieldValue)
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Stop ()
 Call this method to indicate that the command is done playing.
 
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).
 
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).
 
string GetParameter (int i, string defaultValue=null)
 Gets the i-th parameter (zero-based).
 
GetParameterAs< T > (int i, T defaultValue)
 Gets the i-th parameter (zero-based) as a specified type.
 
float GetParameterAsFloat (int i, float defaultValue=0)
 Gets the i-th parameter as a float.
 
int GetParameterAsInt (int i, int defaultValue=0)
 Gets the i-th parameter as an int.
 
bool GetParameterAsBool (int i, bool defaultValue=false)
 Gets the i-th parameter as a bool.
 
string GetParameters ()
 Gets the parameters as a comma-separated string.
 
bool IsAudioMuted ()
 Checks whether a Lua variable "Mute" is defined and true.
 

Protected Attributes

int index
 
float stopTime
 
string button
 
string variableName
 
string variableQTEValue
 
FieldType variableType
 

Additional Inherited Members

- Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool isPlaying = true
 Indicates whether the command is still playing.
 
- Properties inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
Sequencer sequencer [get]
 Reference to the Sequencer, so you can access its properties such as SequencerCamera and CameraAngles.
 
string[] parameters [get]
 The parameters for the command.
 
string endMessage [get]
 Optional message to send the sequencer when the command completes.
 
Transform speaker [get]
 
Transform listener [get]
 

Detailed Description

Implements sequencer command: "QTE(index, duration, luaVariable, luaValue)", which presents a timed opportunity to perform a Quick Time Event.

Arguments:

  1. The index number of the QTE indicator. (QTE indicators are defined the dialogue UI.)
  2. The duration to display the QTE indicator.
  3. The Lua variable to set if the QTE is triggered.
  4. The value to set the variable to. If not trigger, the variable is set to a blank string.

Member Function Documentation

◆ GetVariableType()

virtual FieldType PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.GetVariableType ( )
inlineprotectedvirtual

◆ OnDestroy()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.OnDestroy ( )
inlinevirtual

◆ Start()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.Start ( )
inlinevirtual

◆ Update()

virtual void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.Update ( )
inlinevirtual

◆ ValueAsString()

virtual string PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.ValueAsString ( FieldType  fieldType,
string  fieldValue 
)
inlineprotectedvirtual

Member Data Documentation

◆ button

string PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.button
protected

◆ index

int PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.index
protected

◆ stopTime

float PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.stopTime
protected

◆ variableName

string PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.variableName
protected

◆ variableQTEValue

string PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.variableQTEValue
protected

◆ variableType

FieldType PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandQTE.variableType
protected

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