Class NovelPlayer

会話パートを再生するためのコンポーネント

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

NovelPlayer

Namespace: NovelEditor

Assembly: rirunee.NovelEditor.Runtime.dll

Syntax

[RequireComponent(typeof(NovelUIManager))]
public class NovelPlayer : MonoBehaviour

Fields

OnBegin

Declaration

public NovelPlayer.OnBeginDelegate OnBegin

Field Value

Type	Description
NovelPlayer.OnBeginDelegate	再生を開始した時に呼び出されます

OnChoiced

Declaration

public NovelPlayer.NodeChangedDelegate OnChoiced

Field Value

Type	Description
NovelPlayer.NodeChangedDelegate	選択肢を選んだ時に呼び出されます

OnDialogueChanged

Declaration

public NovelPlayer.OnDialogueChangedDelegate OnDialogueChanged

Field Value

Type	Description
NovelPlayer.OnDialogueChangedDelegate	次のセリフへ進んだ時に呼び出されます

OnEnd

Declaration

public NovelPlayer.OnEndDelegate OnEnd

Field Value

Type	Description
NovelPlayer.OnEndDelegate	再生終了時に呼び出されます

OnLoad

Declaration

public NovelPlayer.OnLoadDelegate OnLoad

Field Value

Type	Description
NovelPlayer.OnLoadDelegate	ロード時に呼び出されます

OnSkiped

Declaration

public NovelPlayer.SkipedDeleteDelegate OnSkiped

Field Value

Type	Description
NovelPlayer.SkipedDeleteDelegate	スキップ時に呼ばれます

ParagraphNodeChanged

Declaration

public NovelPlayer.NodeChangedDelegate ParagraphNodeChanged

Field Value

Type	Description
NovelPlayer.NodeChangedDelegate	再生しているノードが変わったときに呼び出されます

Properties

BGMVolume

BGMの大きさを変えられます

Declaration

public float BGMVolume { get; set; }

Property Value

Type	Description
System.Single	BGMの大きさ

ChoiceName

Declaration

public List<string> ChoiceName { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	今まで選択した選択肢のNameのリスト。選択した順になっています

IsChoicing

Declaration

public bool IsChoicing { get; }

Property Value

Type	Description
System.Boolean	選択肢が表示されている状態か

IsDisplay

背景や立ち絵を含める会話パートのUIの表示状態を変えられます

Declaration

public bool IsDisplay { get; set; }

Property Value

Type	Description
System.Boolean	背景や立ち絵を含める会話パートのUIの表示状態

IsPlaying

Declaration

public bool IsPlaying { get; }

Property Value

Type	Description
System.Boolean	現在再生中か

IsStop

Declaration

public bool IsStop { get; }

Property Value

Type	Description
System.Boolean	現在停止しているか

IsUIDisplay

UIの表示状態を変更できます

Declaration

public bool IsUIDisplay { get; set; }

Property Value

Type	Description
System.Boolean	UIを表示しているか

loadProgress

Declaration

public float loadProgress { get; }

Property Value

Type	Description
System.Single	ロード中、現在の進捗0〜1で返します。

mute

ミュートを切り替えられます

Declaration

public bool mute { get; set; }

Property Value

Type	Description
System.Boolean	ミュート中かどうか

novelData

Declaration

public NovelData novelData { get; }

Property Value

Type	Description
NovelData	現在セットしてあるNovelData

ParagraphName

Declaration

public List<string> ParagraphName { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	今まで再生した会話ノードのName。再生した順に入っています。

SEVolume

SEの大きさを変えられます

Declaration

public float SEVolume { get; set; }

Property Value

Type	Description
System.Single	SEの大きさ

textSpeed

テキストの再生速度を変えられます

Declaration

public int textSpeed { get; set; }

Property Value

Type	Description
System.Int32	テキスト再生速度

Methods

DisplayUI()

UIを表示する

Declaration

public void DisplayUI()

HideUI()

UIを非表示にする

Declaration

public void HideUI()

Load(NovelSaveData, Boolean)

会話を保存されたデータからロードして再生します

Declaration

public void Load(NovelSaveData saveData, bool hideAfterPlay)

Parameters

Type	Name	Description
NovelSaveData	saveData	再生するセーブデータ
System.Boolean	hideAfterPlay	再生終了時に非表示にするか

Pause()

会話を一時停止する

Declaration

public void Pause()

Play(NovelData, Boolean)

会話を最初から再生します

Declaration

public void Play(NovelData data, bool hideAfterPlay)

Parameters

Type	Name	Description
NovelData	data	再生するデータ
System.Boolean	hideAfterPlay	再生終了後に画面を非表示にするか

save()

現在の状態をセーブします。

Declaration

public NovelSaveData save()

Returns

Type	Description
NovelSaveData	セーブデータ

SetInputProvider(NovelInputProvider)

入力方法を設定できます

Declaration

public void SetInputProvider(NovelInputProvider input)

Parameters

Type	Name	Description
NovelInputProvider	input	NovelInputProviderを継承して入力方法を定義したクラスのインスタンス

Skip()

次の選択肢までスキップします。選択肢がなければ会話を終了します。

Declaration

public void Skip()

SkipNextNode()

次の会話ノードまでスキップします。次のノードが選択肢なら選択肢までスキップします。

Declaration

public void SkipNextNode()

UnPause()

会話の一時停止を解除する

Declaration

public void UnPause()