Savemap.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
 
#pragma once
 
#include <string>
#include "common/TypeDefine.h"
 
class Savemap{
 
    public:
 
        Savemap();
 
        ~Savemap();
 
        void operator = (const Savemap &to_copy);
 
        void Read(std::string file_name);
 
        void Write(int slot, std::string file_name);
 
        std::string GetControlKey() const;
 
        void SetControlKey(const std::string control);
 
        void SetWindowColours(
          const unsigned int t_l_r, const unsigned int t_l_g, const unsigned int t_l_b,
          const unsigned int t_r_r, const unsigned int t_r_g, const unsigned int t_r_b,
          const unsigned int b_r_r, const unsigned int b_r_g, const unsigned int b_r_b,
          const unsigned int b_l_r, const unsigned int b_l_g, const unsigned int b_l_b
        );
 
        void SetMoney(const unsigned int money);
 
        void SetGameTime(const unsigned int seconds);
 
        void SetCountdownTime(const unsigned int seconds);
 
        void SetKeyItem(const unsigned int item, const bool owned);
 
        void SetParty(const int member_1, const int member_2, const int member_3);
 
        void SetItem(const unsigned int slot, const unsigned int id, const unsigned int quantity);
 
        void SetMateria(const unsigned int slot, const int id, const unsigned int ap);
 
        void SetESkillMateria(const unsigned slot, const unsigned int skill, const bool learned);
 
        void SetMateriaStash(const unsigned int slot, const int id, const unsigned int ap);
 
        void SetESkillMateriaStash(
          const unsigned slot, const unsigned int skill, const bool learned
        );
 
        void SetLocation(
          const float x, const float y, const float z,
          const unsigned int triangle, const int angle, std::string field, std::string name
        );
 
        void SetSetting(const unsigned int key, const unsigned int value);
 
        void SetCharacterInfo(
          const unsigned int id, const int char_id, const std::string name,
          const bool enabled, const bool locked,
          const unsigned int level, const unsigned int kills,
          const bool back_row, const unsigned int exp, const unsigned int exp_to_next,
          const unsigned int limit_level, const unsigned int limit_bar,
          const unsigned int weapon, const unsigned int armor, const int accessory
        );
 
        void SetCharacterStat(
          const unsigned int id, const unsigned int stat,
          const unsigned int base, const unsigned int extra
        );
 
        void SetCharacterLimitLearned(
          const unsigned int id, const unsigned int level,
          const unsigned int technique, const bool learned, const unsigned int uses
        );
 
        void SetCharacterMateria(
          const unsigned int id, const bool weapon, const unsigned int slot,
          const int materia, const unsigned int ap
        );
 
        void SetCharacterESkillMateria(
          const unsigned int id, const bool weapon, const unsigned int slot,
          const unsigned int skill, const bool learned
        );
 
        void SetCharacterStatus(
          const unsigned int id, const unsigned int status, const bool inflicted
        );
 
        void SetData(const unsigned int bank, const unsigned int address, const int value);
 
        bool IsEmpty();
 
        std::string GetControlKey();
 
        unsigned int GetWindowCornerColourComponent(
          const unsigned int corner, const unsigned int comp
        );
 
        unsigned int GetMoney();
 
        unsigned int GetGameTime();
 
        unsigned int GetCountdownTime();
 
        int GetPartyMember(const unsigned int pos);
 
        unsigned int GetItemAtPosId(const unsigned int pos);
 
        unsigned int GetItemAtPosQty(const unsigned int pos);
 
        bool GetKeyItem(const unsigned int id);
 
        int GetMateriaAtPosId(const unsigned int pos);
 
        unsigned int GetMateriaAtPosAp(const unsigned int pos);
 
        bool IsMateriaAtPosESkill(const unsigned int pos);
 
        bool IsMateriaAtPosESkillLearned(const unsigned int pos, const unsigned int skill);
 
        int GetStashAtPosId(const unsigned int pos);
 
        unsigned int GetStashAtPosAp(const unsigned int pos);
 
        bool IsStashAtPosESkill(const unsigned int pos);
 
        bool IsStashAtPosESkillLearned(const unsigned int pos, const unsigned int skill);
 
        float GetLocationX();
 
        float GetLocationY();
 
        float GetLocationZ();
 
        unsigned int GetLocationTriangle();
 
        int GetLocationAngle();
 
        std::string GetLocationField();
 
        std::string GetLocationName();
 
        int GetSetting(const unsigned int key);
 
        int GetCharacterCharId(const unsigned int id);
 
        std::string GetCharacterName(const unsigned int id);
 
        unsigned int GetCharacterLevel(const unsigned int id);
 
        unsigned int GetCharacterKills(const unsigned int id);
 
        bool IsCharacterEnabled(const unsigned int id);
 
        bool IsCharacterLocked(const unsigned int id);
 
        bool IsCharacterBackRow(const unsigned int id);
 
        unsigned int GetCharacterExp(const unsigned int id);
 
        unsigned int GetCharacterExpToNext(const unsigned int id);
 
        unsigned int GetCharacterLimitLevel(const unsigned int id);
 
        unsigned int GetCharacterLimitBar(const unsigned int id);
 
        unsigned int GetCharacterWeaponId(const unsigned int id);
 
        unsigned int GetCharacterArmorId(const unsigned int id);
 
        int GetCharacterAccessoryId(const unsigned int id);
 
        unsigned int GetCharacterStatBase(const unsigned int id, const unsigned int stat);
 
        unsigned int GetCharacterStatExtra(const unsigned int id, const unsigned int stat);
 
        unsigned int GetCharacterLimitUses(const unsigned int id, const unsigned int level);
 
        bool IsCharacterLimitLearned(
          const unsigned int id, const unsigned int level, const unsigned int tech
        );
 
        int GetCharacterMateriaId(const unsigned int id, const bool weapon, const unsigned int pos);
 
        unsigned int GetCharacterMateriaAp(
          const unsigned int id, const bool weapon, const unsigned int pos
        );
 
        bool IsCharacterMateriaESkill(const unsigned int id, const bool weapon, const unsigned int pos);
 
        bool IsCharacterMateriaESkillLearned(
          const unsigned int id, const bool weapon, const unsigned int pos, const unsigned int skill
        );
 
        int GetData(const unsigned int bank, const unsigned int address);
 
        class STAT{
 
            public:
 
                static const unsigned int STR = 0;
 
                static const unsigned int VIT = 1;
 
                static const unsigned int MAG = 2;
 
                static const unsigned int SPR = 3;
 
                static const unsigned int DEX = 4;
 
                static const unsigned int LCK = 5;
 
                static const unsigned int HP = 6;
 
                static const unsigned int MP = 7;
        };
 
        class CORNER{
 
            public:
 
                static const unsigned int T_L = 0;
 
                static const unsigned int T_R = 1;
 
                static const unsigned int B_R = 2;
 
                static const unsigned int B_L = 3;
        };
 
        class COLOUR{
 
            public:
 
                static const unsigned int R = 0;
 
                static const unsigned int G = 1;
 
                static const unsigned int B = 2;
        };
 
    private:
 
        static const unsigned int MAX_CHARACTERS = 11;
 
        static const unsigned int MAX_ITEM_SLOTS = 500;
 
        static const unsigned int MAX_KEY_ITEM_SLOTS = 100;
 
        static const unsigned int MAX_MATERIA_SLOTS = 500;
 
        static const unsigned int MAX_STASH_SLOTS = 500;
 
        static const unsigned int MAX_EQUIP_SLOTS = 10;
 
        static const unsigned int MAX_ENEMY_SKILLS = 32;
 
        static const unsigned int MAX_LIMIT_LEVELS = 4;
 
        static const unsigned int MAX_LIMIT_TECHNIQUES = 4;
 
        static const unsigned int MAX_LIMIT_BAR = 254;
 
        static const unsigned int MAX_PARTY_MEMBERS = 3;
 
        static const unsigned int BANK_COUNT = 16;
 
        static const unsigned int BANK_ADDRESS_COUNT = 256;
 
        static const unsigned int MAX_COLOUR = 254;
 
 
        struct Settings{
 
            enum class MagicOrder{
 
                RAI,
 
                RIA,
 
                AIR,
 
                ARI,
 
                IRA,
 
                IAR,
            };
 
            enum class AtbMode{
 
                ACTIVE,
 
                RECOMMENDED,
 
                WAIT
            };
 
            unsigned int battle_speed;
 
            unsigned int battle_msg_speed;
 
            unsigned int msg_speed;
 
            MagicOrder order;
 
            AtbMode atb_mode;
 
            bool batle_help;
 
            // TODO: Key mappings, when implemented.
        };
 
        struct Location{
 
            float x;
 
            float y;
 
            float z;
 
            unsigned int triangle;
 
            unsigned int angle;
 
            std::string field;
 
            std::string name;
        };
 
        struct Materia{
 
            int id;
 
            unsigned int ap;
 
            bool enemy_skill;
 
            bool enemy_skill_learned[MAX_ENEMY_SKILLS];
        };
 
        struct Item{
 
            int id;
 
            unsigned int quantity;
        };
 
        struct Character{
 
            struct Stat{
 
                unsigned int base;
 
                unsigned int extra;
            };
 
            struct Equipment{
 
                u16 id;
 
                Materia materia[MAX_EQUIP_SLOTS];
            };
 
            unsigned int id;
 
            int char_id;
 
            bool enabled;
 
            bool locked;
 
            std::string name;
 
            unsigned int level;
 
            unsigned int kills;
 
            bool back_row;
 
            unsigned int exp;
 
            unsigned int exp_to_next;
 
            Stat str;
 
            Stat vit;
 
            Stat mag;
 
            Stat spr;
 
            Stat dex;
 
            Stat lck;
 
            Stat hp;
 
            Stat mp;
 
            unsigned int limit_level;
 
            unsigned int limit_bar;
 
            bool limits_learned[MAX_LIMIT_LEVELS][MAX_LIMIT_TECHNIQUES];
 
            unsigned int limit_uses[MAX_LIMIT_LEVELS];
 
            Equipment weapon;
 
            Equipment armor;
 
            int accessory;
 
            std::vector<u8> status;
        };
 
        bool empty_;
 
        int slot_;
 
        std::string control_;
 
        u8 window_colours_[4][3];
 
        Character characters_[MAX_CHARACTERS];
 
        int party_[MAX_PARTY_MEMBERS];
 
        Item items_[MAX_ITEM_SLOTS];
 
        bool key_items_[MAX_KEY_ITEM_SLOTS];
 
        Materia materia_[MAX_MATERIA_SLOTS];
 
        Materia materia_stash_[MAX_STASH_SLOTS];
 
        unsigned int money_;
 
        unsigned int seconds_;
 
        unsigned int countdown_;
 
        Location location_;
 
        Settings settings_;
 
        int data_[BANK_COUNT][BANK_ADDRESS_COUNT];
};