AbyssLib 1.301
あびす謹製ノベルゲームフレームワークライブラリ

ネームスペース nsAbyssLib::nsPlugins

型定義

typedef ICmd_Base *(* FactoryFunc )()
 命令クラスFactory関数の型定義です。
typedef void(* UpdateFunc )(INovelEngine *)
 画面更新関数の型定義です。
typedef void(* EffectFunc )(INovelEngine *)
 画面効果関数の型定義です。
typedef int(* AnalysisFunc )(unsigned int)
 構文解析関数の型定義です。
typedef void(* SaveLocalDataFunc )(INovelEngine *, IIOStream *)
 ローカル設定保存関数の型定義です。
typedef void(* LoadLocalDataFunc )(INovelEngine *, IIOStream *)
 ローカル設定読み込み関数の型定義です。
typedef void(* SaveEnvironmentDataFunc )(INovelEngine *, IIOStream *)
 環境設定保存関数の型定義です。
typedef void(* LoadEnvironmentDataFunc )(INovelEngine *, IIOStream *)
 環境設定読み込み関数の型定義です。
typedef void(* AddDrawTaskFunc )(INovelEngine *, const DrawTask &)
 描画タスク追加関数の型定義です。
typedef void(* DrawTaskFunc )(INovelEngine *, const DrawTask &)
 描画タスク処理関数の型定義です。
typedef void(* BltFunc )(INovelEngine *, const DrawTask &)
 描画関数の型定義です。

関数

void LoadPlugin ()
 プラグインを読み込みます。
void FreePlugin ()
 読み込んだプラグインを解放します。
void FreeCommand (INovelEngine *Outer)
 全ての命令クラスを解放します。
int GetAbyssLibVersion ()
 AbyssLibのバージョンを取得します。
void RegisterPFactory (unsigned int PID, FactoryFunc PFunc)
 命令クラスFactory関数を登録マップに登録します。
void RegisterPUpdate (unsigned int PID, UpdateFunc PFunc)
 画面更新関数を登録マップに登録します。
void RegisterPEffect1 (unsigned int PID, EffectFunc PFunc)
 画面効果(各種描画前)関数を登録マップに登録します。
void RegisterPEffect2 (unsigned int PID, EffectFunc PFunc)
 画面効果(テキストウインドウ描画前)関数を登録マップに登録します。
void RegisterPEffect3 (unsigned int PID, EffectFunc PFunc)
 画面効果(テキストウインドウ描画後)関数を登録マップに登録します。
void RegisterPAnalysis (unsigned int PID, AnalysisFunc PFunc)
 構文解析関数を登録マップに登録します。
void RegisterPCommandName (const char *PName, unsigned int PID)
 識別子名を登録マップに登録します。
void RegisterPEnableSystemCommand (unsigned int PID)
 排他制御を行わない命令を登録リストに登録します。
void RegisterPSaveLocalDataFunc (const char *PName, SaveLocalDataFunc PFunc)
 ローカルデータの保存関数を登録マップに登録します。
void RegisterPLoadLocalDataFunc (const char *PName, LoadLocalDataFunc PFunc)
 ローカルデータの読み込み関数を登録マップに登録します。
void RegisterPSaveEnvironmentDataFunc (const char *PName, SaveEnvironmentDataFunc PFunc)
 環境設定の保存関数を登録マップに登録します。
void RegisterPLoadEnvironmentDataFunc (const char *PName, LoadEnvironmentDataFunc PFunc)
 環境設定の読み込み関数を登録マップに登録します。
void RegisterPAddDrawTaskFunc (unsigned int PID, AddDrawTaskFunc PFunc)
 描画タスク追加関数を登録マップに登録します。
void RegisterPDrawTaskFunc (unsigned int PID, DrawTaskFunc PFunc)
 描画タスク処理関数を登録マップに登録します。
void RegisterPBltFunc (unsigned int PID, BltFunc PFunc)
 描画関数を登録マップに登録します。

変数

map< unsigned int, FactoryFuncPFactory
 プラグインなどから取得した命令クラスFactory関数の登録マップです。
map< unsigned int, UpdateFuncPUpdate
 プラグインなどから取得した画面更新関数の登録マップです。
map< unsigned int, EffectFuncPEffect1
 プラグインなどから取得した画面効果関数(各種描画前)の登録マップです。
map< unsigned int, EffectFuncPEffect2
 プラグインなどから取得した画面効果関数(テキストウインドウ描画前)の登録マップです。
map< unsigned int, EffectFuncPEffect3
 プラグインなどから取得した画面効果関数(テキストウインドウ描画後)の登録マップです。
map< unsigned int, AnalysisFuncPAnalysis
 プラグインなどから取得した構文解析関数の登録マップです。
map< string, unsigned int > PCommandName
 プラグインなどから取得した命令の識別子名の登録マップです。
vector< unsigned int > PEnableSystemCommand
 プラグインなどから取得した排他制御を行わない命令の登録リストです。
map< string, SaveLocalDataFuncPSaveLocalDataFunc
 プラグインなどから取得したローカルデータの保存関数の登録マップです。
map< string, LoadLocalDataFuncPLoadLocalDataFunc
 プラグインなどから取得したローカルデータの読み込み関数の登録マップです。
map< string,
SaveEnvironmentDataFunc
PSaveEnvironmentDataFunc
 プラグインなどから取得した環境設定の保存関数の登録マップです。
map< string,
LoadEnvironmentDataFunc
PLoadEnvironmentDataFunc
 プラグインなどから取得した環境設定の読み込み関数の登録マップです。
map< unsigned int,
AddDrawTaskFunc
PAddDrawTaskFunc
 プラグインなどから取得した描画タスクの追加関数の登録マップです。
map< unsigned int, DrawTaskFuncPDrawTaskFunc
 プラグインなどから取得した描画タスクの処理関数の登録マップです。
map< unsigned int, BltFuncPBltFunc
 プラグインなどから取得した描画関数の登録マップです。

型定義

typedef ICmd_Base*(* FactoryFunc)()

命令クラスFactory関数の型定義です。

typedef void(* UpdateFunc)(INovelEngine *)

画面更新関数の型定義です。

typedef void(* EffectFunc)(INovelEngine *)

画面効果関数の型定義です。

typedef int(* AnalysisFunc)(unsigned int)

構文解析関数の型定義です。

typedef void(* SaveLocalDataFunc)(INovelEngine *, IIOStream *)

ローカル設定保存関数の型定義です。

typedef void(* LoadLocalDataFunc)(INovelEngine *, IIOStream *)

ローカル設定読み込み関数の型定義です。

typedef void(* SaveEnvironmentDataFunc)(INovelEngine *, IIOStream *)

環境設定保存関数の型定義です。

typedef void(* LoadEnvironmentDataFunc)(INovelEngine *, IIOStream *)

環境設定読み込み関数の型定義です。

typedef void(* AddDrawTaskFunc)(INovelEngine *, const DrawTask &)

描画タスク追加関数の型定義です。

typedef void(* DrawTaskFunc)(INovelEngine *, const DrawTask &)

描画タスク処理関数の型定義です。

typedef void(* BltFunc)(INovelEngine *, const DrawTask &)

描画関数の型定義です。


関数

void nsAbyssLib::nsPlugins::LoadPlugin ( )

プラグインを読み込みます。

同一フォルダ内に存在するDLLを逐一チェックし、プラグインである場合は読み込みます。

void nsAbyssLib::nsPlugins::FreePlugin ( )

読み込んだプラグインを解放します。

プログラム終了時に必ず呼び出すようにしてください。
また、本関数を呼び出す前に必ず全てのノベルエンジンクラスに対してFreeCommand関数を呼び出すようにしてください。

void nsAbyssLib::nsPlugins::FreeCommand ( INovelEngine *  Outer)

全ての命令クラスを解放します。

プログラム終了時に必ず呼び出すようにしてください。
FreePlugin関数を呼び出す前に必ず全てのノベルエンジンクラスに対して本関数を呼び出してください。

引数:
Outer[in]全命令クラス解放の対象となるノベルエンジンクラスを指定します。
int nsAbyssLib::nsPlugins::GetAbyssLibVersion ( )

AbyssLibのバージョンを取得します。

戻り値:
AbyssLibのバージョンを返します。
void nsAbyssLib::nsPlugins::RegisterPFactory ( unsigned int  PID,
FactoryFunc  PFunc 
)

命令クラスFactory関数を登録マップに登録します。

本関数にて登録マップに登録された命令クラスFactory関数は、命令クラス生成時に呼び出されます。

引数:
PID[in]命令クラスに対応した一意の値を指定します。
PFunc[in]命令クラスFactory関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPUpdate ( unsigned int  PID,
UpdateFunc  PFunc 
)

画面更新関数を登録マップに登録します。

本関数にて登録マップに登録された画面更新関数は、画面更新時に呼び出されます。

引数:
PID[in]画面更新パターンに対応した一意の値を指定します。
PFunc[in]画面更新関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPEffect1 ( unsigned int  PID,
EffectFunc  PFunc 
)

画面効果(各種描画前)関数を登録マップに登録します。

本関数にて登録マップに登録された画面効果関数は、画面効果(各種描画前)時に呼び出されます。

引数:
PID[in]画面効果(各種描画前)パターンに対応した一意の値を指定します。
PFunc[in]画面効果(各種描画前)関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPEffect2 ( unsigned int  PID,
EffectFunc  PFunc 
)

画面効果(テキストウインドウ描画前)関数を登録マップに登録します。

本関数にて登録マップに登録された画面効果関数は、画面効果(テキストウインドウ描画前)時に呼び出されます。

引数:
PID[in]画面効果(テキストウインドウ描画前)パターンに対応した一意の値を指定します。
PFunc[in]画面効果(テキストウインドウ描画前)関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPEffect3 ( unsigned int  PID,
EffectFunc  PFunc 
)

画面効果(テキストウインドウ描画後)関数を登録マップに登録します。

本関数にて登録マップに登録された画面効果関数は、画面効果(テキストウインドウ描画後)時に呼び出されます。

引数:
PID[in]画面効果(テキストウインドウ描画後)パターンに対応した一意の値を指定します。
PFunc[in]画面効果(テキストウインドウ描画後)関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPAnalysis ( unsigned int  PID,
AnalysisFunc  PFunc 
)

構文解析関数を登録マップに登録します。

本関数にて登録マップに登録された構文解析関数は、構文解析時に呼び出されます。

引数:
PID[in]命令クラスに対応した一意の値を指定します。
PFunc[in]構文解析関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPCommandName ( const char *  PName,
unsigned int  PID 
)

識別子名を登録マップに登録します。

本関数にて登録マップに登録された識別子名は、構文解析時に参照されます。

引数:
PName[in]識別子名を指定します。
PID[in]命令クラスに対応した一意の値を指定します。
void nsAbyssLib::nsPlugins::RegisterPEnableSystemCommand ( unsigned int  PID)

排他制御を行わない命令を登録リストに登録します。

本関数にて登録リストに登録された排他制御を行わない命令は、命令クラス実行前後で参照されます。

引数:
PID[in]命令クラスに対応した一意の値を指定します。
void nsAbyssLib::nsPlugins::RegisterPSaveLocalDataFunc ( const char *  PName,
SaveLocalDataFunc  PFunc 
)

ローカルデータの保存関数を登録マップに登録します。

本関数にて登録マップに登録されたローカルデータの保存関数は、ローカルデータの保存時に呼び出されます。

引数:
PName[in]プラグイン名を指定します。
PFunc[in]ローカルデータの保存関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPLoadLocalDataFunc ( const char *  PName,
LoadLocalDataFunc  PFunc 
)

ローカルデータの読み込み関数を登録マップに登録します。

本関数にて登録マップに登録されたローカルデータの読み込み関数は、ローカルデータの読み込み時に呼び出されます。

引数:
PName[in]プラグイン名を指定します。
PFunc[in]ローカルデータの読み込み関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPSaveEnvironmentDataFunc ( const char *  PName,
SaveEnvironmentDataFunc  PFunc 
)

環境設定の保存関数を登録マップに登録します。

本関数にて登録マップに登録された環境設定の保存関数は、環境設定の保存時に呼び出されます。

引数:
PName[in]プラグイン名を指定します。
PFunc[in]環境設定の保存関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPLoadEnvironmentDataFunc ( const char *  PName,
LoadEnvironmentDataFunc  PFunc 
)

環境設定の読み込み関数を登録マップに登録します。

本関数にて登録マップに登録された環境設定の読み込み関数は、環境設定の読み込み時に呼び出されます。

引数:
PName[in]プラグイン名を指定します。
PFunc[in]環境設定の読み込み関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPAddDrawTaskFunc ( unsigned int  PID,
AddDrawTaskFunc  PFunc 
)

描画タスク追加関数を登録マップに登録します。

本関数にて登録マップに登録された描画タスク追加関数は、描画タスク追加時に呼び出されます。

引数:
PID[in]描画タスクに対応した一意の値を指定します。
PFunc[in]描画タスク追加関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPDrawTaskFunc ( unsigned int  PID,
DrawTaskFunc  PFunc 
)

描画タスク処理関数を登録マップに登録します。

本関数にて登録マップに登録された描画タスク処理関数は、描画タスク描画時に呼び出されます。

引数:
PID[in]描画タスクに対応した一意の値を指定します。
PFunc[in]描画タスク処理関数を指定します。
void nsAbyssLib::nsPlugins::RegisterPBltFunc ( unsigned int  PID,
BltFunc  PFunc 
)

描画関数を登録マップに登録します。

本関数にて登録マップに登録された描画関数は、描画時に呼び出されます。

引数:
PID[in]描画方法に対応した一意の値を指定します。
PFunc[in]描画関数を指定します。

変数

map<unsigned int, FactoryFunc> PFactory

プラグインなどから取得した命令クラスFactory関数の登録マップです。

RegisterPFactory関数で命令クラスFactory関数を登録することで命令の拡張が可能です。

map<unsigned int, UpdateFunc> PUpdate

プラグインなどから取得した画面更新関数の登録マップです。

RegisterPUpdate関数で画面更新関数を登録することで画面更新の拡張が可能です。

map<unsigned int, EffectFunc> PEffect1

プラグインなどから取得した画面効果関数(各種描画前)の登録マップです。

RegisterPEffect1関数で画面効果関数を登録することで画面効果の拡張が可能です。

map<unsigned int, EffectFunc> PEffect2

プラグインなどから取得した画面効果関数(テキストウインドウ描画前)の登録マップです。

RegisterPEffect2関数で画面効果関数を登録することで画面効果の拡張が可能です。

map<unsigned int, EffectFunc> PEffect3

プラグインなどから取得した画面効果関数(テキストウインドウ描画後)の登録マップです。

RegisterPEffect3関数で画面効果関数を登録することで画面効果の拡張が可能です。

map<unsigned int, AnalysisFunc> PAnalysis

プラグインなどから取得した構文解析関数の登録マップです。

RegisterPAnalysis関数で構文解析関数を登録することで命令の拡張が可能です。

map<string, unsigned int> PCommandName

プラグインなどから取得した命令の識別子名の登録マップです。

RegisterPCommandName関数で識別子名を登録することで命令の拡張が可能です。

vector<unsigned int> PEnableSystemCommand

プラグインなどから取得した排他制御を行わない命令の登録リストです。

RegisterPEnableSystemCommand関数で排他制御を行わない命令を登録することで命令の拡張が可能です。
排他制御を行う(=本登録リストに命令を登録しない)命令は、以下のように動作します。
・命令実行中は既読履歴やメニューの呼び出しなどといった「命令以外のこと」を一切行えなくなります

プラグインなどから取得したローカルデータの保存関数の登録マップです。

RegisterPSaveLocalDataFunc関数でローカルデータの保存関数を登録することでセーブデータの拡張が可能です。

プラグインなどから取得したローカルデータの読み込み関数の登録マップです。

RegisterPLoadLocalDataFunc関数でローカルデータの読み込み関数を登録することでセーブデータの拡張が可能です。

プラグインなどから取得した環境設定の保存関数の登録マップです。

RegisterPSaveEnvironmentDataFunc関数で環境設定の保存関数を登録することでセーブデータの拡張が可能です。

プラグインなどから取得した環境設定の読み込み関数の登録マップです。

RegisterPLoadEnvironmentDataFunc関数で環境設定の読み込み関数を登録することでセーブデータの拡張が可能です。

map<unsigned int, AddDrawTaskFunc> PAddDrawTaskFunc

プラグインなどから取得した描画タスクの追加関数の登録マップです。

RegisterPAddDrawTaskFunc関数で描画タスクの追加関数を登録することで描画タスクの拡張が可能です。

map<unsigned int, DrawTaskFunc> PDrawTaskFunc

プラグインなどから取得した描画タスクの処理関数の登録マップです。

RegisterPDrawTaskFunc関数で描画タスクの処理関数を登録することで描画タスクの拡張が可能です。

map<unsigned int, BltFunc> PBltFunc

プラグインなどから取得した描画関数の登録マップです。

RegisterPBltFunc関数で描画関数を登録することで描画タスクの拡張が可能です。

 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 フレンド マクロ定義