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

Implements the Behavior Designer sequencer command Behavior(subject, start|stop|pause|resume, [group]). More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandBehavior:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandBehavior:
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.
 
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

Implements the Behavior Designer sequencer command Behavior(subject, start|stop|pause|resume, [group]).

  • subject: The name of a GameObject containing a behavior tree, or speaker<c> or listener. The behavior tree can be located on a child object.
  • start|stop|pause|resume: Control action for the behavior tree.
    • start: Starts or restarts the behavior tree.
    • stop: Stops the behavior tree.
    • pause: Pauses the behavior tree.
    • resume: Resumes the behavior tree if paused.
  • group: (Optional) Apply to behavior trees with a specific group ID. If omitted, apply to all behavior trees on subject.

Member Function Documentation

◆ Start()

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