Public Types
enum	ContinueButtonMode { ContinueButtonMode.Never, ContinueButtonMode.Always, ContinueButtonMode.Optional, ContinueButtonMode.OptionalBeforeResponseMenu, ContinueButtonMode.NotBeforeResponseMenu, ContinueButtonMode.OptionalBeforePCAutoresponseOrMenu, ContinueButtonMode.NotBeforePCAutoresponseOrMenu, ContinueButtonMode.OptionalForPC, ContinueButtonMode.NotForPC, ContinueButtonMode.OptionalForPCOrBeforeResponseMenu, ContinueButtonMode.NotForPCOrBeforeResponseMenu, ContinueButtonMode.OptionalForPCOrBeforePCAutoresponseOrMenu, ContinueButtonMode.NotForPCOrBeforePCAutoresponseOrMenu }

Public Attributes
bool	showNPCSubtitlesDuringLine = true
	Specifies whether to show NPC subtitles while speaking a line of dialogue. More...

bool	showNPCSubtitlesWithResponses = true
	Specifies whether to should show NPC subtitles while presenting the player's follow-up responses. More...

bool	showPCSubtitlesDuringLine = false
	Specifies whether to show PC subtitles while speaking a line of dialogue. More...

bool	allowPCSubtitleReminders = false
	Set `true` to allow PC subtitles to be used for the reminder line during the response menu. More...

bool	skipPCSubtitleAfterResponseMenu = false
	If the PC's subtitle came from a response menu selection, don't show the subtitle even if showPCSubtitlesDuringLine is true. More...

float	subtitleCharsPerSecond = 30f
	The default subtitle characters per second. More...

float	minSubtitleSeconds = 2f
	The minimum duration to display a subtitle if no sequence is specified for a line of dialogue. More...

ContinueButtonMode	continueButton = ContinueButtonMode.Never
	How to handle continue buttons. More...

bool	richTextEmphases = false
	Set `true` to convert "[em#]" tags to rich text codes in formatted text. More...

bool	informSequenceStartAndEnd = false
	Set `true` to send OnSequenceStart and OnSequenceEnd messages with every dialogue entry's sequence. More...

Member Enumeration Documentation

◆ ContinueButtonMode

enum PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.ContinueButtonMode

strong

Enumerator
Never	Never wait for the continue button. Use this if your UI doesn't have continue buttons.
Always	Always wait for the continue button.
Optional	Show the continue button but don't wait for it.
OptionalBeforeResponseMenu	Wait for the continue button, except when the response menu is next show but don't wait.
NotBeforeResponseMenu	Wait for the continue button, except when the response menu is next hide it.
OptionalBeforePCAutoresponseOrMenu	Wait for the continue button, except when a PC auto-select response or response menu is next, show but don't wait.
NotBeforePCAutoresponseOrMenu	Wait for the continue button, except with a PC auto-select response or response menu is next, hide it.
OptionalForPC	Wait for the continue button, except when delivering PC lines show but don't wait.
NotForPC	Wait for the continue button except when delivering PC lines.
OptionalForPCOrBeforeResponseMenu	Wait for the continue button, except when preceding response menus or delivering PC lines don't wait.
NotForPCOrBeforeResponseMenu	Wait for the continue button only for NPC lines that don't precede response menus.
OptionalForPCOrBeforePCAutoresponseOrMenu	Wait for the continue button, except for PC lines and lines preceding a response menu or PC auto-select response don't wait.
NotForPCOrBeforePCAutoresponseOrMenu	Wait for the continue button only for NPC lines that don't precede response menus or PC auto-select responses.

Member Data Documentation

◆ allowPCSubtitleReminders

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.allowPCSubtitleReminders = false

Set true to allow PC subtitles to be used for the reminder line during the response menu.

◆ continueButton

ContinueButtonMode PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.continueButton = ContinueButtonMode.Never

How to handle continue buttons.

◆ informSequenceStartAndEnd

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.informSequenceStartAndEnd = false

Set true to send OnSequenceStart and OnSequenceEnd messages with every dialogue entry's sequence.

◆ minSubtitleSeconds

float PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.minSubtitleSeconds = 2f

The minimum duration to display a subtitle if no sequence is specified for a line of dialogue.

This value is also used when displaying alerts.

◆ richTextEmphases

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.richTextEmphases = false

Set true to convert "[em#]" tags to rich text codes in formatted text.

Your implementation of IDialogueUI must support rich text.

◆ showNPCSubtitlesDuringLine

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.showNPCSubtitlesDuringLine = true

Specifies whether to show NPC subtitles while speaking a line of dialogue.

◆ showNPCSubtitlesWithResponses

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.showNPCSubtitlesWithResponses = true

Specifies whether to should show NPC subtitles while presenting the player's follow-up responses.

◆ showPCSubtitlesDuringLine

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.showPCSubtitlesDuringLine = false

Specifies whether to show PC subtitles while speaking a line of dialogue.

◆ skipPCSubtitleAfterResponseMenu

bool PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.skipPCSubtitleAfterResponseMenu = false

If the PC's subtitle came from a response menu selection, don't show the subtitle even if showPCSubtitlesDuringLine is true.

◆ subtitleCharsPerSecond

float PixelCrushers.DialogueSystem.DisplaySettings.SubtitleSettings.subtitleCharsPerSecond = 30f

The default subtitle characters per second.

This value is used to compute the default duration to display a subtitle if no sequence is specified for a line of dialogue. This value is also used when displaying alerts.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Core/Model-View-Controller/View/Shared/DisplaySettings.cs

Public Types

Public Attributes