Class TMPWriter.Delays

Namespace

TMPEffects.Components

Assembly

TMPEffects.dll

Stores the various delays along with their TMPWriter.DelayType of a TMPWriter.

[Serializable]
public class TMPWriter.Delays

Inheritance

object

TMPWriter.Delays

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

delay

The delay after showing a character.

[Tooltip("The delay between new characters shown by the writer, i.e. the inverse of the speed of the writer.")]
public float delay

Field Value

float

linebreakDelay

The delay after "showing" a linebreak character.

[Tooltip("The delay after linebreaks, either as percentage of the general delay or in seconds")]
public float linebreakDelay

Field Value

float

linebreakDelayType

The TMPWriter.DelayType of linebreakDelay.

public TMPWriter.DelayType linebreakDelayType

Field Value

TMPWriter.DelayType

punctuationDelay

The delay after showing a punctuation character.

[Tooltip("The delay after punctuation characters, either as percentage of the general delay or in seconds")]
public float punctuationDelay

Field Value

float

punctuationDelayType

The TMPWriter.DelayType of punctuationDelay.

public TMPWriter.DelayType punctuationDelayType

Field Value

TMPWriter.DelayType

visibleDelay

The delay after "showing" an already visible character.

[Tooltip("The delay after already visible characters, either as percentage of the general delay or in seconds")]
public float visibleDelay

Field Value

float

visibleDelayType

The TMPWriter.DelayType of visibleDelay.

public TMPWriter.DelayType visibleDelayType

Field Value

TMPWriter.DelayType

whitespaceDelay

The delay after "showing" a whitespace character.

[Tooltip("The delay after whitespace characters, either as percentage of the general delay or in seconds")]
public float whitespaceDelay

Field Value

float

whitespaceDelayType

The TMPWriter.DelayType of whitespaceDelay.

public TMPWriter.DelayType whitespaceDelayType

Field Value

TMPWriter.DelayType

Properties

CalculatedLinebreakDelay

The calculated delay after "showing" a linebreak character, using linebreakDelay and linebreakDelayType.

public float CalculatedLinebreakDelay { get; }

Property Value

float

CalculatedPunctuationDelay

The calculated delay after showing a punctuation character, using punctuationDelay and punctuationDelayType.

public float CalculatedPunctuationDelay { get; }

Property Value

float

CalculatedVisibleDelay

The calculated delay after "showing" an already visible character, using visibleDelay and visibleDelayType.

public float CalculatedVisibleDelay { get; }

Property Value

float

CalculatedWhiteSpaceDelay

The calculated delay after "showing" a whitespace character, using whitespaceDelay and whitespaceDelayType.

public float CalculatedWhiteSpaceDelay { get; }

Property Value

float

Methods

SetDelay(float)

Set the delay of the writer.

public void SetDelay(float delay)

Parameters

delay float

The delay after showing a character.

SetLinebreakDelay(float, DelayType?)

Set the linebreak delay of the writer.

public void SetLinebreakDelay(float delay, TMPWriter.DelayType? type = null)

Parameters

delay float

The delay after "showing" a linebreak character.

type TMPWriter.DelayType?

SetPunctuationDelay(float, DelayType?)

Set the punctuation delay of the writer.

public void SetPunctuationDelay(float delay, TMPWriter.DelayType? type = null)

Parameters

delay float

The delay after "showing" a punctuation character.

type TMPWriter.DelayType?

SetVisibleDelay(float, DelayType?)

Set the visible delay of the writer.

public void SetVisibleDelay(float delay, TMPWriter.DelayType? type = null)

Parameters

delay float

The delay after "showing" an already visible character.

type TMPWriter.DelayType?

SetWhitespaceDelay(float, DelayType?)

Set the whitespace delay of the writer.

public void SetWhitespaceDelay(float delay, TMPWriter.DelayType? type = null)

Parameters

delay float

The delay after "showing" a whitespace character.

type TMPWriter.DelayType?