This is an abstract base typewriter class. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractTypewriterEffect:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractTypewriterEffect:

Public Member Functions
virtual float	GetSpeed ()
	Returns the typewriter's charactersPerSecond.

virtual void	SetSpeed (float charactersPerSecond)
	Sets the typewriter's charactersPerSecond.

virtual void	Awake ()

void	Start ()

virtual void	OnEnable ()

virtual void	OnDisable ()

virtual void	StopOnConversationEnd (Transform actor)

void	Stop ()

void	StartTyping (string text, int fromIndex=0)

void	StopTyping ()

virtual void	StopCharacterAudio ()

Static Public Member Functions
static string	StripRPGMakerCodes (string s)

Public Attributes
bool	rightToLeft = false
	Set `true` to type right to left.

float	charactersPerSecond = 50
	How fast to "type.".

AudioClip	audioClip = null
	The audio clip to play with each character.

AudioClip[]	alternateAudioClips = new AudioClip[0]
	If specified, randomly use these clips or the main Audio Clip.

AudioSource	audioSource = null
	The audio source through which to play the clip.

bool	usePlayOneShot = false

bool	interruptAudioClip = false
	If audio clip is still playing from previous character, stop and restart it when typing next character.

bool	stopAudioOnSilentCharacters = false

bool	stopAudioOnPauseCodes = false

string	silentCharacters = string.Empty
	Don't play audio on these characters.

string	fullPauseCharacters = string.Empty
	Play a full pause on these characters.

string	quarterPauseCharacters = string.Empty
	Play a quarter pause on these characters.

float	fullPauseDuration = 1f
	Duration to pause on when text contains '\.

float	quarterPauseDuration = 0.25f
	Duration to pause when text contains '\,'.

bool	removeDuplicateTypewriterEffects = true
	Ensures this GameObject has only one typewriter effect.

bool	playOnEnable = true
	Play using the current text content whenever component is enabled.

bool	waitOneFrameBeforeStarting = false
	Wait one frame to allow layout elements to setup first.

bool	stopOnConversationEnd = false
	Stop typing when the conversation ends.

Protected Member Functions
virtual void	PreprocessPauseCharacters ()
	Process anything special in full/quarterPauseCharacters, such as to newlines.

virtual bool	IsFullPauseCharacter (char c)

virtual bool	IsQuarterPauseCharacter (char c)

virtual bool	IsSilentCharacter (char c)

bool	IsCharacterInString (char c, string s)

virtual void	PlayCharacterAudio (char c)

virtual void	PlayCharacterAudio ()

virtual IEnumerator	PauseForDuration (float duration)

Protected Attributes
bool	paused = false

Properties
bool	isPlaying `[get]`

Detailed Description

This is an abstract base typewriter class.

It's the ancestor of UnityUITypewriterEffect and TextMeshProTypewriterEffect.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.Awake ( )

inlinevirtual

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProTypewriterEffect, and PixelCrushers.DialogueSystem.UnityUITypewriterEffect.

◆ GetSpeed()

virtual float PixelCrushers.DialogueSystem.AbstractTypewriterEffect.GetSpeed ( )

inlinevirtual

Returns the typewriter's charactersPerSecond.

◆ IsCharacterInString()

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.IsCharacterInString	(	char	c,
		string	s
	)

inlineprotected

◆ IsFullPauseCharacter()

virtual bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.IsFullPauseCharacter ( char c )

inlineprotectedvirtual

◆ IsQuarterPauseCharacter()

virtual bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.IsQuarterPauseCharacter ( char c )

inlineprotectedvirtual

◆ IsSilentCharacter()

virtual bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.IsSilentCharacter ( char c )

inlineprotectedvirtual

◆ OnDisable()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.OnDisable ( )

inlinevirtual

Reimplemented in PixelCrushers.DialogueSystem.UnityUITypewriterEffect.

◆ OnEnable()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.OnEnable ( )

inlinevirtual

Reimplemented in PixelCrushers.DialogueSystem.UnityUITypewriterEffect.

◆ PauseForDuration()

virtual IEnumerator PixelCrushers.DialogueSystem.AbstractTypewriterEffect.PauseForDuration ( float duration )

inlineprotectedvirtual

◆ PlayCharacterAudio() [1/2]

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.PlayCharacterAudio ( )

inlineprotectedvirtual

◆ PlayCharacterAudio() [2/2]

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.PlayCharacterAudio ( char c )

inlineprotectedvirtual

◆ PreprocessPauseCharacters()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.PreprocessPauseCharacters ( )

inlineprotectedvirtual

Process anything special in full/quarterPauseCharacters, such as
to newlines.

◆ SetSpeed()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.SetSpeed ( float charactersPerSecond )

inlinevirtual

Sets the typewriter's charactersPerSecond.

Takes effect the next time the typewriter is used.

◆ Start()

void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.Start ( )

abstract

◆ StartTyping()

void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.StartTyping	(	string	text,
		int	fromIndex = `0`
	)

abstract

◆ Stop()

void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.Stop ( )

abstract

◆ StopCharacterAudio()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.StopCharacterAudio ( )

inlinevirtual

◆ StopOnConversationEnd()

virtual void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.StopOnConversationEnd ( Transform actor )

inlinevirtual

◆ StopTyping()

void PixelCrushers.DialogueSystem.AbstractTypewriterEffect.StopTyping ( )

abstract

◆ StripRPGMakerCodes()

static string PixelCrushers.DialogueSystem.AbstractTypewriterEffect.StripRPGMakerCodes ( string s )

inlinestatic

Member Data Documentation

◆ alternateAudioClips

AudioClip [] PixelCrushers.DialogueSystem.AbstractTypewriterEffect.alternateAudioClips = new AudioClip[0]

If specified, randomly use these clips or the main Audio Clip.

◆ audioClip

AudioClip PixelCrushers.DialogueSystem.AbstractTypewriterEffect.audioClip = null

The audio clip to play with each character.

◆ audioSource

AudioSource PixelCrushers.DialogueSystem.AbstractTypewriterEffect.audioSource = null

The audio source through which to play the clip.

If unassigned, will look for an audio source on this GameObject.

◆ charactersPerSecond

float PixelCrushers.DialogueSystem.AbstractTypewriterEffect.charactersPerSecond = 50

How fast to "type.".

◆ fullPauseCharacters

string PixelCrushers.DialogueSystem.AbstractTypewriterEffect.fullPauseCharacters = string.Empty

Play a full pause on these characters.

◆ fullPauseDuration

float PixelCrushers.DialogueSystem.AbstractTypewriterEffect.fullPauseDuration = 1f

Duration to pause on when text contains '\.

'

◆ interruptAudioClip

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.interruptAudioClip = false

If audio clip is still playing from previous character, stop and restart it when typing next character.

◆ paused

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.paused = false

protected

◆ playOnEnable

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.playOnEnable = true

Play using the current text content whenever component is enabled.

◆ quarterPauseCharacters

string PixelCrushers.DialogueSystem.AbstractTypewriterEffect.quarterPauseCharacters = string.Empty

Play a quarter pause on these characters.

◆ quarterPauseDuration

float PixelCrushers.DialogueSystem.AbstractTypewriterEffect.quarterPauseDuration = 0.25f

Duration to pause when text contains '\,'.

◆ removeDuplicateTypewriterEffects

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.removeDuplicateTypewriterEffects = true

Ensures this GameObject has only one typewriter effect.

◆ rightToLeft

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.rightToLeft = false

Set true to type right to left.

◆ silentCharacters

string PixelCrushers.DialogueSystem.AbstractTypewriterEffect.silentCharacters = string.Empty

Don't play audio on these characters.

◆ stopAudioOnPauseCodes

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.stopAudioOnPauseCodes = false

◆ stopAudioOnSilentCharacters

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.stopAudioOnSilentCharacters = false

◆ stopOnConversationEnd

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.stopOnConversationEnd = false

Stop typing when the conversation ends.

◆ usePlayOneShot

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.usePlayOneShot = false

◆ waitOneFrameBeforeStarting

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.waitOneFrameBeforeStarting = false

Wait one frame to allow layout elements to setup first.

Property Documentation

◆ isPlaying

bool PixelCrushers.DialogueSystem.AbstractTypewriterEffect.isPlaying

getabstract

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

C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Utility/AbstractTypewriterEffect.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Awake()

◆ GetSpeed()

◆ IsCharacterInString()

◆ IsFullPauseCharacter()

◆ IsQuarterPauseCharacter()

◆ IsSilentCharacter()

◆ OnDisable()

◆ OnEnable()

◆ PauseForDuration()

◆ PlayCharacterAudio() [1/2]

◆ PlayCharacterAudio() [2/2]

◆ PreprocessPauseCharacters()

◆ SetSpeed()

◆ Start()

◆ StartTyping()

◆ Stop()

◆ StopCharacterAudio()

◆ StopOnConversationEnd()

◆ StopTyping()

◆ StripRPGMakerCodes()

Member Data Documentation

◆ alternateAudioClips

◆ audioClip

◆ audioSource

◆ charactersPerSecond

◆ fullPauseCharacters

◆ fullPauseDuration

◆ interruptAudioClip

◆ paused

◆ playOnEnable

◆ quarterPauseCharacters

◆ quarterPauseDuration

◆ removeDuplicateTypewriterEffects

◆ rightToLeft

◆ silentCharacters

◆ stopAudioOnPauseCodes

◆ stopAudioOnSilentCharacters

◆ stopOnConversationEnd

◆ usePlayOneShot

◆ waitOneFrameBeforeStarting

Property Documentation

◆ isPlaying