GameVariables

GameVariables　(ネイティブクラス)

このクラスはゲーム変数を扱うクラスです。

ゲーム変数はゲーム進行上のデータを保存するための領域で、
整数と文字列を別々に保存でき、グローバル、グループ、マップの区分があります。
このうち、グループとマップは任意の名前で複数の領域に区切ることができ、アクティブに設定している領域のみにアクセスできます。
また、先頭に # を付けた名前の変数は一時変数として扱われ、所属する区分のアクティブを切り替えると消滅します。

また、 @@gamevar に結び付けられたオブジェクトは
GameSystem::SystemSave の処理中に自動的にセーブ中のファイルに保存されます。
このクラスのデータはひとつのFGLパッケージにひとつだけ保存することができます。

●継承

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

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

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

●クラスメソッド

このクラスはクラスメソッドを持っていません。

●クラスメンバメソッド

名前	概要
`SetGlobalInt`	グローバル区分の整数を設定します
`GetGlobalInt`	グローバル区分の整数を取得します
`SetGlobalStr`	グローバル区分の文字列を設定します
`GetGlobalStr`	グローバル区分の文字列を取得します
`SetGroupInt`	グループ区分の整数を設定します
`GetGroupInt`	グループ区分の整数を取得します
`SetGroupStr`	グループ区分の文字列を設定します
`GetGroupStr`	グループ区分の文字列を取得します
`SetMapInt`	マップ区分の整数を設定します
`GetMapInt`	マップ区分の整数を取得します
`SetMapStr`	マップ区分の文字列を設定します
`GetMapStr`	マップ区分の文字列を取得します
`SetGroupName`	グループ区分のアクティブ領域を設定します
`SetMapName`	マップ区分のアクティブ領域を設定します
`AllClear`	全区分の全領域のゲーム変数を全て削除します
`GroupClear`	グループ区分のアクティブ領域のゲーム変数を削除します
`MapClear`	マップ区分のアクティブ領域のゲーム変数を削除します
`Load`	FGLパッケージファイルからゲーム変数をロードします
`Save`	FGLパッケージファイルにゲーム変数をセーブします
`Exists_GlobalInt`	指定したゲームグローバル変数が存在するか調べます
`Exists_GlobalStr`	指定したゲームグローバル変数が存在するか調べます
`Exists_GroupInt`	指定したゲームグループ変数が存在するか調べます
`Exists_GroupStr`	指定したゲームグループ変数が存在するか調べます
`Exists_MapInt`	指定したゲームマップ変数が存在するか調べます
`Exists_MapStr`	指定したゲームマップ変数が存在するか調べます
`GetKeyList_GlobalInt`	現存するグローバル区分の整数変数のリストを取得します
`GetKeyList_GlobalStr`	現存するグローバル区分の文字列変数のリストを取得します
`GetKeyList_GroupInt`	現存するグループ区分の整数変数のリストを取得します
`GetKeyList_GroupStr`	現存するグループ区分の文字列変数のリストを取得します
`GetKeyList_MapInt`	現存するマップ区分の整数変数のリストを取得します
`GetKeyList_MapStr`	現存するマップ区分の文字列変数のリストを取得します

●クラス共有変数

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

●インスタンス変数

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

●C++レベル追加情報

クラスID： FGES_CLASSID_GAMEVARIABLES
クラス名： FGES_GameVariables

GameVariables::SetGlobalInt

public void SetGlobalInt( INativeString name, INativeInteger value)

   グローバル区分の指定したゲーム整数変数に値を設定します。

   ゲーム整数変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームグローバル整数変数名
INativeInteger value ：設定する値

先頭へ

GameVariables::GetGlobalInt

public Integer GetGlobalInt( INativeString name, INativeInteger? def=NULL)const

   グローバル区分の指定したゲーム整数変数を取得します。
   対象のゲームグローバル整数変数が存在しない場合、 def を返します。

   ゲーム整数変数名には/=の文字を使用することはできません。

戻り値：指定したゲームグローバル整数変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームグローバル整数変数名
INativeInteger? def=NULL ：対象のゲームグローバル整数変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は 0xAAAAAAAAAAAAAAAA が指定されたものとして扱います。

先頭へ

GameVariables::SetGlobalStr

public void SetGlobalStr( INativeString name, INativeString value)

グローバル区分の指定したゲーム文字列変数に値を設定します。

ゲーム文字列変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームグローバル文字列変数名
INativeString value ：設定する文字列

先頭へ

GameVariables::GetGlobalStr

public String GetGlobalStr( INativeString name, INativeString? def=NULL)const

   グローバル区分の指定したゲーム文字列変数を取得します。
   対象のゲームグローバル文字列変数が存在しない場合、 def を返します。

   ゲーム文字列変数名には/=の文字を使用することはできません。

戻り値：指定したゲームグローバル文字列変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームグローバル文字列変数名
INativeString? def=NULL ：対象のゲームグローバル文字列変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は "存在しないゲーム変数をロードしました" が指定されたものとして扱います。

先頭へ

GameVariables::SetGroupInt

public void SetGroupInt( INativeString name, INativeInteger value)

   グループ区分の指定したゲーム整数変数に値を設定します。
   先頭に # を付けた名前の変数は一時変数として扱われ、グループ区分のアクティブを切り替えると消滅します。

   ゲーム整数変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームグループ整数変数名
INativeInteger value ：設定する値

先頭へ

GameVariables::GetGroupInt

public Integer GetGroupInt( INativeString name, INativeInteger? def=NULL)const

   グループ区分の指定したゲーム整数変数を取得します。
   先頭に # を付けた名前の変数は一時変数として扱われ、グループ区分のアクティブを切り替えると消滅します。
   対象のゲームグループ整数変数が存在しない場合、 def を返します。

   ゲーム整数変数名には/=の文字を使用することはできません。

戻り値：指定したゲームグループ整数変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームグループ整数変数名
INativeInteger? def=NULL ：対象のゲームグループ整数変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は 0xAAAAAAAAAAAAAAAA が指定されたものとして扱います。

先頭へ

GameVariables::SetGroupStr

public void SetGroupStr( INativeString name, INativeString value)

   グループ区分の指定したゲーム文字列変数に値を設定します。
   先頭に # を付けた名前の変数は一時変数として扱われ、グループ区分のアクティブを切り替えると消滅します。

   ゲーム文字列変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームグループ文字列変数名
INativeString value ：設定する文字列

先頭へ

GameVariables::GetGroupStr

public String GetGroupStr( INativeString name, INativeString? def=NULL)const

   グループ区分の指定したゲーム文字列変数を取得します。
   先頭に # を付けた名前の変数は一時変数として扱われ、グループ区分のアクティブを切り替えると消滅します。
   対象のゲームグループ文字列変数が存在しない場合、 def を返します。

   ゲーム文字列変数名には/=の文字を使用することはできません。

戻り値：指定したゲームグループ文字列変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームグループ文字列変数名
INativeString? def=NULL ：対象のゲームグループ文字列変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は "存在しないゲーム変数をロードしました" が指定されたものとして扱います。

先頭へ

GameVariables::SetMapInt

public void SetMapInt( INativeString name, INativeInteger value)

   マップ区分の指定したゲーム整数変数に値を設定します。
   先頭に # を付けた名前の変数は一時変数として扱われ、マップ区分のアクティブを切り替えると消滅します。

   ゲーム整数変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームマップ整数変数名
INativeInteger value ：設定する値

先頭へ

GameVariables::GetMapInt

public Integer GetMapInt( INativeString name, INativeInteger? def=NULL)const

   マップ区分の指定したゲーム整数変数を取得します。
   先頭に # を付けた名前の変数は一時変数として扱われ、マップ区分のアクティブを切り替えると消滅します。
   対象のゲームマップ整数変数が存在しない場合、 def を返します。

   ゲーム整数変数名には/=の文字を使用することはできません。

戻り値：指定したゲームマップ整数変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームマップ整数変数名
INativeInteger? def=NULL ：対象のゲームマップ整数変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は 0xAAAAAAAAAAAAAAAA が指定されたものとして扱います。

先頭へ

GameVariables::SetMapStr

public void SetMapStr( INativeString name, INativeString value)

   マップ区分の指定したゲーム文字列変数に値を設定します。
   先頭に # を付けた名前の変数は一時変数として扱われ、マップ区分のアクティブを切り替えると消滅します。

   ゲーム文字列変数名には/=の文字を使用することはできません。

INativeString name ：設定するゲームマップ文字列変数名
INativeString value ：設定する文字列

先頭へ

GameVariables::GetMapStr

public String GetMapStr( INativeString name, INativeString? def=NULL)const

   マップ区分の指定したゲーム文字列変数を取得します。
   先頭に # を付けた名前の変数は一時変数として扱われ、マップ区分のアクティブを切り替えると消滅します。
   対象のゲームマップ文字列変数が存在しない場合、 def を返します。

   ゲーム文字列変数名には/=の文字を使用することはできません。

戻り値：指定したゲームマップ文字列変数の値。存在しない場合、 def を返します。

INativeString name ：取得するゲームマップ文字列変数名
INativeString? def=NULL ：対象のゲームマップ文字列変数が存在しない時に返すデフォルト値。
      空参照を指定した場合は "存在しないゲーム変数をロードしました" が指定されたものとして扱います。

先頭へ

GameVariables::SetGroupName

public void SetGroupName( INativeString group_name)

   グループ区分のアクティブ領域を設定します。
   現在アクティブな名前と違う名前のグループに設定した場合、
   グループ区分の一時変数は全て消滅します。

INativeString group_name ：設定するアクティブグループ名

先頭へ

GameVariables::SetMapName

public void SetMapName( INativeString map_name)

   マップ区分のアクティブ領域を設定します。
   現在アクティブな名前と違う名前のマップに設定した場合、
   マップ区分の一時変数は全て消滅します。

INativeString map_name ：設定するアクティブマップ名

先頭へ

GameVariables::AllClear

public void AllClear()

全区分の全領域のゲーム変数を削除します。

先頭へ

GameVariables::GroupClear

public void GroupClear()

グループ区分のアクティブ領域のゲーム変数を削除します。

先頭へ

GameVariables::MapClear

public void MapClear()

マップ区分のアクティブ領域のゲーム変数を削除します。

先頭へ

GameVariables::Load

public Bool Load( DataStoreReader reader)

   指定したFGLパッケージファイルに格納されているゲーム変数データをロードします。
   reader は対象のFGLパッケージファイルを開いた状態で渡す必要があります。
   このオブジェクトの内容はファイルに格納されていた内容で上書きされます。

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

DataStoreReader reader ：ロードするFGLパッケージ

先頭へ

GameVariables::Save

public Bool Save(editable DataStoreWriter writer)const

   指定したFGLパッケージファイルにこのオブジェクトのゲーム変数データをセーブします。
   writer は対象のFGLパッケージファイルを開いた状態で渡す必要があります。
   セーブされるのは全てのゲーム変数、ゲーム一時変数、アクティブ領域名です。

   ゲーム変数データはひとつののFGLパッケージにひとつしか保存できません。
   そのため、このメソッドはひとつのFGLパッケージに対して一度しか呼び出せません。

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

editable DataStoreWriter writer ：セーブするFGLパッケージ

先頭へ

GameVariables::Exists_GlobalInt

public Bool Exists_GlobalInt( INativeString name)const

グローバル区分の指定したゲーム整数変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームグローバル整数変数が存在する場合真を返します。

INativeString name ：判定するゲームグローバル整数変数名

先頭へ

GameVariables::Exists_GlobalStr

public Bool Exists_GlobalStr( INativeString name)const

グローバル区分の指定したゲーム文字列変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームグローバル文字列変数が存在する場合真を返します。

INativeString name ：判定するゲームグローバル文字列変数名

先頭へ

GameVariables::Exists_GroupInt

public Bool Exists_GroupInt( INativeString name)const

グループ区分の指定したゲーム整数変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームグループ整数変数が存在する場合真を返します。

INativeString name ：判定するゲームグループ整数変数名

先頭へ

GameVariables::Exists_GroupStr

public Bool Exists_GroupStr( INativeString name)const

グループ区分の指定したゲーム文字列変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームグループ文字列変数が存在する場合真を返します。

INativeString name ：判定するゲームグループ文字列変数名

先頭へ

GameVariables::Exists_MapInt

public Bool Exists_MapInt( INativeString name)const

マップ区分の指定したゲーム整数変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームマップ整数変数が存在する場合真を返します。

INativeString name ：判定するゲームマップ整数変数名

先頭へ

GameVariables::Exists_MapStr

public Bool Exists_MapStr( INativeString name)const

マップ区分の指定したゲーム文字列変数が存在するか調べます。
ゲーム変数は一度でも設定すると作成されます。

戻り値：指定したゲームマップ文字列変数が存在する場合真を返します。

INativeString name ：判定するゲームマップ文字列変数名

先頭へ

GameVariables::GetKeyList_GlobalInt

public void GetKeyList_GlobalInt(editable PStringArray keylist)const

グローバル区分の整数変数名リストを取得します。

editable PStringArray keylist ：[出力]ゲームグローバル整数変数名リストを出力するオブジェクト

先頭へ

GameVariables::GetKeyList_GlobalStr

public void GetKeyList_GlobalStr(editable PStringArray keylist)const

グローバル区分の文字列変数名リストを取得します。

editable PStringArray keylist ：[出力]ゲームグローバル文字列変数名リストを出力するオブジェクト

先頭へ

GameVariables::GetKeyList_GroupInt

public void GetKeyList_GroupInt(editable PStringArray? keylist,editable PStringArray? tempkeylist)const

   グループ区分の整数変数名リストを取得します。
   アクティブではないグループの変数名は列挙されません。

   取得される一時変数名の先頭に # は付いていません。
   取得した変数名リストを使用してアクセスする場合は注意してください。

editable PStringArray? keylist ：[出力]ゲームグループ整数変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。
editable PStringArray? tempkeylist ：[出力]ゲームグループ整数一時変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。

先頭へ

GameVariables::GetKeyList_GroupStr

public void GetKeyList_GroupStr(editable PStringArray? keylist,editable PStringArray? tempkeylist)const

   グループ区分の文字列変数名リストを取得します。
   アクティブではないグループの変数名は列挙されません。

   取得される一時変数名の先頭に # は付いていません。
   取得した変数名リストを使用してアクセスする場合は注意してください。

editable PStringArray? keylist ：[出力]ゲームグループ文字列変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。
editable PStringArray? tempkeylist ：[出力]ゲームグループ文字列一時変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。

先頭へ

GameVariables::GetKeyList_MapInt

public void GetKeyList_MapInt(editable PStringArray? keylist,editable PStringArray? tempkeylist)const

   マップ区分の整数変数名リストを取得します。
   アクティブではないマップの変数名は列挙されません。

   取得される一時変数名の先頭に # は付いていません。
   取得した変数名リストを使用してアクセスする場合は注意してください。

editable PStringArray? keylist ：[出力]ゲームマップ整数変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。
editable PStringArray? tempkeylist ：[出力]ゲームマップ整数一時変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。

先頭へ

GameVariables::GetKeyList_MapStr

public void GetKeyList_MapStr(editable PStringArray? keylist,editable PStringArray? tempkeylist)const

   マップ区分の文字列変数名リストを取得します。
   アクティブではないマップの変数名は列挙されません。

   取得される一時変数名の先頭に # は付いていません。
   取得した変数名リストを使用してアクセスする場合は注意してください。

editable PStringArray? keylist ：[出力]ゲームマップ文字列変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。
editable PStringArray? tempkeylist ：[出力]ゲームマップ文字列一時変数名リストを出力するオブジェクト
                     空参照を指定した場合は無視します。

先頭へ

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

最終更新 2018/01/15

GameVariables (ネイティブクラス)