FGS Ver1.00 公式ドキュメント


FGS Ver1.00 のドキュメントです。

現在の仕様は仮のもので、更新版リリース時に適宜更新される予定です。

●基本資料
   ●素材規格
   ●マップタイル詳細解説
   ●他のゲーム制作ツール用規格素材の規格変換方法
   ●クイックガイド

●ゲーム用プリセットスクリプト
script フォルダに収録されているプリセットスクリプトのドキュメントです。
プリセットスクリプトのうち、 fgs や editor フォルダにあるファイルはFGS本体の一部として更新するため、
編集しないようにしてください。
それ以外のファイルはサンプルスクリプトで、
作成するゲームに合わせてカスタマイズすることを想定しています。

グローバル名前空間に定義される項目



script/fgs/system.fges ：ゲーム実行用システムスクリプトです。
システムスクリプトは最初にコンパイルされ、ゲームジャンルに関わらず使用する機能が定義されています。
クラス名概要
GameIntゲーム整数変数への擬似参照
GameStringゲーム文字列変数への擬似参照
BindThreadObjectスレッド拘束オブジェクト
FreezeViewObject画面凍結オブジェクト
EventGraphicInfoイベントグラフィック構造体
WaitArray待機対象オブジェクト配列
ATR_Relay他の項目値を返す動作規則
ATR_LayeredRules独立した動作規則グループを扱うクラス
ATR_Translator経過時間に動作規則を適用するクラス
AnimateTransUnit_Base動作規則を適用する基底クラス
AnimateTransUnitHost動作規則を適用するクラスをまとめて処理するクラス
AnimateTransUnitPos_Base位置に動作規則を適用する基底クラス
AnimateTransUnitRect_Base矩形に動作規則を適用する基底クラス
AnimateTransUnitAlpha_Base透過度に動作規則を適用する基底クラス
AnimateTransUnitTone_Base色に動作規則を適用する基底クラス
AnimateTransUnitRotate_Base回転に動作規則を適用する基底クラス
ATU_WindowPosウィンドウ位置に動作規則を適用するクラス
ATU_WindowRectウィンドウの位置と大きさに動作規則を適用するクラス
ATU_WindowAlphaウィンドウの透過度に動作規則を適用するクラス
ATU_WindowToneウィンドウの色に動作規則を適用するクラス
ATU_WindowRotateウィンドウの回転処理に動作規則を適用するクラス
ATU_EventPosイベントオブジェクトの位置に動作規則を適用するクラス
ATU_EventRectイベントオブジェクトの位置と大きさに動作規則を適用するクラス
ATU_EventAlphaイベントオブジェクトの透過度に動作規則を適用するクラス
ATU_EventToneイベントオブジェクトの色に動作規則を適用するクラス
ATU_EventRotateイベントオブジェクトの回転に動作規則を適用するクラス
ATU_DRLayerPosDRリンクの位置に動作規則を適用するクラス
ATU_DRLayerRectDRリンクの位置と大きさに動作規則を適用するクラス
AnimateTransfer_Base動作規則集合用抽象基底クラス
JWindowTransferウィンドウ動作規則集合を一括定義する注入用クラス
JEventTransferイベント動作規則集合を一括定義する注入用クラス
WindowTransferウィンドウ動作規則集合を扱うクラス
EventTransferイベント動作規則集合を扱うクラス
DRLayerRotateTransferDRリンク動作規則集合を扱うクラス
DRLayerRotateTransfer::ATU_AlphaDRリンクの透過度に動作規則を適用するクラス
DRLayerRotateTransfer::ATU_ToneDRリンクの色に動作規則を適用するクラス
DRLayerRotateTransfer::ATU_RotateDRリンクの回転処理に動作規則を適用するクラス
DRLayerRotateTransfer::ATU_RotatePosDRリンクの回転範囲を含めて動作規則を適用するクラス
ExClosureCallerスレッド越境クロージャ呼出クラス
JMessageLibメッセージウィンドウ用ライブラリ注入用クラス
MessageWindow_Baseメッセージウィンドウ用基底クラス
SaveLockObjectセーブロックオブジェクト
SaveFileScene_Baseセーブファイル管理シーン用基底クラス
EventDataWindowイベント情報を表示するデバッガ用ウィンドウ
EventDebugWindowイベント情報を表示するデバッガ用ウィンドウ
GameVarEditorWindowゲーム変数を表示/編集するデバッガ用ウィンドウ
CacheManagerキャッシュマネージャ
DefineManager定義予約用マネージャ
TransitionEffectManagerフェードエフェクトメソッドマネージャ
TransitionEffectManager::ColorFader単色フェードエフェクト
TransitionEffectManager::RasterScrollラスタスクロールエフェクト
TransitionEffectManager::Mosaicモザイクエフェクト
TransitionEffectManager::Roll巻物風エフェクト
TransitionEffectManager::AlphaMaskアルファマスクによるフェードエフェクト
TransitionEffectManager::LayerMaskレイヤーマスクによるフェードエフェクト
TransitionEffectManager::FadeMaskトランジションマスクによるフェードエフェクト
TransitionEffectManager::FreezeViewエフェクト扱いの画面凍結制御
GameSpeedManagerゲームスピードマネージャ
GameSpeedManager::GameSpeedConfigSceneゲームスピードマネージャの設定シーンクラス
GameSystemSettingsゲームシステム設定

インターフェイス名概要
IWaitSignal完了待機用状態確認インターフェイス



script/fgs/system_multipart.fges ：ゲーム/エディタ共有システムスクリプトです。
システムスクリプトのうち、ゲーム側とエディタ側両方で有用なクラスが定義されています。
クラス名概要
TemplateScriptManagerテンプレートスクリプトマネージャ
TemplateScriptManager::TemplateScriptInfoテンプレートスクリプトデータ
FocusLockObjectフォーカスロックオブジェクト
UpdateDriverフレーム更新一括呼び出しクラス
JNativeWindowTemplateINativeWindow に対応するクラスメンバメソッドを一括定義する注入用クラス
JNativeWindowRedirectINativeWindow へのリダイレクトメソッドを一括定義する注入用クラス
ATR_Const定数を返す動作規則
ATR_Scale倍率を変更する動作規則
ATR_Linear線形変化する動作規則
ATR_Jumpジャンプするような動きをする動作規則
ATR_Easingイージングを計算する動作規則
ATR_Easing_Linear変化量が線形変化する動作規則
ATR_Easing_Square経過時間の二乗を返す動作規則
ATR_Easing_Circle円運動を処理する動作規則
AnimateTransRuleHost動作規則をまとめて処理するクラス
FormulaSpace_Base数式用ネームクラス
JParticleパーティクルクラス用の注入用クラス
PTC_Bitmap_Base静止画パーティクル用抽象基底クラス
PTC_AnimateBitmap_Baseアニメーションパーティクル用抽象基底クラス
PBC_Methodメソッド型パーティクル用演算クラス
PBC_Common汎用パーティクル用演算クラス
PBC_CommonEx汎用フルパーティクル用演算クラス
PBC_ATRATRパーティクル用演算クラス
PBC_ATRExATRフルパーティクル用演算クラス
PTC_Bitmap_Methodメソッド静止画パーティクル
PTC_Bitmap_Common汎用静止画パーティクル
PTC_Bitmap_CommonEx汎用フル静止画パーティクル
PTC_Bitmap_ATRATR静止画パーティクル
PTC_Bitmap_ATRExATRフル静止画パーティクル
PTC_AnimateBitmap_Methodメソッドアニメーションパーティクル
PTC_AnimateBitmap_Common汎用アニメーションパーティクル
PTC_AnimateBitmap_CommonEx汎用フルアニメーションパーティクル
PTC_AnimateBitmap_ATRATRアニメーションパーティクル
PTC_AnimateBitmap_ATRExATRフルアニメーションパーティクル
JParticleHostパーティクルホストクラス用の注入用クラス
ParticleWindowパーティクルを表示するホストウィンドウ
ClippingParticleWindow描画領域を制限してパーティクルを表示するホストウィンドウ
CommonParticleInfo汎用パーティクル情報
ParticleEmitter_Methodメソッド型パーティクルエミッター
ParticleEmitter_Common_Base汎用型パーティクルエミッター用抽象基底クラス
ParticleEmitter_Common汎用型パーティクルエミッター
ParticleEmitter_CommonRef外部参照式汎用型パーティクルエミッター
BasicButtonWindow単純ボタン用ウィンドウ
ButtonWindowボタン用ウィンドウ
CheckWindowチェックボックス用ウィンドウ
DRFrameWindow枠付きのDRウィンドウ
TextWindow枠付きのテキストウィンドウ
SimpleSelectWindow簡易選択肢ウィンドウ
BackFillSelectWindow単色背景付き簡易選択肢ウィンドウ
FrameSelectWindow簡易枠付き選択肢ウィンドウ
RotateBoard回転DRウィンドウ

インターフェイス名概要
IAutoUpdate自動更新用インターフェイス
IUpdateDriverフレーム更新管理用インターフェイス
IAnimatePositionアニメーション処理用座標
IAnimateTransRuleアニメーション処理用動作規則
IParticleパーティクルインターフェイス
IPTC_Methodメソッドパーティクルインターフェイス
IPTC_Common汎用パーティクルインターフェイス
IPTC_CommonEx汎用フルパーティクルインターフェイス
IPTC_ATRATRパーティクルインターフェイス
IPTC_ATRExATRフルパーティクルインターフェイス
IParticleHostパーティクルホストインターフェイス
IParticleEmitterパーティクルエミッターインターフェイス



script/main.fges ：ゲーム実行用メインスクリプトです。
メインスクリプトはゲーム固有のスクリプトを記述するルートスクリプトで、
システムスクリプトのコンパイル後にコンパイルされます。
クラス名概要
TitleSceneタイトル画面用シーンクラス
InitScene初期化用シーンクラス



script/fgs/database.fges ：データベース基本スクリプトです。
ゲームデータベースを使用する場合はこのファイルをインストールしてください。
クラス名概要
DataBaseFactor_Baseデータベース要素用抽象基底クラス
DataBaseReaderデータベース読み込み用抽象クラス
DataBaseManagerデータベースマネージャ
GameDataBaseFactor_Baseゲームデータベース要素用抽象基底クラス
WithIconDataBaseFactor_Baseアイコン付きデータベース要素用抽象基底クラス
DynamicPictureInfo動的構成画像情報
DataBaseReader_DynamicPicture_Base動的構成画像データベース(GDB)
DataBaseReader_DynamicPicture_Base::Factor動的構成画像データベースの要素
DataBaseReader_DynamicPicture_Base::Factor::PatternInfo動的構成画像のパターン情報
DataBaseReader_DynamicPicture_Base::Factor::PatternInfo::JunctionPoint動的構成画像の接続点
DataBaseReader_DynamicPicture_Base::Factor::LayerInfo動的構成画像のレイヤー情報
DynamicPicture動的構成画像用ビットマップ
DRDynamicPicture_Base動的構成画像用DR
DRCrossFadeBitmap_Baseクロスフェード用DR抽象基底クラス
DRCrossFadeBitmap_Base::CrossFadeInfoクロスフェード情報
DRCrossFadeBitmapビットマップクロスフェード用DR
DRCrossFadeDynamicPicture_Base動的構成画像クロスフェード用DR
DataBaseReader_Particle_Baseパーティクルデータベース(GDB)
DataBaseReader_Particle_Base::Factorパーティクルデータベースの要素
DataBaseReader_Particle_Base::Factor::CommonParticle汎用パーティクルデータ
DataBaseReader_Particle_Base::Factor::Formula数式パーティクルデータ
DataBaseReader_Particle_Base::Factor::Methodメソッドパーティクルデータ
DataBaseReader_Particle_Base::Factor::Formula_Params数式パラメータ構造体
DataBaseReader_Animation_Baseアニメーションデータベース(GDB)
DataBaseReader_Animation_Base::Factorアニメーションデータベースの要素
DataBaseReader_Animation_Base::Factor::AnimationInfoアニメーションリスト
DataBaseReader_Animation_Base::Factor::SEInfoSEリスト
DataBaseReader_Animation_Base::Factor::ParticleInfoパーティクルリスト
DRAnimation_Baseアニメーション用DR
DRAnimation_Base::ParticleEmitInfoパーティクル生成情報
AnimationWindowアニメーション簡易表示用ウィンドウ
DataBaseReader_Formula_Base数式データベース(GDB)
DataBaseReader_Formula_Base::Factor数式データベースの要素
DataBaseReader_MotionSet_Base拡張モーションデータベース
DataBaseReader_MotionSet_Base::Factor拡張モーションデータベースの要素
DataBaseReader_ClassPluginクラスプラグインデータベース
DataBaseReader_ClassPlugin::Factorクラスプラグインデータベースの要素
DataBaseReader_ClassPlugin::ExternalClass外部クラスリスト
ECI_FVGClassImporterFVGクラスインポーター
DataBaseReader_Textテキストデータベース
DataBaseReader_Text::Factorテキストデータベースの要素
PlayerDataBaseManagerプレイヤーデータベースマネージャ
PlayerDataBase_Baseプレイヤーデータベース用抽象基底クラス
PDB_System_Baseシステムデータベース(PDB)
SelectTarget_Base目標選択処理用基底クラス
TargetSession目標管理セッション
UsableObject_Base使用可能オブジェクト抽象基底クラス

インターフェイス名概要
IExternalClassImporter外部クラスインポーター
IPlayerDataBaseプレイヤーデータベース
PDB_System_Base::IWatchシステム用ウォッチインターフェイス
IUser使用者
IUseTarget使用目標
IUseEffect使用効果
ITargetSelector目標選択
IUsableObject使用可能オブジェクト



script/fgs/basic_quest.fges ：汎用マップシーン基本スクリプトです。
タイルマップとイベントベースのゲーム用の基本スクリプトです。
脱出、探索、ホラー、RPG、SLGなど、幅広いジャンルのゲームモジュールのベースとして利用できます。
クラス名概要
DataBaseReader_BasicQuest_ChipSetマップチップデータベース
DataBaseReader_BasicQuest_ChipSet::Factorマップチップデータベースの要素
DataBaseReader_BasicQuest_TileSetタイルセットデータベース
DataBaseReader_BasicQuest_TileSet::Factorタイルセットデータベースの要素
DataBaseReader_BasicQuest_MoveHandlerムーブハンドラデータベース
DataBaseReader_BasicQuest_MoveHandler::Factorムーブハンドラデータベースの要素
BasicQuestScrollMessageWindow_Base標準スクロールメッセージウィンドウ
BasicQuestSelectWindow_Base標準選択肢ウィンドウ
BasicQuestNumInputWindow_Base標準数値入力ウィンドウ
BasicQuestStringInputWindow_Base標準文字列入力ウィンドウ
BasicQuestEventMoveCommanderムーブコマンド簡易入力メソッド群
BasicQuestAnimationWindowアニメーション簡易表示用ウィンドウ(シーン連携追加版)
BasicQuestScene_Base汎用マップシーンクラス
BasicQuestScene_Base::ReserveCallInfo呼び出し予約情報
BasicQuestScene_Base::ExRelayBitmapWindow背景/前景用ウィンドウ
BasicQuestScene_Base::ExRelayLayerInfo背景/前景用レイヤー情報
BasicQuestScene_Base::ScrollClipperスクロールクリップコントローラ
BasicQuestScene_Base::SmoothScrollInfoスムーズスクロール情報
BasicQuestScene_Base::MapInfoマップ情報
BasicQuestScene_Base::LocalResourceマップローカルリソース
BasicQuestBaseMoveLockObject基本移動ロックオブジェクト
BasicQuestDrawMoveLockObject描画移動ロックオブジェクト
BasicQuestPixelMoveLockObjectピクセル移動ロックオブジェクト
BasicQuestTriggerLockObjectイベントトリガーロックオブジェクト
BasicQuestWaitAnimeLockObject待機アニメーションロックオブジェクト
BasicQuestAllLockObject全種ロックオブジェクト
BasicQuestTempEventHost一時イベント管理オブジェクト
BasicQuestGhostEvent_Baseイベントと同じ見た目のウィンドウコントローラ用抽象基底クラス
BasicQuestGhostEventイベントと同じ見た目のウィンドウコントローラ
BasicQuestAlternateGhostEventイベントのフリをするウィンドウコントローラ
BasicQuestMessageWindow_Baseクエストメッセージウィンドウ用基底クラス
BasicQuestEventCommandLibraryイベントコマンド関連データ群
BQP_FreeAction_Base自由行動プラグインの抽象基底クラス
BQP_FreeAction自由行動プラグイン
BQP_FreeAction8Dir8方向対応自由行動プラグイン
BQP_DashControl_Baseダッシュ処理プラグインの抽象基底クラス
BQP_DashControlダッシュ処理プラグイン
BQP_Follower_Baseフォロワープラグインの抽象基底クラス
BQP_Followerフォロワープラグイン
BQP_MainEventExec_BaseMoveLockイベント実行中動作制限プラグイン
BQP_EventCheck_ToDirection調べられた方を向くプラグイン
BasicQuestSaveFileScene_Base汎用マップシーン用セーブファイル管理シーンクラス
BasicQuestDebugScene汎用マップシーン用デバッガシーンクラス

インターフェイス名概要
IBasicQuestPluginマッププラグイン

最終更新 2023/02/01