Player.h

[詳解]

/// @file
/// @brief プレイヤーに紐付く情報をまとめて提供するMonostateクラス Player のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_PLAYER_H
#define AMDAEMON_PLAYER_H

#include "amdaemon/env.h"
#include "amdaemon/PlayBeginParam.h"
#include "amdaemon/PlayContinueParam.h"
#include "amdaemon/PlayEndParam.h"
#include "amdaemon/PlayErrorId.h"
#include "amdaemon/AimeId.h"
#include "amdaemon/InputUnit.h"
#include "amdaemon/OutputUnit.h"
#include "amdaemon/CreditUnit.h"
#include "amdaemon/allnet/AccountingUnit.h"

#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_player
/// @{

    /// @brief プレイヤーに紐付く情報をまとめて提供するMonostateクラス。
    ///
    /// プレイヤーに紐付く各種インスタンスをひとまとめにしたクラス。
    /// 実際のインスタンスは Input クラスや Credit クラス等が保持している。
    ///
    /// このクラス自体はプレイヤーインデックスしか保持していない。
    /// そのためほとんどコスト無しでコピー可能である。
    class Player
    {
    public:
        /// @brief コンストラクタ。
        /// @param[in] index プレイヤーインデックス。
        ///
        /// @exception Exception
        /// 引数 index に有効プレイヤー数以上の値を渡した場合。
        /// 有効プレイヤー数は Core クラスのメンバ関数 Core#getPlayerCount で取得できる。
        explicit Player(std::size_t index);

        // 下記は暗黙の定義を用いる。
        //Player(const Player&) = default;
        //‾Player() = default;
        //Player& operator=(const Player&) = default;

        /// @brief プレイヤーインデックスを取得する。
        /// @return プレイヤーインデックス。
        std::size_t getIndex() const
        {
            return _index;
        }

        /// @brief プレイ開始処理を行う。
        /// @param[in] param プレイ開始処理パラメータ。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#beginPlay(std::size_t, const PlayBeginParam&)
        ///
        /// @exception Exception
        /// - プレイヤーが既にプレイ中である場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool beginPlay(const PlayBeginParam& param = PlayBeginParam());

        /// @brief プレイ開始処理を行う。
        /// @param[in] param プレイ開始処理パラメータ。
        /// @param[out] errorId 処理失敗時のエラーID設定先。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#beginPlay(std::size_t, const PlayBeginParam&, PlayErrorId&)
        ///
        /// @exception Exception
        /// - プレイヤーが既にプレイ中である場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool beginPlay(const PlayBeginParam& param, PlayErrorId& errorId);

        /// @brief コンティニュー処理を行う。
        /// @param[in] param コンティニュー処理パラメータ。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#continuePlay(std::size_t, const PlayContinueParam&)
        ///
        /// @exception Exception
        /// - プレイヤーがプレイ中ではない場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool continuePlay(const PlayContinueParam& param = PlayContinueParam());

        /// @brief コンティニュー処理を行う。
        /// @param[in] param コンティニュー処理パラメータ。
        /// @param[out] errorId 処理失敗時のエラーID設定先。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#continuePlay(std::size_t, const PlayContinueParam&, PlayErrorId&)
        ///
        /// @exception Exception
        /// - プレイヤーがプレイ中ではない場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool continuePlay(const PlayContinueParam& param, PlayErrorId& errorId);

        /// @brief プレイ終了処理を行う。
        /// @param[in] param プレイ終了処理パラメータ。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#endPlay(std::size_t, const PlayEndParam&)
        ///
        /// @exception Exception
        /// - プレイヤーが既にプレイ中ではない場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool endPlay(const PlayEndParam& param = PlayEndParam());

        /// @brief プレイ終了処理を行う。
        /// @param[in] param プレイ終了処理パラメータ。
        /// @param[out] errorId 処理失敗時のエラーID設定先。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        /// @see Sequence#endPlay(std::size_t, const PlayEndParam&, PlayErrorId&)
        ///
        /// @exception Exception
        /// - プレイヤーが既にプレイ中ではない場合。
        /// - ゲームテストモード中である場合。
        /// - 引数 param に不正な値を指定した場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool endPlay(const PlayEndParam& param, PlayErrorId& errorId);

        /// @brief プレイ中であるか否かを取得する。
        /// @retval true  プレイ中である場合。
        /// @retval false プレイ中ではない場合。
        /// @see Sequence#isPlaying
        bool isPlaying() const;

        /// @brief ALL.Net課金プレイ中であるか否かを取得する。
        /// @retval true  ALL.Net課金プレイ中である場合。
        /// @retval false ALL.Net課金プレイ中ではない場合。
        /// @see Sequence#isAccountingPlaying
        ///
        /// Sequence クラスのメンバ関数 Sequence#getPlayAccountingTiming の戻り値が
        /// PlayAccountingTiming::Normal であり、なおかつメンバ関数 #beginPlay や
        /// #continuePlay でALL.Net課金プレイを開始済みである場合に true を返すようになる。
        ///
        /// 上記メンバ関数の戻り値が PlayAccountingTiming::Normal 以外である場合や、
        /// AccountingUnit クラスのメンバ関数 AccountingUnit#beginPlay を直接呼び出して
        /// 課金プレイを開始した場合、この関数が true を返すことはない。
        bool isAccountingPlaying() const;

        /// @brief プレイ中のプレイヤーに紐付いているAimeのUID値を取得する。
        /// @return AimeのUID値。紐付いていないかプレイ中でない場合は不正値。
        /// @see Sequence#getPlayingAimeId
        AimeId getPlayingAimeId() const;

        /// @brief ID付けされた入力情報インスタンスを取得する。
        /// @return ID付けされた入力情報インスタンス。
        /// @see Input#getPlayer(std::size_t) const
        const InputUnit& getInputUnit() const;

        /// @brief ID付けされた出力情報インスタンスを取得する。
        /// @return ID付けされた出力情報インスタンス。
        /// @see Output#getPlayer(std::size_t)
        OutputUnit& getOutputUnit();

        /// @copydoc getOutputUnit
        const OutputUnit& getOutputUnit() const;

        /// @brief クレジット情報インスタンスを取得する。
        /// @return クレジット情報インスタンス。
        /// @see Credit#getPlayer(std::size_t)
        CreditUnit& getCreditUnit();

        /// @copydoc getCreditUnit
        const CreditUnit& getCreditUnit() const;

        /// @brief ALL.Net課金処理インスタンスを取得する。
        /// @return ALL.Net課金処理インスタンス。
        /// @see allnet::Accounting#getPlayer(std::size_t)
        ::amdaemon::allnet::AccountingUnit& getAllnetAccountingUnit();

        /// @copydoc getAllnetAccountingUnit
        const ::amdaemon::allnet::AccountingUnit& getAllnetAccountingUnit() const;

    private:
        std::size_t _index; ///< プレイヤーインデックス。
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_PLAYER_H