CharacterDB.h

Go to the documentation of this file.

/*
    ------------------------------------------------------------------------------------
    LICENSE:
    ------------------------------------------------------------------------------------
    This file is part of EVEmu: EVE Online Server Emulator
    Copyright 2006 - 2021 The EVEmu Team
    For the latest information visit https://evemu.dev
    ------------------------------------------------------------------------------------
    This program is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License as published by the Free Software
    Foundation; either version 2 of the License, or (at your option) any later
    version.

    This program 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License along with
    this program; if not, write to the Free Software Foundation, Inc., 59 Temple
    Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    http://www.gnu.org/copyleft/lesser.txt.
    ------------------------------------------------------------------------------------
    Author:        Zhur
    Updates:        Allan
*/

#ifndef __CHARACTERDB_H_INCL__
#define __CHARACTERDB_H_INCL__

#include "ServiceDB.h"

// struct for portraitInfo
struct PortraitInfo {
    uint32 backgroundID;
    uint32 lightID;
    uint32 lightColorID;
    float cameraX;
    float cameraY;
    float cameraZ;
    float cameraFieldOfView;
    float cameraPoiX;
    float cameraPoiY;
    float cameraPoiZ;
    float headLookTargetX;
    float headLookTargetY;
    float headLookTargetZ;
    float lightIntensity;
    float portraitPoseNumber;
    float headTilt;
    float orientChar;
    float browLeftCurl;
    float browLeftTighten;
    float browLeftUpDown;
    float browRightCurl;
    float browRightTighten;
    float browRightUpDown;
    float eyeClose;
    float eyesLookVertical;
    float eyesLookHorizontal;
    float squintLeft;
    float squintRight;
    float jawSideways;
    float jawUp;
    float puckerLips;
    float frownLeft;
    float frownRight;
    float smileLeft;
    float smileRight;
};

/* POD structure for skills in queue */
struct QueuedSkill {
    uint8 level;
    uint16 typeID;
    int64 endTime;
    int64 startTime;
};
typedef std::vector<QueuedSkill> SkillQueue;

class PyObject;
class PyString;
class PyObjectEx;
class CharacterData;
class CharacterAppearance;
class CharKillData;
class ItemFactory;
class InventoryItem;
class Client;
class ItemData;
class CorpData;

class CharacterDB : public ServiceDB
{
public:
    static uint32 NewCharacter(const CharacterData& data, const CorpData& corpData);
    static bool SaveCharacter(uint32 charID, const CharacterData &data);
    static bool SaveCorpData(uint32 charID, const CorpData &data);
    void DeleteCharacter(uint32 charID);
    // this changes corp member counts, adds employment history, and updates char's corp and start date
    static void AddEmployment(uint32 charID, uint32 corpID, uint32 oldCorpID=0);
    static void GetCharacterData(uint32 charID, std::map<std::string, int64> &characterDataMap);
    static bool GetCharHomeStation(uint32 charID, uint32 &stationID);
    //if you want to get the typeID of the clone use GetActiveCloneType
    static bool GetActiveCloneID(uint32 charID, uint32 &itemID);
    static PyRep *GetInfoWindowDataForChar(uint32 charID);
    static uint32 GetStartingStationByCareer(uint32 careerID);

    static PyRep* List(uint32 ownerID);
    static PyRep* ListStations(uint32 ownerID, std::ostringstream& flagIDs, bool forCorp=false, bool bpOnly=false);
    static PyRep* ListStationItems(uint32 ownerID, uint32 stationID);
    static PyRep* ListStationBlueprintItems(uint32 ownerID, uint32 stationID, bool forCorp=false);

    PyRep *GetCharacterList(uint32 accountID);
    PyRep *GetCharSelectInfo(uint32 charID);
    void SetAvatar(uint32 charID, PyRep* hairDarkness);
    void SetAvatarColors(uint32 charID, uint32 colorID, uint32 colorNameA, uint32 colorNameBC, double weight, double gloss);
    void SetAvatarModifiers(uint32 charID, PyRep* modifierLocationID,  PyRep* paperdollResourceID, PyRep* paperdollResourceVariation);
    void SetAvatarSculpts(uint32 charID, PyRep* sculptLocationID, PyRep* weightUpDown, PyRep* weightLeftRight, PyRep* weightForwardBack);
    void SetPortraitInfo(uint32 charID, PortraitInfo &data);
    PyRep *GetCharPublicInfo(uint32 charID);
    PyRep *GetCharPublicInfo3(uint32 charID);
    PyRep *GetCharPrivateInfo(uint32 charID);
    
    //PyObject *GetAgentPublicInfo(uint32 agentID);
    PyRep *GetOwnerNoteLabels(uint32 charID);
    PyRep *GetOwnerNote(uint32 charID, uint32 noteID);
    uint32 PickAlternateShip(uint32 charID, uint32 locationID);
    void SetCurrentShip(uint32 charID, uint32 shipID);
    void SetCurrentPod(uint32 charID, uint32 podID);

    bool ChangeCloneType(uint32 charID, uint32 typeID);
    static bool ChangeCloneLocation(uint32 charID, uint32 locationID);
    bool GetCharClones(uint32 charID, std::vector<uint32> &into);
    bool GetActiveCloneType(uint32 charID, uint32 &typeID);
    std::string GetCharName(uint32 charID);

    PyRep* GetContacts(uint32 charID, bool blocked);
    void AddContact(uint32 ownerID, uint32 charID, int32 standing, bool inWatchlist);
    void UpdateContact(int32 standing, uint32 charID, uint32 ownerID);
    void RemoveContact(uint32 charID, uint32 ownerID);
    void SetBlockContact(uint32 charID, uint32 ownerID, bool blocked);

    bool GetCharItems(uint32 charID, std::vector<uint32> &into);
    bool GetCareerBySchool(uint32 schoolID, uint8 &raceID, uint32 &careerID);
    bool GetCorporationBySchool(uint32 schoolID, uint32 &corporationID);
    bool GetLocationCorporationByCareer(CharacterData &cdata, uint32 &corporationID);
    bool DoesCorporationExist(uint32 corpID);

    bool        GetAttributesFromAncestry(uint32 ancestryID, uint8 &intelligence, uint8 &charisma, uint8 &perception, uint8 &memory, uint8 &willpower);

    bool        GetBaseSkills(std::map< uint32, uint8 >& into);
    bool        GetSkillsByRace(uint32 raceID, std::map< uint32, uint8 >& into);
    bool        GetSkillsByCareer(uint32 careerID, std::map< uint32, uint8 >& into);

    PyString*   GetNote(uint32 ownerID, uint32 itemID);

    bool        SetNote(uint32 ownerID, uint32 itemID, const char *str);

    uint32      AddOwnerNote(uint32 charID, const std::string &label, const std::string &content);
    bool        EditOwnerNote(uint32 charID, uint32 noteID, const std::string &label, const std::string &content);

    int64       PrepareCharacterForDelete(uint32 accountID, uint32 charID);
    void        CancelCharacterDeletePrepare(uint32 accountID, uint32 charID);

    bool        ReportRespec(uint32 characterId);
    PyRep*      GetRespecInfo(uint32 characterId);

    bool        LoadSkillQueue(uint32 charID, SkillQueue &into);
    bool        LoadPausedSkillQueue(uint32 charID, SkillQueue &into);
    bool        SaveSkillQueue(uint32 charID, SkillQueue &queue);
    bool        SavePausedSkillQueue(uint32 charID, SkillQueue &queue);
    void        SaveSkillHistory(uint16 eventID, double logDate, uint32 characterID, uint32 skillTypeID, uint8 skillLevel, uint32 absolutePoints);
    PyRep*      GetSkillHistory(uint32 charID);
    void        UpdateSkillQueueEndTime(int64 endtime, uint32 charID);

    void        SetLogInTime(uint32 charID);
    void        SetLogOffTime(uint32 charID);

    void        addOwnerCache(uint32 ownerID, std::string ownerName, uint32 typeID);

    PyRep*      GetBounty(uint32 charID, uint32 ownerID);
    PyRep*      GetTopBounties();
    void        AddBounty(uint32 charID, uint32 ownerID, uint32 amount);

    PyRep*      GetKillOrLoss(uint32 charID);

    static void SetCorpRole(uint32 charID, int64 role);
    static int64 GetCorpRole(uint32 charID);
    static uint32 GetCorpID(uint32 charID);
    static float GetCorpTaxRate(uint32 charID);
    static PyRep* GetMyCorpMates(uint32 corpID);

    // get skill level for given skill for offline character (used by market tax)
    static uint8 GetSkillLevel(uint32 charID, uint16 skillTypeID);

    PyRep*      GetLabels(uint32 charID);
    void        SetLabel(uint32 charID, uint32 color, std::string name);
    void        EditLabel(uint32 charID, uint32 labelID, uint32 color, std::string name);
    void        DeleteLabel(uint32 charID, uint32 labelID);

    void        VisitSystem(uint32 solarSystemID, uint32 charID);

    //  name validation shit
    void        ValidateCharName(std::string name);     // called on CreateCharacterWithDoll() and will throw on error
    PyRep*      ValidateCharNameRep(std::string name);  // called by "Check Name" button in char creation.  returns integer
};

#endif