PlayAccountingTiming.h

[詳解]

/// @file
/// @brief
///     プレイ状態変更と連動して行うALL.Net課金の処理タイミングを表す列挙
///     PlayAccountingTiming のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_PLAYACCOUNTINGTIMING_H
#define AMDAEMON_PLAYACCOUNTINGTIMING_H

#include "amdaemon/env.h"

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

    /// プレイ状態変更と連動して行うALL.Net課金の処理タイミングを表す列挙。
    enum class PlayAccountingTiming
    {
        /// @brief 通常のタイミング。
        ///
        /// - プレイ開始時にALL.Net課金プレイを開始する。
        /// - プレイ終了時にALL.Net課金プレイを終了する。
        /// - コンティニュー時には前回プレイ分のALL.Net課金プレイを終了し、
        ///   次回プレイ分のALL.Net課金プレイを新たに開始する。
        Normal = 0,

        /// @brief プレイ開始時にまとめて行う。
        ///
        /// - プレイ開始時にALL.Net課金プレイの開始と終了をまとめて行う。
        /// - プレイ終了時には何も行わない。
        /// - コンティニュー時には次回プレイ分のALL.Net課金プレイの開始と終了をまとめて行う。
        AtBegin,

        /// @brief プレイ終了時にまとめて行う。
        ///
        /// - プレイ開始時には何も行わない。
        /// - プレイ終了時にALL.Net課金プレイの開始と終了をまとめて行う。
        /// - コンティニュー時には前回プレイ分のALL.Net課金プレイの開始と終了をまとめて行う。
        AtEnd,
    };

    /// @brief @ref PlayAccountingTiming 列挙値の文字列表現値を取得する。
    /// @param[in] timing @ref PlayAccountingTiming 列挙値。
    /// @return @ref PlayAccountingTiming 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(PlayAccountingTiming timing);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_PLAYACCOUNTINGTIMING_H