CreditConfig.h

[詳解]

/// @file
/// @brief ビデオゲーム用のクレジット設定構造体 CreditConfig のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CREDITCONFIG_H
#define AMDAEMON_CREDITCONFIG_H

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

#include <algorithm>
#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_credit
/// @{

    /// @brief ビデオゲーム用のクレジット設定構造体。
    /// @note memcpy 可能。
    ///
    /// 各設定値の詳細はビデオゲーム作成基準を参照すること。
    ///
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct CreditConfig
    {
        /// ノード別(I/Oボード別)のコインシュートの最大数。
        static const std::size_t MaxCoinChuteCount = ::amdaemon::MaxIODeviceCoinSlotCount;

        /// 消費クレジット設定の最大数。
        static const std::size_t MaxGameCostCount = 8;

        /// @brief COIN CHUTE TYPE 設定値。
        ///
        /// COMMON とするならば true 。 INDIVIDUAL とするならば false 。
        bool coinChuteCommon;

        /// @brief SERVICE TYPE 設定値。
        ///
        /// COMMON とするならば true 。 INDIVIDUAL とするならば false 。
        bool serviceCommon;

        /// @brief FREE PLAY 設定が有効か否か。
        ///
        /// FREE PLAY 設定を有効にするならば true 。無効にするならば false 。
        bool freePlay;

        /// @brief COIN CHUTE MULTIPLIER 設定値。
        ///
        /// 各コインシュートに投入されたコインを何COIN分として扱うか設定する。
        /// 例えばUFOキャッチャーならば { 1, 5 } を設定する。
        ///
        /// coinChuteCommon が false の場合は 0 番目の値のみが使われる。
        std::uint32_t coinMultipliers[MaxCoinChuteCount];

        /// @brief BONUS ADDER 設定値。
        ///
        /// 何COIN分加算されたらサービスの1COINを追加付与するか設定する。
        /// サービス無しならば 0 を設定する。
        std::uint32_t bonusAdder;

        /// @brief COIN TO CREDIT 設定値。
        ///
        /// COIN数いくつで1クレジットになるかを表す。
        std::uint32_t coinToCredit;

        /// @brief GAME COST SETTING 設定値。
        ///
        /// ゲームの開始等のために支払うクレジット数を設定する。
        /// 各要素値の意味はゲームにより異なる。
        ///
        /// 一般的なビデオゲームでは 0 番目にゲームスタートの必要クレジット数を設定する。
        /// また、必要であれば 1 番目にコンティニューの必要クレジット数を設定する。
        std::uint32_t gameCosts[MaxGameCostCount];

        /// @brief COIN AMOUNT 設定値。
        ///
        /// 電子マネーでコインを購入する際の単価(円単位)を表す。
        std::uint32_t coinAmount;

        /// @brief 既定値で初期化されたインスタンスを作成する。
        /// @return 既定値で初期化されたインスタンス。
        static CreditConfig makeDefault()
        {
            CreditConfig result = { };

            std::fill_n(result.coinMultipliers, MaxCoinChuteCount, 1);
            result.coinToCredit = 1;
            std::fill_n(result.gameCosts, MaxGameCostCount, 1);
            result.coinAmount = 100;

            return result;
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CREDITCONFIG_H