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

Implements Waypoint([subject, [displayStyle, [icon, [webColor]]]]). More...

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

Public Member Functions

void 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. 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 Waypoint([subject, [displayStyle, [icon, [webColor]]]]).

  • subject: speaker, listener, or a GameObject name. Default is speaker.
  • displayStyle: Off, Normal, or Pulsing. Default is Normal.
  • icon: Name of a texture in a Resources folder.
  • webColor: Color to change icon and label to.

Member Function Documentation

◆ Start()

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandWaypoint.Start ( )
The documentation for this class was generated from the following file: