DataStoreWriter

DataStoreWriter　(ネイティブクラス)

このクラスはFGLパッケージを生成するクラスです。
FGLパッケージは拡張子 fgp または fcp のファイルで、
複数のファイルをひとつにまとめたパッケージファイルです。

このクラスは新しいFGLパッケージを生成することのみができます。
既存のパッケージを編集することはできません。
生成したパッケージは DataStoreReader クラスを使用して読み込むことが出来ます。

●継承

このクラスは継承をしていません。

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

このクラスはインターフェイスの実装宣言をしていません。

●クラスメソッド

名前	概要
`Save_GameData_TextFile`	ゲームデータフォルダにテキストファイルを保存します
`Save_GameData_BinaryFile`	ゲームデータフォルダにバイナリファイルを保存します
`Delete_GameData`	ゲームデータフォルダのファイルを削除します
`MoveFile`	プロジェクトフォルダ以下のファイルを移動します

●クラスメンバメソッド

名前	概要
`Open`	セーブフォルダにパッケージファイルを作成します
`Open_GameData`	ゲームデータフォルダにパッケージファイルを作成します
`Close`	開いているパッケージファイルを閉じます
`SetActiveDirectory`	パッケージ内のディレクトリを設定します
`GetActiveDirectory`	パッケージ内の現在のディレクトリを取得します
`CreateDirectory`	パッケージ内にディレクトリを作成します
`AddBinary`	パッケージ内にバイナリデータをファイルとして保存します
`AddString`	パッケージ内に文字列をファイルとして保存します

●クラス共有変数

このクラスはクラス共有変数を持っていません。

●インスタンス変数

このクラスはインスタンス変数を持っていません。

●C++レベル追加情報

クラスID： FGES_CLASSID_DATASTOREWRITER
クラス名： FGESDataStoreWriter

DataStoreWriter::Save_GameData_TextFile

public static Bool Save_GameData_TextFile( INativeString dir, INativeString filename, INativeString data)

ゲームデータフォルダにShiftJISテキストファイルを保存します。
このメソッドはリリース用FGSPlayerでは使用できません。

戻り値：保存に成功すると真を返します。

INativeString dir ：保存するフォルダ名。データフォルダ基準です。
INativeString filename ：保存するファイル名。拡張子まで指定します。
INativeString data ：保存するデータ。

先頭へ

DataStoreWriter::Save_GameData_BinaryFile

public static Bool Save_GameData_BinaryFile( INativeString dir, INativeString filename, Binary data)

ゲームデータフォルダにバイナリファイルを保存します。
このメソッドはリリース用FGSPlayerでは使用できません。

戻り値：保存に成功すると真を返します。

INativeString dir ：保存するフォルダ名。データフォルダ基準です。
INativeString filename ：保存するファイル名。拡張子まで指定します。
Binary data ：保存するデータ。

先頭へ

DataStoreWriter::Delete_GameData

public static Bool Delete_GameData( INativeString dir, INativeString filename)

   ゲームデータフォルダにあるファイルを削除します。
   削除を実行する前に確認メッセージが表示されます。

   このメソッドはエディターからファイルを削除するためのものです。
   そのため、FGSEditorでのみ定義されています。

   このメソッドはFGSEditorで追加されているメソッドです。
   標準のFGES With FGLやFGSPlayerには含まれていません。

戻り値：削除に成功すると真を返します。

INativeString dir ：削除するファイルのあるフォルダ名。データフォルダ基準です。
INativeString filename ：削除するファイル名。拡張子まで指定します。

先頭へ

DataStoreWriter::MoveFile

public static Bool MoveFile( INativeString target_name, INativeString new_name)

   プロジェクトフォルダ以下にあるファイルを移動します。
   このメソッドはプロジェクトフォルダ基準でパスを指定しますが、
   プロジェクトフォルダ自体にあるファイルは操作できません。
   必ずプロジェクトフォルダのサブフォルダを相対パスで指定しなければいけません。

   このメソッドはエディターからファイルを移動するためのものです。
   そのため、FGSEditorでのみ定義されています。

   このメソッドはFGSEditorで追加されているメソッドです。
   標準のFGES With FGLやFGSPlayerには含まれていません。

戻り値：移動に成功すると真を返します。

INativeString target_name ：移動するファイル名。プロジェクトフォルダ基準で、拡張子まで指定します。
INativeString new_name ：移動先のファイル名。プロジェクトフォルダ基準で、拡張子まで指定します。

先頭へ

DataStoreWriter::Open

public Bool Open( INativeString filename)

   セーブデータフォルダに空のFGLパッケージファイルを作成し、
   中にファイルを書き込めるようにします。

   処理が終わったら速やかにこのオブジェクト自体を消滅させるか、 Close メソッドで閉じてください。
   ファイルを閉じるまでは読み取りアクセスを行うことができません。

戻り値：ファイルを作成することに成功すると真を返します。

INativeString filename ：作成するファイル名。セーブフォルダ基準で、拡張子は自動的に付与されます。

先頭へ

DataStoreWriter::Open_GameData

public Bool Open_GameData( INativeString dir, INativeString filename)

   ゲームデータフォルダに空のFGLパッケージファイルを作成し、
   中にファイルを書き込めるようにします。
   ただしこの方法で暗号化アーカイブを生成することはできません。
   このメソッドはリリース用FGSPlayerでは使用できません。

   処理が終わったら速やかにこのオブジェクト自体を消滅させるか、 Close メソッドで閉じてください。

戻り値：ファイルを作成することに成功すると真を返します。

INativeString dir ：作成するファイルを配置するフォルダ名。データフォルダ基準です。
INativeString filename ：作成するファイル名。拡張子まで指定します。

先頭へ

DataStoreWriter::Close

public Bool Close()

現在開いているファイルを閉じて、ファイル関連のリソースを解放します。
このメソッドを呼び出すとFGLパッケージの内容が固定されます。

戻り値：処理に成功すると真を返します。

先頭へ

DataStoreWriter::SetActiveDirectory

public Bool SetActiveDirectory( INativeString dir_name)

   作成中のFGLパッケージファイル内のアクティブディレクトリを変更します。
   アクティブディレクトリはファイルシステムのカレントディレクトリに相当します。

   ディレクトリ名の先頭が / の場合はルートディレクトリから、
   それ以外の場合はアクティブディレクトリから、 / をパス区切り文字としてパスを扱います。

   この設定はファイルシステム上の位置ではなく、あくまでパッケージファイル内の位置です。

戻り値：設定に成功すると真を返します。

INativeString dir_name ：設定するディレクトリパス。

先頭へ

DataStoreWriter::GetActiveDirectory

public String GetActiveDirectory()const

   作成中のFGLパッケージファイル内のアクティブディレクトリを取得します。
   アクティブディレクトリはファイルシステムのカレントディレクトリに相当します。

   この設定はファイルシステム上の位置ではなく、あくまでパッケージファイル内の位置です。

戻り値：現在のアクティブディレクトリのパス。

先頭へ

DataStoreWriter::CreateDirectory

public Bool CreateDirectory( INativeString dir_name)

作成中のFGLパッケージファイル内のアクティブディレクトリにサブディレクトリを作成します。
アクティブディレクトリはファイルシステムのカレントディレクトリに相当します。

戻り値：作成に成功すると真を返します。

INativeString dir_name ：作成するディレクトリ名。

先頭へ

DataStoreWriter::AddBinary

public Bool AddBinary( INativeString data_name, Binary data)

   作成中のFGLパッケージファイル内にバイナリデータをファイルとして保存します。
   データはアクティブディレクトリに保存されます。
   ファイル名にパスは使用できません。

戻り値：書き込みに成功すると真を返します。

INativeString data_name ：保存するファイル名
Binary data ：ファイルに保存するオブジェクト。

先頭へ

DataStoreWriter::AddString

public Bool AddString( INativeString data_name, INativeString data)

   作成中のFGLパッケージファイル内に文字列をファイルとして保存します。
   データはアクティブディレクトリに保存されます。
   ファイル名にパスは使用できません。

戻り値：書き込みに成功すると真を返します。

INativeString data_name ：保存するファイル名
INativeString data ：ファイルに保存するオブジェクト。

先頭へ

[前へ] [目次へ] [次へ]

最終更新 2018/08/01