Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PixelCrushers.DialogueSystem.ConversationControl Class Reference

Provides AutoPlay and SkipAll functionality. More...

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

Public Member Functions

virtual void ToggleAutoPlay ()
 Toggles continue button mode between Always and Never.
 
virtual void SkipAll ()
 Skips all subtitles until response menu or end of conversation is reached.
 
virtual void StopSkipAll ()
 
virtual void OnConversationLine (Subtitle subtitle)
 
virtual void OnConversationResponseMenu (Response[] responses)
 
virtual void OnConversationEnd (Transform actor)
 

Public Attributes

bool skipAll
 
bool stopSkipAllOnResponseMenu = true
 
bool stopSkipAllOnConversationEnd
 
bool dontSkipAllOnLastConversationLine
 

Protected Member Functions

virtual void Awake ()
 

Protected Attributes

AbstractDialogueUI dialogueUI
 

Detailed Description

Provides AutoPlay and SkipAll functionality.

To add "Auto Play" and/or "Skip All" buttons that advances the current conversation:

  • Add this script to the dialogue UI.
  • Add Auto Play and/or Skip All buttons to your subtitle panel(s). Configure their OnClick() events to call the dialogue UI's ConversationControl.ToggleAutoPlay and/or ConversationControl.SkipAll methods.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.ConversationControl.Awake ( )
inlineprotectedvirtual

◆ OnConversationEnd()

virtual void PixelCrushers.DialogueSystem.ConversationControl.OnConversationEnd ( Transform  actor)
inlinevirtual

◆ OnConversationLine()

virtual void PixelCrushers.DialogueSystem.ConversationControl.OnConversationLine ( Subtitle  subtitle)
inlinevirtual

◆ OnConversationResponseMenu()

virtual void PixelCrushers.DialogueSystem.ConversationControl.OnConversationResponseMenu ( Response[]  responses)
inlinevirtual

◆ SkipAll()

virtual void PixelCrushers.DialogueSystem.ConversationControl.SkipAll ( )
inlinevirtual

Skips all subtitles until response menu or end of conversation is reached.

◆ StopSkipAll()

virtual void PixelCrushers.DialogueSystem.ConversationControl.StopSkipAll ( )
inlinevirtual

◆ ToggleAutoPlay()

virtual void PixelCrushers.DialogueSystem.ConversationControl.ToggleAutoPlay ( )
inlinevirtual

Toggles continue button mode between Always and Never.

Member Data Documentation

◆ dialogueUI

AbstractDialogueUI PixelCrushers.DialogueSystem.ConversationControl.dialogueUI
protected

◆ dontSkipAllOnLastConversationLine

bool PixelCrushers.DialogueSystem.ConversationControl.dontSkipAllOnLastConversationLine

◆ skipAll

bool PixelCrushers.DialogueSystem.ConversationControl.skipAll

◆ stopSkipAllOnConversationEnd

bool PixelCrushers.DialogueSystem.ConversationControl.stopSkipAllOnConversationEnd

◆ stopSkipAllOnResponseMenu

bool PixelCrushers.DialogueSystem.ConversationControl.stopSkipAllOnResponseMenu = true
The documentation for this class was generated from the following file: