Achievement.h

/*
 * Copyright (C) 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ACHIEVEMENT_H
#define ACHIEVEMENT_H

#include <QString>

class QJsonObject;

class Achievement {
public:
    enum AchievementType{
        UNKNOWN = 0,
        REGULAR,
        INCREMENTAL,
    };

    Achievement(const QString& name);
    Achievement(const QJsonObject& json);

    void merge(const Achievement& achievement);
    const QString& getName() const { return mName; }
    AchievementType getAchievementType() const;
    bool hasBeenRevealed() const { return mHasBeenRevealed; }
    bool hasBeenUnlocked() const { return mHasBeenUnlocked; }
    int getMinStepsSet() const { return mMinStepsSet; }
    int getStepsIncremented() const { return mStepsIncremented; }

    QJsonObject toJsonObject() const;

    void unlock(bool immediately);
    void reveal(bool immediately);
    void increment(int numSteps, bool immediately);
    void setSteps(int numSteps, bool immediately);

    bool saveToCloud();

private:
    bool cloudUnlock();
    bool cloudReveal();
    bool cloudIncrement(int numSteps);
    bool cloudSetSteps(int numSteps);

    QString mName;
    bool mHasBeenRevealed = false;
    bool mRevealIsDirty = false;
    bool mHasBeenUnlocked = false;
    bool mUnlockIsDirty = false;
    int mMinStepsSet = 0;
    bool mMinStepsDirty = false;
    int mStepsIncremented = 0;
    int mStepsIncrementedDirtiness = 0;
};

#endif // ACHIEVEMENT_H