OpenMW/components/esm/loadgmst.hpp

#ifndef OPENMW_ESM_GMST_H
#define OPENMW_ESM_GMST_H

#include <string>

#include "variant.hpp"

namespace ESM
{

class ESMReader;
class ESMWriter;

/*
 *  Game setting, with automatic cleaning of "dirty" entries.
 *
 */

struct GameSetting
{
    std::string mId;

    Variant mValue;

    void load(ESMReader &esm);

    /// \todo remove the get* functions (redundant, since mValue as equivalent functions now).

    int getInt() const;
    ///< Throws an exception if GMST is not of type int or float.

    float getFloat() const;
    ///< Throws an exception if GMST is not of type int or float.

    std::string getString() const;
    ///< Throwns an exception if GMST is not of type string.

    void save(ESMWriter &esm);

    void blank();
    ///< Set record to default state (does not touch the ID).
};

    bool operator== (const GameSetting& left, const GameSetting& right);
}
#endif