Class DialogueViewBase

Inheritance
object
DialogueViewBase
PunchDialogueView
TypewriterDialogueView
Namespace: Ibralogue.Views
Assembly: .dll
Syntax
public class DialogueViewBase : MonoBehaviour

Fields

| Edit this page View Source

OnLineComplete

Declaration
public UnityEvent OnLineComplete
Field Value
Type Description
UnityEvent
| Edit this page View Source

OnSetView

Declaration
public UnityEvent OnSetView
Field Value
Type Description
UnityEvent
| Edit this page View Source

_choiceButtonInstances

Declaration
protected List<ChoiceButton> _choiceButtonInstances
Field Value
Type Description
List<ChoiceButton>
| Edit this page View Source

_isPaused

Declaration
protected bool _isPaused
Field Value
Type Description
bool
| Edit this page View Source

_isStillDisplaying

Declaration
protected bool _isStillDisplaying
Field Value
Type Description
bool
| Edit this page View Source

choiceButton

Declaration
protected GameObject choiceButton
Field Value
Type Description
GameObject
| Edit this page View Source

choiceButtonHolder

Declaration
protected Transform choiceButtonHolder
Field Value
Type Description
Transform
| Edit this page View Source

nameText

Declaration
protected TextMeshProUGUI nameText
Field Value
Type Description
TextMeshProUGUI
| Edit this page View Source

sentenceText

Declaration
protected TextMeshProUGUI sentenceText
Field Value
Type Description
TextMeshProUGUI

Properties

| Edit this page View Source

IsPaused

True when the display effect is paused.

Declaration
public virtual bool IsPaused { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsStillDisplaying

True while the view is actively displaying content (e.g., typewriter in progress).

Declaration
public virtual bool IsStillDisplaying { get; }
Property Value
Type Description
bool
| Edit this page View Source

VisibleCharacterCount

Returns the number of characters currently visible in the dialogue text. Used by the engine to fire inline function invocations at the correct character position during animated display.

Declaration
public virtual int VisibleCharacterCount { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

ClearView()

Clears all elements in the view.

Declaration
public virtual void ClearView()
| Edit this page View Source

DisplayChoices(List<Choice>, Action<Choice>)

Presents choice buttons to the player. When a choice is selected, the onChoiceSelected callback is invoked with the chosen option.

Declaration
public virtual void DisplayChoices(List<Choice> choices, Action<Choice> onChoiceSelected)
Parameters
Type Name Description
List<Choice> choices
Action<Choice> onChoiceSelected
| Edit this page View Source

Pause()

Pauses the currently playing effect.

Declaration
public virtual void Pause()
| Edit this page View Source

Resume()

Resumed the currently playing effect.

Declaration
public virtual void Resume()
| Edit this page View Source

SetSpeed(float)

Applies a speed multiplier to the current display effect. 2 = twice as fast, 0.5 = half speed. The multiplier is relative to the view's configured default and resets automatically on the next line.

Declaration
public virtual void SetSpeed(float multiplier)
Parameters
Type Name Description
float multiplier
| Edit this page View Source

SetView(Line)

Displays a single dialogue line.

Declaration
public virtual void SetView(Line line)
Parameters
Type Name Description
Line line
| Edit this page View Source

SkipViewEffect()

Skips whatever display effect the dialogue view is playing.

Declaration
public virtual void SkipViewEffect()