PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand Class Reference

Holds the definition of a sequencer command while it's in the queue. More...

Public Member Functions

 QueuedSequencerCommand (string command, string[] parameters, float startTime, string messageToWaitFor, string endMessage, bool required, Transform speaker=null, Transform listener=null)
 Initializes a new QueuedSequencerCommand. More...
 

Public Attributes

string command
 The command (e.g., Camera). More...
 
string[] parameters
 The parameters to the command. More...
 
float startTime
 The start time when the command should be taken out of the queue and run. More...
 
string messageToWaitFor
 If not null<c/c> stay in the queue until this message is received. More...
 
string endMessage
 An optional message to send the sequencer when the command completes. More...
 
bool required
 If true, the sequencer will run this command even if the sequence is cancelled. More...
 
Transform speaker
 The GameObject assigned as the speaker. More...
 
Transform listener
 The GameObject assigned as the listener. More...
 

Detailed Description

Holds the definition of a sequencer command while it's in the queue.

Constructor & Destructor Documentation

◆ QueuedSequencerCommand()

PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.QueuedSequencerCommand ( string  command,
string[]  parameters,
float  startTime,
string  messageToWaitFor,
string  endMessage,
bool  required,
Transform  speaker = null,
Transform  listener = null 
)

Initializes a new QueuedSequencerCommand.

Parameters
commandThe command.
parametersThe parameters to the command.
startTimeStart time to play the command.
messageToWaitForOptional message to wait for.
endMessageOptional message to send when the command completes.
requiredRequired flag.

Member Data Documentation

◆ command

string PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.command

The command (e.g., Camera).

◆ endMessage

string PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.endMessage

An optional message to send the sequencer when the command completes.

◆ listener

Transform PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.listener

The GameObject assigned as the listener.

◆ messageToWaitFor

string PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.messageToWaitFor

If not null<c/c> stay in the queue until this message is received.

◆ parameters

string [] PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.parameters

The parameters to the command.

◆ required

bool PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.required

If true, the sequencer will run this command even if the sequence is cancelled.

◆ speaker

Transform PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.speaker

The GameObject assigned as the speaker.

◆ startTime

float PixelCrushers.DialogueSystem.SequencerCommands.QueuedSequencerCommand.startTime

The start time when the command should be taken out of the queue and run.


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