Public Member Functions | List of all members
PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandEmote Class Reference

Sequencer command Emote(emoteName, [on|off], [oneway|roundtrip], [duration], [subject], [nowait]) More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandEmote:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandEmote:
Collaboration graph
[legend]

Public Member Functions

IEnumerator Start ()
 
IEnumerator Start ()
 
- 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).
 
T 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

Sequencer command Emote(emoteName, [on|off], [oneway|roundtrip], [duration], [subject], [nowait])

  • emoteName: The emote name.
  • on|off: Turn the emote on or off. Default: on.
  • oneway|roundtrip: ExpressionHandler value. Default: oneway.
  • duration: Duration in seconds. Default: 2.
  • subject: The GameObject with the Emoter component. Default: speaker.
  • nowait: If specified, don't wait for emote to finish.

Member Function Documentation

◆ Start() [1/2]

IEnumerator PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandEmote.Start ( )
inline

◆ Start() [2/2]

IEnumerator PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandEmote.Start ( )
inline
The documentation for this class was generated from the following files: