PixelCrushers.DialogueSystem.SequenceStarter Class Reference

This is the base class for all sequence trigger components. More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequenceStarter:
Collaboration diagram for PixelCrushers.DialogueSystem.SequenceStarter:

Public Member Functions

void TryStartSequence (Transform actor)
 Starts the sequence if the condition is true. More...
 
void TryStartSequence (Transform actor, Transform interactor)
 Starts the sequence if the condition is true. More...
 

Public Attributes

string sequence
 The sequence to play. More...
 
Transform speaker
 The speaker to use for the sequence (or null if no speaker is needed). More...
 
Transform listener
 The listener to use for the sequence (or null if no listener is needed). More...
 
Condition condition
 The condition required to allow the sequence to start. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
bool once = false
 Set true if this event should only happen once. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
void DestroyIfOnce ()
 

Detailed Description

This is the base class for all sequence trigger components.

Member Function Documentation

◆ TryStartSequence() [1/2]

void PixelCrushers.DialogueSystem.SequenceStarter.TryStartSequence ( Transform  actor)

Starts the sequence if the condition is true.

Parameters
actorActor.

◆ TryStartSequence() [2/2]

void PixelCrushers.DialogueSystem.SequenceStarter.TryStartSequence ( Transform  actor,
Transform  interactor 
)

Starts the sequence if the condition is true.

Parameters
actorActor.
interactorInteractor to test the condition against.

Member Data Documentation

◆ condition

Condition PixelCrushers.DialogueSystem.SequenceStarter.condition

The condition required to allow the sequence to start.

◆ listener

Transform PixelCrushers.DialogueSystem.SequenceStarter.listener

The listener to use for the sequence (or null if no listener is needed).

Sequence commands can reference 'speaker' and 'listener', so you may need to define them in this component.

◆ sequence

string PixelCrushers.DialogueSystem.SequenceStarter.sequence

The sequence to play.

See sequencer

◆ speaker

Transform PixelCrushers.DialogueSystem.SequenceStarter.speaker

The speaker to use for the sequence (or null if no speaker is needed).

Sequence commands can reference 'speaker' and 'listener', so you may need to define them in this component.


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