PlayParamHolder.h

[詳解]

/// @file
/// @brief プレイ状態変更に用いるパラメータを保持する基底クラス PlayParamHolder のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_PLAYPARAMHOLDER_H
#define AMDAEMON_PLAYPARAMHOLDER_H

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

#include <memory>
#include <cstdint>
#include <cstddef>

namespace amdaemon
{
    // 前方宣言
    class InnerPlayParam;

/// @addtogroup g_sequence
/// @{

    /// @brief プレイ状態変更に用いるパラメータを保持する基底クラス。
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// このクラスから派生した下記のクラスを用いること。
    ///
    /// - PlayBeginParam
    /// - PlayContinueParam
    /// - PlayEndParam
    class PlayParamHolder
    {
    protected:
        /// コンストラクタ。
        PlayParamHolder();

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

        /// @brief ムーブコンストラクタ。
        /// @param[in] src ムーブ元。
        PlayParamHolder(PlayParamHolder&& src);

        /// デストラクタ。
        virtual ‾PlayParamHolder();

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

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

    public:
        /// すべてのパラメータを無効状態にする。
        void reset();

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

    protected:
        /// @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);

        /// @brief ALL.Net課金プレイ開始パラメータを設定する。
        /// @param[in] kindCode 種別コード。 0 以上 654 以下。
        /// @param[in] statusCode 状態コード。 0 以上 99 以下。
        /// @see AccountingUnit#beginPlay
        ///
        /// @exception Exception
        /// - 引数 kindCode に 654 より大きい値を指定した場合。
        /// - 引数 statusCode に 99 より大きい値を指定した場合。
        ///
        /// このパラメータを設定するとALL.Net課金プレイ開始処理が行われるようになる。
        void setAccountingBegin(std::uint32_t kindCode, std::uint32_t 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課金プレイ終了処理が行われるようになる。
        /// - 既にALL.Net課金プレイ中である場合はそれに対して終了処理が行われる。
        /// - ALL.Net課金プレイ中ではない場合、メンバ関数 #setAccountingBegin によって
        ///   ALL.Net課金プレイ開始パラメータも同時に指定しなければならない。
        void setAccountingEnd(
            std::uint32_t kindCode,
            std::uint32_t statusCode,
            std::uint32_t itemCount);

        /// @brief Aimeプレイログ送信用のUID値パラメータを設定する。
        /// @param[in] aimeId Aime UID値。
        /// @see Aime#sendLog
        ///
        /// @exception Exception
        /// 引数 aimeId に無効なUID値を指定した場合。
        ///
        /// このパラメータを設定するとAimeプレイログが送信されるようになる。
        void setAimeId(AimeId aimeId);

    private:
        struct Data;

        /// 内部データ。
        std::unique_ptr<Data> _data;
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_PLAYPARAMHOLDER_H