v3.6.1 Documentation
Fungus.IWriterListener Interface Reference

Implement this interface to be notified about Writer events. More...

Inheritance diagram for Fungus.IWriterListener:
Fungus.WriterAudio

Public Member Functions

void OnInput ()
 Called when a user input event (e.g. More...
 
void OnStart (AudioClip audioClip)
 Called when the Writer starts writing new text. More...
 
void OnPause ()
 Called when the Writer has paused writing text (e.g. on a {wi} tag). More...
 
void OnResume ()
 Called when the Writer has resumed writing text. More...
 
void OnEnd (bool stopAudio)
 Called when the Writer has finished writing text. More...
 
void OnGlyph ()
 Called every time the Writer writes a new character glyph. More...
 
void OnVoiceover (AudioClip voiceOverClip)
 Called when voiceover should start. More...
 

Detailed Description

Implement this interface to be notified about Writer events.

Definition at line 12 of file IWriterListener.cs.

Member Function Documentation

◆ OnEnd()

void Fungus.IWriterListener.OnEnd ( bool  stopAudio)

Called when the Writer has finished writing text.

Parameters
stopAudioControls whether audio should be stopped when writing ends.

Implemented in Fungus.WriterAudio.

◆ OnGlyph()

void Fungus.IWriterListener.OnGlyph ( )

Called every time the Writer writes a new character glyph.

Implemented in Fungus.WriterAudio.

◆ OnInput()

void Fungus.IWriterListener.OnInput ( )

Called when a user input event (e.g.

a click) has been handled by the Writer.

Implemented in Fungus.WriterAudio.

◆ OnPause()

void Fungus.IWriterListener.OnPause ( )

Called when the Writer has paused writing text (e.g. on a {wi} tag).

Implemented in Fungus.WriterAudio.

◆ OnResume()

void Fungus.IWriterListener.OnResume ( )

Called when the Writer has resumed writing text.

Implemented in Fungus.WriterAudio.

◆ OnStart()

void Fungus.IWriterListener.OnStart ( AudioClip  audioClip)

Called when the Writer starts writing new text.

Parameters
audioClipAn optional audioClip sound effect can be supplied (e.g. for voiceover)

Implemented in Fungus.WriterAudio.

◆ OnVoiceover()

void Fungus.IWriterListener.OnVoiceover ( AudioClip  voiceOverClip)

Called when voiceover should start.

Implemented in Fungus.WriterAudio.


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