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

PDB_System_Base (script/fgs/database.fges)


このクラスはシステムデータを扱うプレイヤーデータベースです。
システムデータはゲーム全体で共有するデータを指します。

●継承/注入

   extends PlayerDataBase_Base

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

   extends IPlayerDataBase

●クラスメソッド

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

●クラスメンバメソッド

名前概要
internal操作メソッドoverride Resetデータベースをクリアします
internal操作メソッドoverride Loadファイルからデータベースをロードします
internal操作メソッドoverride Saveファイルにデータベースをセーブします
public操作メソッド AddWatchウォッチオブジェクトを登録します
public操作メソッド RemoveWatch登録済みのウォッチオブジェクトを解除します
public取得メソッドconst GetUseState現在の効果使用許可状態を取得します
public設定メソッド SetUseState効果使用許可状態を設定します
public操作メソッド UpdateUseState効果使用許可状態を更新します
public取得メソッドconst GetMoney現在の所持金を取得します
public設定メソッド SetMoney所持金を設定します
public操作メソッド AddMoney所持金を増やします
public操作メソッド SubMoney所持金を減らします
public取得メソッドconst GetMessageSpeed現在のメッセージスピードを取得します
public操作メソッド SetMessageSpeedメッセージスピードを設定します

●クラス共有変数

名前概要
internal IWatchウォッチ用インターフェイス
readable US_MAPマップ効果使用許可
readable US_BATTLEバトル効果使用許可
readable MAX_MONEY最大所持金

●インスタンス変数

名前概要
readable use_state効果使用許可状態
readable money所持金
readable message_speedメッセージスピード




PDB_System_Base::Reset

internal implements void Reset()

   このプレイヤーデータベースをクリアします。
   
先頭へ


PDB_System_Base::Load

internal implements Bool Load(editable PIniEx ini)

   テキストデータベースからプレイヤーデータベースの内容を読み込みます。
   
戻り値:読み込みに成功した場合は真を返します。

editable PIniEx ini :ロード元のテキストデータベース。

先頭へ


PDB_System_Base::Save

internal implements Bool Save(editable PIniEx ini)

   テキストデータベースにプレイヤーデータベースの内容を保存します。
   
戻り値:保存に成功した場合は真を返します。

editable PIniEx ini :[出力]セーブ先のテキストデータベース。

先頭へ


PDB_System_Base::AddWatch

public void AddWatch(editable PDB_System_Base::IWatch watch_obj)

   このプレイヤーデータベースにウォッチオブジェクトを登録します。
   
   ウォッチオブジェクトを登録すると、
   このプレイヤーデータベースに対して特定の処理が行われる時、
   登録しているウォッチオブジェクトに定義しているウォッチハンドラが呼び出されます。
   
   登録したウォッチオブジェクトのメモリ管理は変更されません。
   ウォッチオブジェクトがこのデータベースオブジェクトより先に消滅する場合、
   先にウォッチオブジェクトとしての登録を解除しなければいけません。
   
   ウォッチハンドラが呼び出されるタイミング、
   およびウォッチハンドラが行わなければならない応答は PDB_System_Base::IWatch を確認してください。
   
editable PDB_System_Base::IWatch watch_obj :登録するウォッチオブジェクト。

先頭へ


PDB_System_Base::RemoveWatch

public Bool RemoveWatch( PDB_System_Base::IWatch watch_obj)

   このプレイヤーデータベースに登録されているウォッチオブジェクトの登録を解除します。
   指定したオブジェクトが現在ウォッチオブジェクトとして登録されていない場合失敗します。
   
   ウォッチオブジェクトの登録を解除するとそれ以降、
   そのウォッチオブジェクトに対応するウォッチハンドラは呼び出されません。
   
戻り値:ウォッチオブジェクトの登録を解除した場合、真を返します。
   
PDB_System_Base::IWatch watch_obj :登録解除するウォッチオブジェクト。

先頭へ


PDB_System_Base::GetUseState

public Integer GetUseState()const

   現在の効果使用許可状態を取得します。
   使用許可状態はビットフラグとして保持されています。
   
戻り値:現在の効果使用許可状態を返します。
   
先頭へ


PDB_System_Base::SetUseState

public void SetUseState( Integer new_state)

   現在の効果使用許可状態を設定します。
   使用許可状態はビットフラグとして指定します。
   
   このメソッドによって効果使用許可状態が変化した場合、ウォッチハンドラ CN_SetUseState が呼び出されます。
   
Integer new_state :設定する効果使用許可状態。

先頭へ


PDB_System_Base::UpdateUseState

public void UpdateUseState( Integer update_filter, Bool new_state)

   指定した効果使用許可状態のみを設定します。
   使用許可状態はビットフラグとして指定します。
   
   このメソッドによって効果使用許可状態が変化した場合、ウォッチハンドラ CN_SetUseState が呼び出されます。
   
Integer update_filter :設定する効果使用許可状態。
      この引数で1のビットに対応する効果使用許可状態のみを更新します。
Bool new_state :対象の新しい効果使用許可状態。

先頭へ


PDB_System_Base::GetMoney

public Integer GetMoney()const

   現在の所持金を取得します。
   
戻り値:現在の所持金を返します。
   
先頭へ


PDB_System_Base::SetMoney

public Bool SetMoney(values Integer new_money)

   現在の所持金を設定します。
   new_money の値が設定可能な範囲外である場合は失敗します。

   このメソッドは所持金を変更する前にウォッチハンドラ PH_SetMoney を呼び出します。
   呼び出したウォッチハンドラの中に偽を返したハンドラがあった場合、このメソッドは失敗します。
   
   このメソッドは所持金の変更に成功した場合、ウォッチハンドラ CN_SetMoney が呼び出されます。

戻り値:所持金の変更に成功した場合、真を返します。
   
values Integer new_money :設定する所持金。

先頭へ


PDB_System_Base::AddMoney

public Integer AddMoney( Integer money)

   現在の所持金を増やします。
   所持金を増やした結果、所持金が設定可能な範囲外になる場合、最寄の設定可能な値に修正されます。

   このメソッドは所持金を変更する前にウォッチハンドラ PH_SetMoney を呼び出します。
   呼び出したウォッチハンドラの中に偽を返したハンドラがあった場合、このメソッドは失敗します。
   
   このメソッドは所持金の変更に成功した場合、ウォッチハンドラ CN_SetMoney が呼び出されます。

戻り値:所持金に実際に与えられた変化量(正=増加、負=減少)を返します。
   
Integer money :増加させる所持金。

先頭へ


PDB_System_Base::SubMoney

public Integer SubMoney( Integer money)

   現在の所持金を減らします。
   所持金を減らした結果、所持金が設定可能な範囲外になる場合、最寄の設定可能な値に修正されます。

   このメソッドは所持金を変更する前にウォッチハンドラ PH_SetMoney を呼び出します。
   呼び出したウォッチハンドラの中に偽を返したハンドラがあった場合、このメソッドは失敗します。
   
   このメソッドは所持金の変更に成功した場合、ウォッチハンドラ CN_SetMoney が呼び出されます。

戻り値:所持金に実際に与えられた変化量(正=増加、負=減少)を返します。
   
Integer money :減少させる所持金。

先頭へ


PDB_System_Base::GetMessageSpeed

public Integer GetMessageSpeed()const

   現在のメッセージスピードを取得します。
   メッセージスピードは0〜20の範囲で、大きいほど高速に表示されます。
   デフォルトでは10に設定されています。
   
戻り値:現在のメッセージスピードを返します。
   
先頭へ


PDB_System_Base::SetMessageSpeed

public Bool SetMessageSpeed(values Integer new_speed)

   メッセージスピードを設定します。
   メッセージスピードは0〜20の範囲で、大きいほど高速に表示されます。
   デフォルトでは10に設定されています。

   このメソッドはメッセージスピードを変更する前にウォッチハンドラ PH_SetMessageSpeed を呼び出します。
   呼び出したウォッチハンドラの中に偽を返したハンドラがあった場合、このメソッドは失敗します。
   
   このメソッドはメッセージスピードの変更に成功した場合、ウォッチハンドラ CN_SetMessageSpeed が呼び出されます。

戻り値:メッセージスピードの設定に成功した場合、真を返します。
   
values Integer new_speed :設定するメッセージスピード。

先頭へ


PDB_System_Base::IWatch

internal FGESInterface IWatch

   このプレイヤーデータベースのウォッチオブジェクト用インターフェイス。
   詳細は PDB_System_Base::IWatch を参照してください。

先頭へ


PDB_System_Base::US_MAP

readable readonly Integer US_MAP

   マップ効果の効果使用許可状態を示すビットフラグ。

先頭へ


PDB_System_Base::US_BATTLE

readable readonly Integer US_BATTLE

   バトル効果の効果使用許可状態を示すビットフラグ。

先頭へ


PDB_System_Base::MAX_MONEY

readable Integer MAX_MONEY

   最大所持金。
   変更する場合は継承したデータベースクラスで行ってください。
   デフォルトでは9999_9999に設定されています。

先頭へ


PDB_System_Base::use_state

readable Integer use_state

   現在許可されている効果使用許可状態。

先頭へ


PDB_System_Base::money

readable Integer money

   現在の所持金。

先頭へ


PDB_System_Base::message_speed

readable Integer message_speed

   現在のメッセージスピード。

先頭へ


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

最終更新 2021/03/03