PlayBeginParam.h

[詳解]

/// @file
/// @brief プレイ開始に用いるパラメータを保持するクラス PlayBeginParam のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_PLAYBEGINPARAM_H
#define AMDAEMON_PLAYBEGINPARAM_H

#include "amdaemon/env.h"
#include "amdaemon/PlayParamHolder.h"

#include <utility>

namespace amdaemon
{
/// @addtogroup g_sequence
/// @{

    /// @brief プレイ開始に用いるパラメータを保持するクラス。
    /// @see Sequence#beginPlay
    class PlayBeginParam : public PlayParamHolder
    {
    public:
        /// コンストラクタ。
        PlayBeginParam() : PlayParamHolder() { }

        /// @brief コピーコンストラクタ。
        /// @param[in] src コピー元。
        PlayBeginParam(const PlayBeginParam& src) : PlayParamHolder(src) { }

        /// @brief ムーブコンストラクタ。
        /// @param[in] src ムーブ元。
        PlayBeginParam(PlayBeginParam&& src) : PlayParamHolder(std::move(src)) { }

        /// @brief コピー代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        PlayBeginParam& operator=(const PlayBeginParam& r)
        {
            PlayParamHolder::operator=(r);
            return *this;
        }

        /// @brief ムーブ代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        PlayBeginParam& operator=(PlayBeginParam&& r)
        {
            PlayParamHolder::operator=(std::move(r));
            return *this;
        }

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

        /// @brief ゲームコストパラメータを設定する。
        /// @param[in] gameCostIndex ゲームコスト設定インデックス。
        /// @param[in] count ゲームコスト減算回数。既定値は 1 。
        /// @see CreditUnit#payGameCost
        ///
        /// @exception Exception
        /// - 引数 gameCostIndex に CreditConfig::MaxGameCostCount 以上の値を指定した場合。
        /// - 引数 count に 0 以下もしくは 99 より大きい値を指定した場合。
        ///
        /// このパラメータを設定するとプレイ開始用のゲームコスト(クレジット)支払いが
        /// 行われるようになる。
        ///
        /// 引数 count については、
        /// CreditUnit クラスのメンバ関数 CreditUnit#payGameCost の説明を参照すること。
        /// 通常は省略して構わない。
        void setGameCost(std::size_t gameCostIndex, std::size_t count = 1)
        {
            PlayParamHolder::setGameCost(gameCostIndex, count);
        }

        /// @brief ALL.Net課金プレイ開始パラメータを設定する。
        /// @param[in] kindCode 種別コード。 0 以上 654 以下。
        /// @param[in] statusCode 状態コード。 0 以上 99 以下。
        /// @see AccountingUnit#beginPlay
        ///
        /// @exception Exception
        /// - 引数 kindCode に 654 より大きい値を指定した場合。
        /// - 引数 statusCode に 99 より大きい値を指定した場合。
        ///
        /// このパラメータを設定するとALL.Net課金プレイ開始処理が行われるようになる。
        ///
        /// Sequence クラスのメンバ関数 Sequence#getPlayAccountingTiming の戻り値によって
        /// 下記のような違いがある。
        ///
        /// - 戻り値が PlayAccountingTiming::Normal である場合
        ///     - 特記事項なし。
        /// - 戻り値が PlayAccountingTiming::AtBegin である場合
        ///     - このパラメータを設定した場合、メンバ関数 #setAccountingEnd によって
        ///       ALL.Net課金プレイ終了パラメータも設定しなければならない。
        /// - 戻り値が PlayAccountingTiming::AtEnd である場合
        ///     - このパラメータは無視される。
        void setAccountingBegin(std::uint32_t kindCode, std::uint32_t statusCode)
        {
            PlayParamHolder::setAccountingBegin(kindCode, statusCode);
        }

        /// @brief ALL.Net課金プレイ終了パラメータを設定する。
        /// @param[in] kindCode 種別コード。 0 以上 654 以下。
        /// @param[in] statusCode 状態コード。 0 以上 99 以下。
        /// @param[in] itemCount 商品数。 0 以上 255 以下。 0 ならば課金しない。
        /// @see AccountingUnit#endPlay
        ///
        /// @exception Exception
        /// - 引数 kindCode に 654 より大きい値を指定した場合。
        /// - 引数 statusCode に 99 より大きい値を指定した場合。
        /// - 引数 itemCount に 255 より大きい値を指定した場合。
        ///
        /// このパラメータを設定するとALL.Net課金プレイ終了処理が行われるようになる。
        ///
        /// Sequence クラスのメンバ関数 Sequence#getPlayAccountingTiming の戻り値によって
        /// 下記のような違いがある。
        ///
        /// - 戻り値が PlayAccountingTiming::Normal である場合
        ///     - このパラメータは無視される。
        /// - 戻り値が PlayAccountingTiming::AtBegin である場合
        ///     - このパラメータを設定した場合、メンバ関数 #setAccountingBegin によって
        ///       ALL.Net課金プレイ開始パラメータも設定しなければならない。
        /// - 戻り値が PlayAccountingTiming::AtEnd である場合
        ///     - このパラメータは無視される。
        void setAccountingEnd(
            std::uint32_t kindCode,
            std::uint32_t statusCode,
            std::uint32_t itemCount)
        {
            PlayParamHolder::setAccountingEnd(kindCode, statusCode, itemCount);
        }

        /// @brief Aimeプレイログ送信用のUID値パラメータを設定する。
        /// @param[in] aimeId Aime UID値。
        /// @see Aime#sendLog
        ///
        /// @exception Exception
        /// 引数 aimeId に無効なUID値を指定した場合。
        ///
        /// このパラメータを設定するとAimeプレイログが送信されるようになる。
        ///
        /// プレイ開始時に指定したUID値を用いて、
        /// コンティニュー時やプレイ終了時のAimeプレイログ送信も行われる。
        void setAimeId(AimeId aimeId)
        {
            PlayParamHolder::setAimeId(aimeId);
        }

    private:
        /// @brief 内部パラメータを取得する。
        /// @return 内部パラメータ。
        /// @note ライブラリ内部で用いられる。アプリ側から利用する必要はない。
        const InnerPlayParam& getInnerParam() const final override
        {
            return PlayParamHolder::getInnerParam();
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_PLAYBEGINPARAM_H