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

UsableObject_Base　(script/fgs/database.fges)


このクラスは使用可能なオブジェクト用の抽象基底クラスです。
このクラスを継承することで使用効果を発生させるオブジェクトの定義を簡略化できます。

●継承/注入

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

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

   implements IUsableObject
          IsUsable
          ResetUser
          HasReservedUser
          ReserveUser
          ExecUser
          IsUsable
          GetTargetType
          PayCost
          CreateEffect

●クラスメソッド

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

●クラスメンバメソッド

名前概要
public比較・判定メソッドconstrequired IsUsable現在オブジェクトが使用可能か判定します
public操作メソッドrequired ResetUser現在予約中の使用者を全て予約解除します
public比較・判定メソッドconstrequired HasReservedUser現在予約中の使用者がいるかを返します
public操作メソッドrequired ReserveUserこのオブジェクトを使用する使用者を予約します
public操作メソッドrequired CancelUser現在予約中の使用者を予約解除します
public操作メソッドrequired ExecUser現在予約中の使用者がオブジェクトの効果を発動します
public取得メソッドconstrequired GetTargetTypeこのオブジェクトの選択対象タイプを取得します
public操作メソッドrequired PayCostこのオブジェクトの効果コストを処理します
public操作メソッドrequired CreateEffectこのオブジェクトの効果オブジェクトを生成します

●クラス共有変数

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

●インスタンス変数

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



UsableObject_Base::IUsableObject@@IsUsable

Bool IUsableObject@@IsUsable( IUser user)const

   指定した使用者が現在このオブジェクトを使用できるか判定します。

戻り値：使用できる場合は真を返します。

IUser user ：このオブジェクトを使用しようとしている使用者。

先頭へ

UsableObject_Base::IUsableObject@@ResetUser

Bool IUsableObject@@ResetUser()

   このオブジェクトの使用を予約している使用者を全て解除します。

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

先頭へ

UsableObject_Base::IUsableObject@@HasReservedUser

Bool IUsableObject@@HasReservedUser( IUser user)const

   指定した使用者がこのオブジェクトに予約されているかを取得します。

戻り値：指定した使用者がこのオブジェクトに予約されている場合、真を返します。

IUser user ：予約状態を確認する使用者。

先頭へ

UsableObject_Base::IUsableObject@@ReserveUser

Bool IUsableObject@@ReserveUser(editable IUser user)

   このオブジェクトを使用する予定の使用者を予約します。

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

editable IUser user ：[入出力]使用を予約する使用者。

先頭へ

UsableObject_Base::IUsableObject@@CancelUser

Bool IUsableObject@@CancelUser(editable IUser user)

   このオブジェクトに予約されている指定した使用者の予約を解除します。

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

editable IUser user ：[入出力]予約を解除する使用者。

先頭へ

UsableObject_Base::IUsableObject@@ExecUser

Bool IUsableObject@@ExecUser(editable IUser user)

   このオブジェクトに予約されている指定した使用者がこのオブジェクトを使用します。

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

editable IUser user ：[入出力]このオブジェクトを使用する使用者。

先頭へ

UsableObject_Base::IUsableObject@@GetTargetType

Integer IUsableObject@@GetTargetType( IUser user)const

   このオブジェクトの目標選択タイプを取得します。
   この値は、 SelectTarget_Base の定義済み識別子または独自に定義した値です。
   
   このメソッドの引数に使用者が含まれるのは
   使用者によって範囲を変化させるような実装(対象の全体化アビリティ等)を可能にするためです。

戻り値：このオブジェクトの目標選択タイプを返します。

IUser user ：目標選択タイプを取得する時の使用者。

先頭へ

UsableObject_Base::IUsableObject@@PayCost

Bool IUsableObject@@PayCost(editable IUser user)

   このオブジェクトを使用する時のコストを処理します。

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

editable IUser user ：[入出力]このオブジェクトを使用する使用者。

先頭へ

UsableObject_Base::IUsableObject@@CreateEffect

IUseEffect@ IUsableObject@@CreateEffect(editable TargetSession session)

   このオブジェクトを使用した時の効果処理オブジェクトを生成します。

戻り値：生成した効果処理オブジェクトへの参照。
      このオブジェクトの寿命は通常、目標選択セッション管理とします。

editable TargetSession session ：[入出力]効果処理を行う目標選択セッション。

先頭へ

UsableObject_Base::IsUsable

public abstract Bool IsUsable( IUser user)const

   指定した使用者が現在このオブジェクトを使用できるか判定します。

戻り値：使用できる場合は真を返します。

IUser user ：このオブジェクトを使用しようとしている使用者。

先頭へ

UsableObject_Base::ResetUser

public abstract Bool ResetUser()

   このオブジェクトの使用を予約している使用者を全て解除します。

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

先頭へ

UsableObject_Base::HasReservedUser

public abstract Bool HasReservedUser( IUser user)const

   指定した使用者がこのオブジェクトに予約されているかを取得します。

戻り値：指定した使用者がこのオブジェクトに予約されている場合、真を返します。

IUser user ：予約状態を確認する使用者。

先頭へ

UsableObject_Base::ReserveUser

public abstract Bool ReserveUser(editable IUser user)

   このオブジェクトを使用する予定の使用者を予約します。

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

editable IUser user ：[入出力]使用を予約する使用者。

先頭へ

UsableObject_Base::CancelUser

public abstract Bool CancelUser(editable IUser user)

   このオブジェクトに予約されている指定した使用者の予約を解除します。

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

editable IUser user ：[入出力]予約を解除する使用者。

先頭へ

UsableObject_Base::ExecUser

public abstract Bool ExecUser(editable IUser user)

   このオブジェクトに予約されている指定した使用者がこのオブジェクトを使用します。

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

editable IUser user ：[入出力]このオブジェクトを使用する使用者。

先頭へ

UsableObject_Base::GetTargetType

public abstract Integer GetTargetType( IUser user)const

   このオブジェクトの目標選択タイプを取得します。
   この値は、 SelectTarget_Base の定義済み識別子または独自に定義した値です。
   
   このメソッドの引数に使用者が含まれるのは
   使用者によって範囲を変化させるような実装(対象の全体化アビリティ等)を可能にするためです。

戻り値：このオブジェクトの目標選択タイプを返します。

IUser user ：目標選択タイプを取得する時の使用者。

先頭へ

UsableObject_Base::PayCost

public abstract Bool PayCost(editable IUser user)

   このオブジェクトを使用する時のコストを処理します。

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

editable IUser user ：[入出力]このオブジェクトを使用する使用者。

先頭へ

UsableObject_Base::CreateEffect

public abstract IUseEffect?@ CreateEffect(editable TargetSession session)

   このオブジェクトを使用した時の効果処理オブジェクトを生成します。

戻り値：生成した効果処理オブジェクトへの参照。
      このオブジェクトの寿命は通常、目標選択セッション管理とします。

editable TargetSession session ：[入出力]効果処理を行う目標選択セッション。

先頭へ

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

最終更新 2018/05/31