ノベルエンジンの実行用クラスです。 [詳細]

#include <AbyssLib.h>

NovelPlayerに対する継承グラフ

Public メソッド
	NovelPlayer (BaseTextStream Text, BaseInputManager Input, BaseSoundManager Sound, BaseDrawManager Graphic, unsigned int InitFlag)
	コンストラクタです。
virtual	~NovelPlayer ()
	仮想デストラクタです。
void	Initialize ()
	初期化を行います。
ISingleHeap *	GetLabel ()
	ラベル管理を行っているクラスを取得します。
const ISingleHeap *	GetLabel () const
	ラベル管理を行っているクラスを取得します。
ISingleHeap *	GetLocal ()
	内部変数管理を行っているクラスを取得します。
const ISingleHeap *	GetLocal () const
	内部変数管理を行っているクラスを取得します。
ISingleHeap *	GetGlobal ()
	外部変数管理を行っているクラスを取得します。
const ISingleHeap *	GetGlobal () const
	外部変数管理を行っているクラスを取得します。
ISingleHeap *	GetSymbolName ()
	シンボル名管理を行っているクラスを取得します。
const ISingleHeap *	GetSymbolName () const
	シンボル名管理を行っているクラスを取得します。
ICommandHeap *	GetCommand ()
	スクリプト命令リスト管理を行っているクラスを取得します。
const ICommandHeap *	GetCommand () const
	スクリプト命令リスト管理を行っているクラスを取得します。
ITaskManager *	GetTask ()
	描画タスクの管理を行っているクラスを取得します。
const ITaskManager *	GetTask () const
	描画タスクの管理を行っているクラスを取得します。
ITextManager *	GetText ()
	既読履歴の管理を行っているクラスを取得します。
const ITextManager *	GetText () const
	既読履歴の管理を行っているクラスを取得します。
ITextStream *	GetPrint ()
	テキスト出力ストリームを取得します。
const ITextStream *	GetPrint () const
	テキスト出力ストリームを取得します。
IInputManager *	GetInput ()
	ユーザー入力用デバイスを取得します。
const IInputManager *	GetInput () const
	ユーザー入力用デバイスを取得します。
ISoundManager *	GetSound ()
	サウンド用デバイスを取得します。
const ISoundManager *	GetSound () const
	サウンド用デバイスを取得します。
IDrawManager *	GetDraw ()
	グラフィック用デバイスを取得します。
const IDrawManager *	GetDraw () const
	グラフィック用デバイスを取得します。
void	Run ()
	ノベルエンジンを実行します。
void	Run (const string &LabelName)
	指定したラベルからノベルエンジンを実行します。
void	Resume ()
	ノベルエンジンを一時停止モードから復帰させます。
void	Resume (const string &LabelName)
	指定したラベルからノベルエンジンを一時停止モードから復帰させます。
virtual HWND	GetMyAppHWND () const =0
	ウインドウハンドルを取得します。
unsigned int	GetState () const
	ノベルエンジンの状態を取得します。
void	SetState (unsigned int State)
	ノベルエンジンの状態を設定します。
void	PopState ()
	ノベルエンジンの状態をスタックからポップします。
void	PushState (unsigned int State)
	ノベルエンジンの状態をスタックにプッシュします。
void	InitState ()
	ノベルエンジンの状態を初期化します。
void	EnableSystem ()
	入力受付を有効化します。
void	DisableSystem ()
	入力受付を無効化します。
bool	GetSystemState () const
	入力受付の有無を取得します。
bool	GetMenu () const
	メニュー呼び出しの可能・不可能を取得します。
void	SetMenu (bool IsMenu)
	メニュー呼び出しの可能・不可能を設定します。
bool	IsUsedSE (const char *FileName) const
	音声ファイルが現在ＳＥとして使用されているかを取得します。
bool	IsUsedBGM (const char *FileName) const
	音声ファイルが現在ＢＧＭとして使用されているかを取得します。
bool	IsUsedVoice (const char *FileName) const
	音声ファイルが現在音声として使用されているかを取得します。
bool	IsUsedImage (const char *FileName) const
	画像ファイルが現在使用されているかを取得します。
bool	LoadScript (const string &FileName, IIOStream *IOStream)
	スクリプトファイルを読み込みます。
bool	SaveLocalData (const char FileName, IIOStream IOStream)
	ローカルデータを保存します。
bool	LoadLocalData (const char FileName, IIOStream IOStream)
	ローカルデータを読み込みます。
bool	SaveGlobalData (const string &FileName, IIOStream *IOStream)
	グローバルデータを保存します。
bool	LoadGlobalData (const string &FileName, IIOStream *IOStream)
	グローバルデータを読み込みます。
bool	SaveEnvironmentData (const string &FileName, IIOStream *IOStream)
	環境設定を保存します。
bool	LoadEnvironmentData (const string &FileName, bool AllowChangeDisplayMode, IIOStream *IOStream)
	環境設定を読み込みます。
bool	AddLoadObject (const char FileName, IIOStream IOStream)
	オブジェクトファイルを追加で読み込みます。
void	SetIOStreamUseInScript (IIOStream *IOStream)
	使用するデータ入出力クラスを設定します。
IIOStream *	GetIOStreamUseInScript () const
	使用するデータ入出力クラスを取得します。
void	SetNormalScene (IScene_Base *Scene)
	通常モードで使用するシーンクラスを設定します。
void	SetBackLogScene (IScene_Base *Scene)
	既読履歴モードで使用するシーンクラスを設定します。
void	SetSaveScene (IScene_Base *Scene)
	セーブモードで使用するシーンクラスを設定します。
void	SetLoadScene (IScene_Base *Scene)
	ロードモードで使用するシーンクラスを設定します。
void	SetConfigScene (IScene_Base *Scene)
	環境設定モードで使用するシーンクラスを設定します。
void	SetMenuScene (IScene_Base *Scene)
	メニューモードで使用するシーンクラスを設定します。
Protected メソッド
virtual void	_Suspend ()
	一時停止モード時に呼び出されるメソッドです。
virtual void	_EndApp ()=0
	アプリケーション終了時に呼び出されるメソッドです。

説明

ノベルエンジンの実行用クラスです。

コンストラクタとデストラクタ

NovelPlayer	(	BaseTextStream *	Text,
		BaseInputManager *	Input,
		BaseSoundManager *	Sound,
		BaseDrawManager *	Graphic,
		unsigned int	InitFlag
	)

コンストラクタです。

引数:

Text	[in]テキスト出力ストリームを指定します。
Input	[in]ユーザー入力用デバイスを指定します。
Sound	[in]サウンド用デバイスを指定します。
Graphic	[in]グラフィック用デバイスを指定します。
InitFlag	[in]初期化フラグを指定します。

virtual ~NovelPlayer ( ) [virtual]

仮想デストラクタです。

関数

void Initialize ( ) [virtual]

初期化を行います。

INovelEngineを実装しています。

ISingleHeap* GetLabel ( ) [virtual]

ラベル管理を行っているクラスを取得します。

戻り値:: ラベル管理を行っているクラスを返します。

INovelEngineを実装しています。

const ISingleHeap* GetLabel ( ) const [virtual]

ラベル管理を行っているクラスを取得します。

戻り値:: ラベル管理を行っているクラスを返します。

INovelEngineを実装しています。

ISingleHeap* GetLocal ( ) [virtual]

内部変数管理を行っているクラスを取得します。

戻り値:: 内部変数管理を行っているクラスを返します。

INovelEngineを実装しています。

const ISingleHeap* GetLocal ( ) const [virtual]

内部変数管理を行っているクラスを取得します。

戻り値:: 内部変数管理を行っているクラスを返します。

INovelEngineを実装しています。

ISingleHeap* GetGlobal ( ) [virtual]

外部変数管理を行っているクラスを取得します。

戻り値:: 外部変数管理を行っているクラスを返します。

INovelEngineを実装しています。

const ISingleHeap* GetGlobal ( ) const [virtual]

外部変数管理を行っているクラスを取得します。

戻り値:: 外部変数管理を行っているクラスを返します。

INovelEngineを実装しています。

ISingleHeap* GetSymbolName ( ) [virtual]

シンボル名管理を行っているクラスを取得します。

戻り値:: シンボル名管理を行っているクラスを返します。

INovelEngineを実装しています。

const ISingleHeap* GetSymbolName ( ) const [virtual]

シンボル名管理を行っているクラスを取得します。

戻り値:: シンボル名管理を行っているクラスを返します。

INovelEngineを実装しています。

ICommandHeap* GetCommand ( ) [virtual]

スクリプト命令リスト管理を行っているクラスを取得します。

戻り値:: スクリプト命令リスト管理を行っているクラスを返します。

INovelEngineを実装しています。

const ICommandHeap* GetCommand ( ) const [virtual]

スクリプト命令リスト管理を行っているクラスを取得します。

戻り値:: スクリプト命令リスト管理を行っているクラスを返します。

INovelEngineを実装しています。

ITaskManager* GetTask ( ) [virtual]

描画タスクの管理を行っているクラスを取得します。

戻り値:: 描画タスクの管理を行っているクラスを返します。

INovelEngineを実装しています。

const ITaskManager* GetTask ( ) const [virtual]

描画タスクの管理を行っているクラスを取得します。

戻り値:: 描画タスクの管理を行っているクラスを返します。

INovelEngineを実装しています。

ITextManager* GetText ( ) [virtual]

既読履歴の管理を行っているクラスを取得します。

戻り値:: 既読履歴の管理を行っているクラスを返します。

INovelEngineを実装しています。

const ITextManager* GetText ( ) const [virtual]

既読履歴の管理を行っているクラスを取得します。

戻り値:: 既読履歴の管理を行っているクラスを返します。

INovelEngineを実装しています。

ITextStream* GetPrint ( ) [virtual]

テキスト出力ストリームを取得します。

戻り値:: テキスト出力ストリームを返します。

INovelEngineを実装しています。

const ITextStream* GetPrint ( ) const [virtual]

テキスト出力ストリームを取得します。

戻り値:: テキスト出力ストリームを返します。

INovelEngineを実装しています。

IInputManager* GetInput ( ) [virtual]

ユーザー入力用デバイスを取得します。

戻り値:: ユーザー入力用デバイスを返します。

INovelEngineを実装しています。

const IInputManager* GetInput ( ) const [virtual]

ユーザー入力用デバイスを取得します。

戻り値:: ユーザー入力用デバイスを返します。

INovelEngineを実装しています。

ISoundManager* GetSound ( ) [virtual]

サウンド用デバイスを取得します。

戻り値:: サウンド用デバイスを返します。

INovelEngineを実装しています。

const ISoundManager* GetSound ( ) const [virtual]

サウンド用デバイスを取得します。

戻り値:: サウンド用デバイスを返します。

INovelEngineを実装しています。

IDrawManager* GetDraw ( ) [virtual]

グラフィック用デバイスを取得します。

戻り値:: グラフィック用デバイスを返します。

INovelEngineを実装しています。

const IDrawManager* GetDraw ( ) const [virtual]

グラフィック用デバイスを取得します。

戻り値:: グラフィック用デバイスを返します。

INovelEngineを実装しています。

void Run ( )

ノベルエンジンを実行します。

void Run ( const string & LabelName )

指定したラベルからノベルエンジンを実行します。

引数:

LabelName [in]ラベル名を指定します。

void Resume ( )

ノベルエンジンを一時停止モードから復帰させます。

void Resume ( const string & LabelName )

指定したラベルからノベルエンジンを一時停止モードから復帰させます。

引数:

LabelName [in]ラベル名を指定します。

virtual HWND GetMyAppHWND ( ) const [pure virtual]

ウインドウハンドルを取得します。

取得するように実装してください。

戻り値:: ウインドウハンドルを返します。

INovelEngineを実装しています。

unsigned int GetState ( ) const [virtual]

ノベルエンジンの状態を取得します。

戻り値:: ノベルエンジンの状態を返します。

INovelEngineを実装しています。

void SetState ( unsigned int State ) [virtual]

ノベルエンジンの状態を設定します。

引数:

State [in]ノベルエンジンの状態を指定します。

INovelEngineを実装しています。

void PopState ( )

ノベルエンジンの状態をスタックからポップします。

void PushState ( unsigned int State ) [virtual]

ノベルエンジンの状態をスタックにプッシュします。

引数:

State [in]ノベルエンジンの状態を指定します。

INovelEngineを実装しています。

void InitState ( )

ノベルエンジンの状態を初期化します。

ノベルエンジンの状態のスタックをクリアし、通常モードをプッシュします。

void EnableSystem ( )

入力受付を有効化します。

入力受付とは、ユーザー入力に対する受付です。
全てのボタンの表示非表示が元に戻り、入力受付フラグが有効になります。
シーンクラスではGetSystemStateメソッドの戻り値を元に、入力受付の有無を制御してください。
重複しての呼び出しは禁止です、有効にしている間に再度本メソッドを呼ぶとランタイムエラーが発生します。

void DisableSystem ( )

入力受付を無効化します。

入力受付とは、ユーザー入力に対する受付です。
一時的に全てのボタンを非表示にし、入力受付フラグが無効になります。
シーンクラスではGetSystemStateメソッドの戻り値を元に、入力受付の有無を制御してください。
重複しての呼び出しは禁止です、無効にしている間に再度本メソッドを呼ぶとランタイムエラーが発生します。

bool GetSystemState ( ) const

入力受付の有無を取得します。

入力受付とは、ユーザー入力に対する受付です。
シーンクラスでは本メソッドの戻り値を元に、入力受付の有無を制御してください。

戻り値:: 入力受付の有無を返します。

bool GetMenu ( ) const [virtual]

メニュー呼び出しの可能・不可能を取得します。

戻り値:: メニュー呼び出しの可能・不可能を返します。
可能な場合はtrueを、不可能な場合はfalseを返します。

INovelEngineを実装しています。

void SetMenu ( bool IsMenu ) [virtual]

メニュー呼び出しの可能・不可能を設定します。

戻り値:: メニュー呼び出しの可能・不可能を指定します。
可能にする場合はtrueを、不可能にする場合はfalseを指定します。

INovelEngineを実装しています。

bool IsUsedSE ( const char * FileName ) const [virtual]

音声ファイルが現在ＳＥとして使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルが現在ＳＥとして使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

INovelEngineを実装しています。

bool IsUsedBGM ( const char * FileName ) const [virtual]

音声ファイルが現在ＢＧＭとして使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルが現在ＢＧＭとして使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

INovelEngineを実装しています。

bool IsUsedVoice ( const char * FileName ) const [virtual]

音声ファイルが現在音声として使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルが現在音声として使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

INovelEngineを実装しています。

bool IsUsedImage ( const char * FileName ) const [virtual]

画像ファイルが現在使用されているかを取得します。

引数:

FileName [in]画像ファイル名を指定します。

戻り値:: 画像ファイルが現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

INovelEngineを実装しています。

bool LoadScript	(	const string &	FileName,
		IIOStream *	IOStream
	)

スクリプトファイルを読み込みます。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

bool SaveLocalData	(	const char *	FileName,
		IIOStream *	IOStream
	)		`[virtual]`

ローカルデータを保存します。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

INovelEngineを実装しています。

bool LoadLocalData	(	const char *	FileName,
		IIOStream *	IOStream
	)		`[virtual]`

ローカルデータを読み込みます。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

INovelEngineを実装しています。

bool SaveGlobalData	(	const string &	FileName,
		IIOStream *	IOStream
	)

グローバルデータを保存します。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

bool LoadGlobalData	(	const string &	FileName,
		IIOStream *	IOStream
	)

グローバルデータを読み込みます。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

bool SaveEnvironmentData	(	const string &	FileName,
		IIOStream *	IOStream
	)

環境設定を保存します。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

bool LoadEnvironmentData	(	const string &	FileName,
		bool	AllowChangeDisplayMode,
		IIOStream *	IOStream
	)

環境設定を読み込みます。

引数:

FileName	[in]ファイル名を指定します。
AllowChangeDisplayMode	[in]環境設定ファイル内に保存された値を元に、画面モードを変更するかを指定します。 trueの場合は変更し、falseの場合は変更しません。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

bool AddLoadObject	(	const char *	FileName,
		IIOStream *	IOStream
	)		`[virtual]`

オブジェクトファイルを追加で読み込みます。

オブジェクトファイルとは、リンカを通していないスクリプトファイルのことです。
以下の場合は失敗しfalseを返します。
・オブジェクトファイルではない
・オブジェクトファイルが存在しない
・オブジェクトファイルで既存の読み込み済みスクリプトファイルと同名のラベルが定義されている
・オブジェクトファイルで既存の読み込み済みスクリプトファイルに存在しないラベルが参照されている
・オブジェクトファイルで既存の読み込み済みスクリプトファイルと同名のシンボルが異なる種類で定義されている
・オブジェクトファイルで既存の読み込み済みスクリプトファイルに存在しないシンボルが参照されている
　（ただし既存の読み込み済みスクリプトファイルで外部変数として定義され、オブジェクトファイルで内部変数として参照されている場合を除く）

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

戻り値:: 成功した場合はtrue、失敗した場合はfalseを返します。

INovelEngineを実装しています。

void SetIOStreamUseInScript ( IIOStream * IOStream ) [virtual]

使用するデータ入出力クラスを設定します。

引数:

IOStream [in]使用するデータ入出力クラスを指定します。

INovelEngineを実装しています。

IIOStream* GetIOStreamUseInScript ( ) const [virtual]

使用するデータ入出力クラスを取得します。

戻り値:: 使用するデータ入出力クラスを返します。

INovelEngineを実装しています。

void SetNormalScene ( IScene_Base * Scene )

通常モードで使用するシーンクラスを設定します。

引数:

Scene [in]通常モードで使用するシーンクラスを指定します。

void SetBackLogScene ( IScene_Base * Scene )

既読履歴モードで使用するシーンクラスを設定します。

引数:

Scene [in]既読履歴モードで使用するシーンクラスを指定します。

void SetSaveScene ( IScene_Base * Scene )

セーブモードで使用するシーンクラスを設定します。

引数:

Scene [in]セーブモードで使用するシーンクラスを指定します。

void SetLoadScene ( IScene_Base * Scene )

ロードモードで使用するシーンクラスを設定します。

引数:

Scene [in]ロードモードで使用するシーンクラスを指定します。

void SetConfigScene ( IScene_Base * Scene )

環境設定モードで使用するシーンクラスを設定します。

引数:

Scene [in]環境設定モードで使用するシーンクラスを指定します。

void SetMenuScene ( IScene_Base * Scene )

メニューモードで使用するシーンクラスを設定します。

引数:

Scene [in]メニューモードで使用するシーンクラスを指定します。

virtual void _Suspend ( ) [inline, protected, virtual]

一時停止モード時に呼び出されるメソッドです。

デフォルトは空メソッドです。
一時停止モード中に行いたい処理がある場合は、本メソッドをオーバーライドしてください。

virtual void _EndApp ( ) [protected, pure virtual]

アプリケーション終了時に呼び出されるメソッドです。

アプリケーションの終了を実装してください。

このクラスの説明は次のファイルから生成されました:

AbyssLibSrc/AbyssLib/AbyssLib/AbyssLib.h

クラス NovelPlayer

Public メソッド

Protected メソッド

説明

コンストラクタとデストラクタ

関数