どうも、プログラマのゆっくりみかんです。
インターフェイスの使い方
実際にインターフェイスを自分で使って行こうとすると、どういう感じで使う事になるでしょうか。
まず、uGUIのボタンがあったとします。
こんな具合ですね。
//ゲームモードの定義
public enum GameMode {
InGame, //ゲーム中
Talking, //会話シーン
Menu, //メニュー
Pause, //ポーズ
}
こんな風にゲームモードの定義があって、
//ゲーム全体に係る管理マネージャ、シングルトンクラスとする
public class GameManager : SingletonObject {
[SerializeField]
private GameMode _currentGameMode; //現在のゲームモード
public GameMode CurrentGameMode => _currentGameMode;
}
こんなゲームのマネージャで現在のゲームモードを管理していたとします。
//魔法使用ボタン
public class SpellButton : MonoBehaviour {
[SerializeField]
private Button _spellButton; //uGUIのボタンの参照
[SerializeField]
private SpellData _spellData; //魔法データを持ったスクリプタブルオブジェクト
private Enemy _targetEnemy; //ターゲットとなる敵
public Enemy TargetEnemy { //公開用のターゲットとなる敵プロパティ
get => _targetEnemy;
set => _targetEnemy = value;
}
void Start() {
//onClickイベントへの登録
_spellButton.onClick.AddListener(() => {
//ゲームモードがInGameの時だけ実行
if(GameManager.Instance.CurrentGameMode == GameMode.InGame) {
_spellData.CastSpell(); //呪文を唱える
}
});
}
}
こんな感じですね。
//ゲームモードがInGameの時だけ実行
if(GameManager.Instance.CurrentMode == GameMode.InGame) {
//～何らかの攻撃処理～
}
このコードをわざわざ挿入するのでしょうか？
実装例
まず、
//クリック可能かどうかを示すインターフェイス
public interface IClickable {
public bool NowClickable { get; } //クリック可能かどうかを示すプロパティ
}
とりあえずはこれだけでも十分です。
//戦闘中だけクリック可能なIClickable
public class BattleClickable : IClickable {
public bool NowClickable => GameManager.Instance.CurrentGameMode == GameMode.InGame;
}
こんな感じですね。
//魔法使用ボタン
public class SpellButton : MonoBehaviour {
[SerializeField]
private Button _spellButton; //uGUIのボタンの参照
[SerializeField]
private SpellData _spellData; //魔法データを持ったスクリプタブルオブジェクト
[SerializeReference]
private IClickable _clickable; //クリック可能かどうか
private Enemy _targetEnemy; //ターゲットとなる敵
void Start() {
//onClickイベントへの登録
_spellButton.onClick.AddListener(() => {
//クリック可能な状態か判定
if(_clickable.NowClickable) {
_spellData.CastSpell(); //呪文を唱える
}
});
}
}
こういう感じになります。
こんな感じになります(SpellDataは省略しているのでインスペクタにはありません)。
この赤線に注目してみましょう。Nullになっています。
private IClickable _clickable;
こうなっており、ただのインターフェイスの入れ物でしかないからです。中身がからっぽなわけですね。
リストに、先ほどサンプルとして挙げたBattleClickableが入っていますね。
この様に、インターフェイスの中身としてBattleClickableが入ります。
if(_clickable.NowClickable) {
_spellData.CastSpell(); //呪文を唱える
}
と書いた箇所のNowClickableを呼び出したら、BattleClickableの
public bool NowClickable => GameManager.Instance.CurrentGameMode == GameMode.InGame;
このコードが呼び出され、bool値として値を返すわけです。
public bool NowClickable =>
GameManager.Instance.CurrentGameMode == GameMode.InGame ||
GameManager.Instance.CurrentGameMode == GameMode.Boss;
この様に、IClickableを継承したBattleClickableを書き換えるだけで良いのです。
一部のロジックを外に出せる
簡単にバリエーションを追加できる
というメリットがありますし、無理に継承で実現しようとすると難しいケースも発生してきます。
インターフェイスのメリット
さて、これらのメリットはどういう事でしょうか？
先ほどの例のSpellButtonを
//クリック出来たり出来なかったりするボタン
public class ClickableButton : MonoBehaviour {
[SerializeField]
private Button _button; //uGUIのボタンの参照
[SerializeReference]
private IClickable _clickable; //クリック可能かどうか
[SerializeReference]
private IOnClickProcess _onClick; //OnClickの処理
void Start() {
//onClickイベントへの登録
_button.onClick.AddListener(() => {
//クリック可能かどうかで分岐
if(_clickable.NowClickable) {
IOnClickProcess.Process(); //何らかの処理
}
});
}
}
さて、Clickableは先ほどの説明通りですね。
//OnClickの処理インターフェイス
public interface IOnClickProcess {
public void Process();
}
この実装として
//呪文処理
public class SpellProcess : IOnClickProcess {
[SerializeField]
private SpellData _spellData; //呪文データのスクリプタブルオブジェクト
[SerializeField]
private Enemy _targetEnemy; //ターゲットの敵
//クリック時の処理
public void Process() {
_spellData.CastSpell(_targetEnemy); //呪文を唱える
}
}
こんな呪文のクラスや
//攻撃処理
public class AttackProcess : IOnClickProcess {
[SerializeField]
private Weapon _weapon; //装備している武器
[SerializeField]
private Enemy _targetEnemy; //ターゲットの敵
public void Process() {
_weapon.Attack(_targetEnemy); //攻撃！
}
}
こんな実装があるとします。
そして、ClickableButtonというクラスは、特定のゲームでしか使えない独自の何かを含んでいるでしょうか？
これを通常の継承で実現出来るでしょうか？
ちなみに、こういったインターフェイスを使って独自処理を追い出すやり方を
使い回ししやすいコード資産を作る為に
使い回ししやすいコードである、という事は非常に重要な事です。
めんどくさい
インターフェイスの唯一の難点は、めんどくさい感じがする、という事です。
というかまあ、正直僕も
終わり
というわけで、インターフェイスを実際に使った例でした。
開発する皆様、お互い頑張りましょう！
