IBasicQuestPlugin

IBasicQuestPlugin　(script/fgs/basic_quest.fges)

このインターフェイスは汎用マップ用プラグインを扱うインターフェイスです。

●インターフェイスメソッド

名前	概要
`GetPluginName`	プラグイン名を取得します
`GetPluginAuthor`	プラグインの作者を取得します
`GetPluginVersion`	プラグインのバージョンを取得します
`Init`	プラグインを初期化します
`SelectTarget`	目標選択中に呼び出されます
`DecideTarget`	目標確定中に呼び出されます
`CancelTarget`	効果目標セッションが中止された時に呼び出されます
`ClearTarget`	効果目標セッションをクリアする時に呼び出されます
`Update`	毎フレーム更新時に呼び出されます
`FreeMove`	自由移動を開始する時に呼び出されます
`FreeMoveComplete`	自由移動の完了時に呼び出されます
`Idle`	ゲームメインスレッドタスクが空で開始されたフレーム毎に呼び出されます
`Save`	セーブデータをセーブする時に呼び出されます
`Load`	セーブデータをロードする時に呼び出されます
`MapInit`	マップファイルのロード完了時に呼び出されます
`MapLeave`	現在のマップから離れる直前に呼び出されます
`StartTrigger`	イベントトリガーによるハンドラ実行直前に呼び出されます
`EndTrigger`	イベントトリガーによるハンドラ実行後に呼び出されます
`InstallPlugin`	新しいプラグインが追加される時に呼び出されます

IBasicQuestPlugin@@GetPluginName

String GetPluginName()const

このプラグインの名前を取得します。

戻り値：このプラグインの名前を返します。

先頭へ

IBasicQuestPlugin@@GetPluginAuthor

String GetPluginAuthor()const

このプラグインの作者を取得します。

戻り値：このプラグインの作者を返します。

先頭へ

IBasicQuestPlugin@@GetPluginVersion

Integer GetPluginVersion()const

このプラグインのバージョンを取得します。

戻り値：このプラグインのバージョンを返します。

先頭へ

IBasicQuestPlugin@@Init

optional Bool Init(editable BasicQuestScene_Base hostscene)

このプラグインを初期化します。

戻り値：初期化に成功した場合は真を返します。

editable BasicQuestScene_Base hostscene ：接続するシーンオブジェクト。

先頭へ

IBasicQuestPlugin@@SelectTarget

optional Bool SelectTarget(editable BasicQuestScene_Base hostscene,editable TargetSession session)

マップシーン上で目標選択が要求された時に呼び出されます。

戻り値：目標選択を処理した場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable TargetSession session ：[入出力]選択した目標を格納するセッション。

先頭へ

IBasicQuestPlugin@@DecideTarget

optional Bool DecideTarget(editable BasicQuestScene_Base hostscene,editable TargetSession session)

   マップシーン上で目標確定が要求された時に呼び出されます。
   このメソッドが真を返した場合、目標確定処理自体が完了されます。
   行った内容が付加的な処理で他の目標確定処理も実行したい場合は偽を返してください。

戻り値：目標確定を処理した場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable TargetSession session ：[入出力]目標を確定させるセッション。

先頭へ

IBasicQuestPlugin@@CancelTarget

optional Bool DecideTarget(editable BasicQuestScene_Base hostscene,editable TargetSession session)

マップシーン上で行った目標選択がキャンセルされた時に呼び出されます。

戻り値：処理に成功した場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable TargetSession session ：[入出力]キャンセルするセッション。

先頭へ

IBasicQuestPlugin@@ClearTarget

optional Bool ClearTarget(editable BasicQuestScene_Base hostscene,editable TargetSession session)

マップシーン上で行った目標選択のセッション終了時に呼び出されます。
セッションのためにオブジェクトを割り当てている場合はこの応答で解放してください。

戻り値：処理に成功した場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable TargetSession session ：[入出力]終了するセッション。

先頭へ

IBasicQuestPlugin@@Update

optional void Update(editable BasicQuestScene_Base hostscene)

   マップシーンがアクティブな状態で毎フレーム呼び出されます。
   このメソッドはマップロード処理中は呼び出されません。

   このメソッドはゲームシステムスレッドで呼び出されます。
   時間の掛かる処理を行う場合は注意してください。
   特にこのメソッドは毎フレーム呼び出されるため、どうしても必要な場合を除き使用しないでください。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。

先頭へ

IBasicQuestPlugin@@FreeMove

optional Bool FreeMove(editable BasicQuestScene_Base hostscene,              editable INativeEventObject player_obj, Integer direction)

   プレイヤーが自由移動(キー入力によっての移動)を行おうとした時に呼び出されます。
   このメソッドが偽を返した場合、プレイヤーの移動操作は無視されます。

戻り値：プレイヤーの移動を許可する場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable INativeEventObject player_obj ：[入出力]プレイヤーイベントオブジェクト。
Integer direction ：移動しようとしている方向ID。

先頭へ

IBasicQuestPlugin@@FreeMoveComplete

optional Bool FreeMoveComplete(editable BasicQuestScene_Base hostscene,              editable INativeEventObject player_obj)

   プレイヤーが自由移動(キー入力によっての移動)を完了した時に呼び出されます。
   このメソッドは自由移動の完了時に呼び出されます。

   注：このメソッドは FreeMove と対になっているわけではありません。
      自由移動が実行された場合のみ呼び出されます。

戻り値：このフレームに次の自由移動を開始しても良い場合は真を返します。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable INativeEventObject player_obj ：[入出力]プレイヤーイベントオブジェクト。

先頭へ

IBasicQuestPlugin@@Idle

optional void Idle(editable BasicQuestScene_Base hostscene)

マップシーンがアクティブであり、
ゲームシステムスレッドおよびゲームメインスレッドにタスクがない状態で開始されたフレームに呼び出されます。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。

先頭へ

IBasicQuestPlugin@@Save

optional void Save(editable BasicQuestScene_Base hostscene,editable DataStoreWriter writer)

   ゲームデータをセーブする時に呼び出されます。

   このメソッドはゲームシステムスレッドで呼び出されます。
   データを正しくセーブするため、このメソッド内で処理を完了してください。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable DataStoreWriter writer ：[出力]セーブ対象のファイル。

先頭へ

IBasicQuestPlugin@@Load

optional void Load(editable BasicQuestScene_Base hostscene, DataStoreReader reader)

   ゲームデータをロードする時に呼び出されます。

   このメソッドはゲームシステムスレッドで呼び出されます。
   データを正しくロードするため、このメソッド内で処理を完了してください。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
DataStoreReader reader ：ロード対象のファイル。

先頭へ

IBasicQuestPlugin@@MapInit

optional void MapInit(editable BasicQuestScene_Base hostscene)

マップのロードが完了した時に呼び出されます。
このメソッドはマップのロードが完了した後、移動後エフェクトが開始される前に呼び出されます。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。

先頭へ

IBasicQuestPlugin@@MapLeave

optional void MapLeave(editable BasicQuestScene_Base hostscene)

   現在のマップから離れて別のマップをロードする時に呼び出されます。
   このメソッドは移動前エフェクトが完了して画面凍結が行われた後、
   マップローカルリソースを解放する前に呼び出されます。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。

先頭へ

IBasicQuestPlugin@@StartTrigger

optional void StartTrigger(editable BasicQuestScene_Base hostscene,              editable INativeEventObject triggerobj,editable INativeEventObject? pairobj,              Integer triggerid)

   イベントトリガーによるイベントの処理が開始される直前に呼び出されます。
   このメソッドはイベントトリガーで起動されるハンドラ毎に呼び出されます。
   一つのイベントトリガーで二つ以上のハンドラが起動される場合、その全てに対して一度づつ呼び出されます。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable INativeEventObject triggerobj ：[入出力]トリガーに応答したイベントオブジェクト。
editable INativeEventObject? pairobj ：[入出力]トリガーでペアリングされたイベントオブジェクト。
Integer triggerid ：起動したトリガーの種類。以下のいずれか。

識別名	内容
`TileMapEventScene::STATEHANDLER_PL_RECEIVECHECK`	「プレイヤーから調べられた」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_RECEIVETOUCH`	「プレイヤーから接触された」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_HOSTCHECK`	「プレイヤーを調べた」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_HOSTTOUCH`	「プレイヤーへ接触した」ハンドラ
`TileMapEventScene::STATEHANDLER_AUTO`	「自動開始」ハンドラ
`TileMapEventScene::STATEHANDLER_RECEIVECHECK`	「他のイベントから調べられた」ハンドラ
`TileMapEventScene::STATEHANDLER_RECEIVETOUCH`	「他のイベントから接触された」ハンドラ
`TileMapEventScene::STATEHANDLER_HOSTCHECK`	「他のイベントを調べた」ハンドラ
`TileMapEventScene::STATEHANDLER_HOSTTOUCH`	「他のイベントへ接触した」ハンドラ
`TileMapEventScene::STATEHANDLER_CHANGE`	「この状態になった」ハンドラ
`TileMapEventScene::STATEHANDLER_EXTRA`	「拡張応答」ハンドラ

先頭へ

IBasicQuestPlugin@@EndTrigger

optional void EndTrigger(editable BasicQuestScene_Base hostscene,              editable INativeEventObject triggerobj,editable INativeEventObject? pairobj,              Integer triggerid)

   イベントトリガーによるイベントの処理が完了した直後に呼び出されます。
   このメソッドはイベントトリガーで起動されたハンドラ毎に呼び出されます。
   一つのイベントトリガーで二つ以上のハンドラが起動された場合、その全てに対して一度づつ呼び出されます。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
editable INativeEventObject triggerobj ：[入出力]トリガーに応答したイベントオブジェクト。
editable INativeEventObject? pairobj ：[入出力]トリガーでペアリングされたイベントオブジェクト。
Integer triggerid ：起動したトリガーの種類。以下のいずれか。

識別名	内容
`TileMapEventScene::STATEHANDLER_PL_RECEIVECHECK`	「プレイヤーから調べられた」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_RECEIVETOUCH`	「プレイヤーから接触された」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_HOSTCHECK`	「プレイヤーを調べた」ハンドラ
`TileMapEventScene::STATEHANDLER_PL_HOSTTOUCH`	「プレイヤーへ接触した」ハンドラ
`TileMapEventScene::STATEHANDLER_AUTO`	「自動開始」ハンドラ
`TileMapEventScene::STATEHANDLER_RECEIVECHECK`	「他のイベントから調べられた」ハンドラ
`TileMapEventScene::STATEHANDLER_RECEIVETOUCH`	「他のイベントから接触された」ハンドラ
`TileMapEventScene::STATEHANDLER_HOSTCHECK`	「他のイベントを調べた」ハンドラ
`TileMapEventScene::STATEHANDLER_HOSTTOUCH`	「他のイベントへ接触した」ハンドラ
`TileMapEventScene::STATEHANDLER_CHANGE`	「この状態になった」ハンドラ
`TileMapEventScene::STATEHANDLER_EXTRA`	「拡張応答」ハンドラ

先頭へ

IBasicQuestPlugin@@InstallPlugin

optional void InstallPlugin(editable BasicQuestScene_Base hostscene,              IBasicQuestPlugin plugin_obj)

   このプラグインの後にプラグインがインストールされようとしている時に呼び出されます。
   このプラグイン自身がインストールされる時に自分を引数に呼び出されることはありません。
   このメソッドは通知のみです。プラグインのインストールについて干渉することはできません。

editable BasicQuestScene_Base hostscene ：[入出力]呼び出し元のシーンオブジェクト。
IBasicQuestPlugin plugin_obj ：インストールされるプラグインオブジェクト。

先頭へ

[前へ] [目次へ]

最終更新 2018/05/28

IBasicQuestPlugin (script/fgs/basic_quest.fges)

●インターフェイスメソッド

IBasicQuestPlugin　(script/fgs/basic_quest.fges)