PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync Class Reference

LipSync() sequencer command for Rogo Digital's LipSync. More...

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

Public Member Functions

void Start ()
 
void Update ()
 
void OnDestroy ()
 
void Start ()
 
void Update ()
 
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.
 

Additional Inherited Members

- Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool isPlaying = true
 Indicates whether the command is still playing.
 
- 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.
 
- 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

LipSync() sequencer command for Rogo Digital's LipSync.

Syntax:

LipSync(lipSyncData, [subject], [nowait])

  • lipSyncData: Name of a LipSync Data asset in a Resources folder.
  • subject: (Optional) The GameObject through which to play the LipSync Data. Must have a LipSync component.
  • nowait: (Optional) If the third argument is 'nowait', the sequencer command kicks off the playback and immediately exits. Otherwise it waits until the playback is done.

Member Function Documentation

◆ OnDestroy() [1/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.OnDestroy ( )
inline

◆ OnDestroy() [2/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.OnDestroy ( )
inline

◆ Start() [1/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.Start ( )
inline

◆ Start() [2/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.Start ( )
inline

◆ Update() [1/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.Update ( )
inline

◆ Update() [2/2]

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLipSync.Update ( )
inline

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