sapphire/src/servers/Server_Zone/Player.h

#ifndef _PLAYER_H
#define _PLAYER_H

#include "Forwards.h"

#include <Server_Common/Common.h>

#include "Actor.h"
#include "Inventory.h"
#include <map>
#include <queue>

namespace Core {

namespace Entity {

struct QueuedZoning
{
   uint16_t m_targetZone;
   Common::FFXIVARR_POSITION3 m_targetPosition;
   float m_targetRotation;
   uint64_t m_queueTime;

   QueuedZoning( uint16_t targetZone, const Common::FFXIVARR_POSITION3& targetPosition, uint64_t queuedTime, float targetRotation )
      : m_targetZone( targetZone )
      , m_targetPosition( targetPosition )
      , m_queueTime( queuedTime )
      , m_targetRotation( targetRotation ) {}
};

/** Class representing the Player
*  Inheriting from Actor
*
*/
class Player : public Actor
{
public:
   /*! Contructor */
   Player();

   /*! Destructor */
   ~Player();

   void autoAttack( ActorPtr pTarget ) override;

   // EventHandlers
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! start an event action */
   void eventActionStart( uint32_t eventId, uint32_t action, ActionCallback finishCallback, ActionCallback interruptCallback, uint64_t additional );
   /*! start an event item action */
   void eventItemActionStart( uint32_t eventId, uint32_t action, ActionCallback finishCallback, ActionCallback interruptCallback, uint64_t additional );
   /*! start/register a normal event */
   void eventStart( uint64_t actorId, uint32_t eventId, uint8_t eventParam, uint8_t eventParam1, uint32_t eventParam2 );
   /*! play a subevent */
   void eventPlay( uint32_t eventId, uint32_t scene, uint32_t flags, uint32_t eventParam2, uint32_t eventParam3 );
   /*! play a subevent */
   void eventPlay( uint32_t eventId, uint32_t scene, uint32_t flags,
                   uint32_t eventParam2, uint32_t eventParam3, Scripting::EventReturnCallback eventReturnCallback );
   /*! play a subevent */
   void eventPlay( uint32_t eventId, uint32_t scene, uint32_t flags,
                   uint32_t eventParam2, uint32_t eventParam3, uint32_t eventParam4, Scripting::EventReturnCallback eventReturnCallback );
   /*! play a subevent */
   void eventPlay( uint32_t eventId, uint32_t scene, uint32_t flags, Scripting::EventReturnCallback eventReturnCallback );
   /*! play a subevent */
   void eventPlay( uint32_t eventId, uint32_t scene, uint32_t flags );
   /*! finish / unregister an event */
   void eventFinish( uint32_t eventId, uint32_t freePlayer );
   /*! add an event to the event array */
   void addEvent( Event::EventPtr pEvent );
   /*! retrieve an event from the event array */
   Event::EventPtr getEvent( uint32_t eventId );
   /*! get number of active events */
   size_t getEventCount();
   /*! remove an event from the event array */
   void removeEvent( uint32_t eventId );
   /*! return the eventlist */
   std::map< uint32_t, Event::EventPtr >& eventList();

   void checkEvent( uint32_t eventId );

   

   // Events
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! Event to be called when zoning process gets triggered */
   void onZoneStart();
   /*! Event to be called when zoning process is finished */
   void onZoneDone();
   /*! Event to be called on login */
   void onLogin();
   /*! Event to be called on update tick */
   void onTick() override;
   /*! Event to be called upon player death */
   void onDeath() override;
   /*! Event called on every session iteration */
   void update( int64_t currTime ) override;
   /*! Event to be called upon Bnpc kill */
   void onMobKill( uint16_t nameId );


   // Quest
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! load data for currently active quests */
   bool loadActiveQuests();
   /*! update quest ( register it as active quest if new ) */
   void updateQuest( uint16_t questId, uint16_t sequence );
   /*! return true if quest is currently active */
   bool hasQuest( uint16_t questId );
   /*! return the current quest sequence */
   uint8_t getQuestSeq( uint16_t questId );
   /*! send the quest tracker packet */
   void sendQuestTracker();
   /*! set quest tracker flag for a specified slot */
   void setQuestTracker( uint16_t index, int16_t flag );
   /*! return the index of a given quest in the players quest list */
   int16_t getQuestIndex( uint16_t questId );
   /*! finish a given quest */
   void finishQuest( uint16_t questId );
   /*! finish a given quest */
   void unfinishQuest( uint16_t questId );
   /*! remove a given quest */
   void removeQuest( uint16_t questId );
   /*! add a quest to the completed quests mask */
   void updateQuestsCompleted( uint32_t questId );
   /*! remove a quest from the completed quest mask */
   void removeQuestsCompleted( uint32_t questId );

   bool giveQuestRewards( uint32_t questId, uint32_t optionalChoice );

   boost::shared_ptr< Common::QuestActive > getQuestActive( uint16_t index );

   uint8_t getQuestUI8A( uint16_t questId );
   uint8_t getQuestUI8B( uint16_t questId );
   uint8_t getQuestUI8C( uint16_t questId );
   uint8_t getQuestUI8D( uint16_t questId );
   uint8_t getQuestUI8E( uint16_t questId );
   uint8_t getQuestUI8F( uint16_t questId );
   uint8_t getQuestUI8AH( uint16_t questId );
   uint8_t getQuestUI8BH( uint16_t questId );
   uint8_t getQuestUI8CH( uint16_t questId );
   uint8_t getQuestUI8DH( uint16_t questId );
   uint8_t getQuestUI8EH( uint16_t questId );
   uint8_t getQuestUI8FH( uint16_t questId );
   uint8_t getQuestUI8AL( uint16_t questId );
   uint8_t getQuestUI8BL( uint16_t questId );
   uint8_t getQuestUI8CL( uint16_t questId );
   uint8_t getQuestUI8DL( uint16_t questId );
   uint8_t getQuestUI8EL( uint16_t questId );
   uint8_t getQuestUI8FL( uint16_t questId );
   uint16_t getQuestUI16A( uint16_t questId );
   uint16_t getQuestUI16B( uint16_t questId );
   uint16_t getQuestUI16C( uint16_t questId );
   uint32_t getQuestUI32A( uint16_t questId );

   uint8_t getQuestBitFlag8( uint16_t questId );
   uint8_t getQuestBitFlag16( uint16_t questId );
   uint8_t getQuestBitFlag24( uint16_t questId );
   uint8_t getQuestBitFlag32( uint16_t questId );
   uint8_t getQuestBitFlag40( uint16_t questId );
   uint8_t getQuestBitFlag48( uint16_t questId );


   void setQuestUI8A( uint16_t questId, uint8_t val );
   void setQuestUI8B( uint16_t questId, uint8_t val );
   void setQuestUI8C( uint16_t questId, uint8_t val );
   void setQuestUI8D( uint16_t questId, uint8_t val );
   void setQuestUI8E( uint16_t questId, uint8_t val );
   void setQuestUI8F( uint16_t questId, uint8_t val );
   void setQuestUI8AH( uint16_t questId, uint8_t val );
   void setQuestUI8BH( uint16_t questId, uint8_t val );
   void setQuestUI8CH( uint16_t questId, uint8_t val );
   void setQuestUI8DH( uint16_t questId, uint8_t val );
   void setQuestUI8EH( uint16_t questId, uint8_t val );
   void setQuestUI8FH( uint16_t questId, uint8_t val );
   void setQuestUI8AL( uint16_t questId, uint8_t val );
   void setQuestUI8BL( uint16_t questId, uint8_t val );
   void setQuestUI8CL( uint16_t questId, uint8_t val );
   void setQuestUI8DL( uint16_t questId, uint8_t val );
   void setQuestUI8EL( uint16_t questId, uint8_t val );
   void setQuestUI8FL( uint16_t questId, uint8_t val );
   void setQuestUI16A( uint16_t questId, uint16_t val );
   void setQuestUI16B( uint16_t questId, uint16_t val );
   void setQuestUI16C( uint16_t questId, uint16_t val );
   void setQuestUI32A( uint16_t questId, uint32_t val );

   void setQuestBitFlag8( uint16_t questId, uint8_t val );
   void setQuestBitFlag16( uint16_t questId, uint8_t val );
   void setQuestBitFlag24( uint16_t questId, uint8_t val );
   void setQuestBitFlag32( uint16_t questId, uint8_t val );
   void setQuestBitFlag40( uint16_t questId, uint8_t val );
   void setQuestBitFlag48( uint16_t questId, uint8_t val );

   // Inventory / Item / Currency
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! add an item to the first free slot in one of the 4 main containers */
   bool tryAddItem( uint16_t catalogId, uint16_t quantity );
   /*! add an item to a given container */
   bool addItem( uint16_t containerId, uint16_t catalogId, uint16_t quantity );
   /*! equip an item to a specified slot */
   void equipItem( Inventory::EquipSlot equipSlotId, ItemPtr pItem, bool sendModel );
   /*! remove an item from an equipment slot */
   void unequipItem( Inventory::EquipSlot equipSlotId, ItemPtr pItem );
   /*! equip a weapon, possibly forcing a job change */
   void equipWeapon( ItemPtr pItem );
   /*! get a const pointer to the inventory object */
   InventoryPtr getInvetory() const;
   /*! get the current main hand model */
   uint64_t getModelMainWeapon() const;
   /*! get the current off hand model */
   uint64_t getModelSubWeapon() const;
   /*! get the current system hand model */
   uint64_t getModelSystemWeapon() const;
   /*! return a const pointer to the model array */
   const uint32_t * getModelArray() const;
   /*! return the equipment model in a specified equipment slot */
   uint32_t getModelForSlot( Inventory::EquipSlot slot );
   /*! return the current amount of currency of type */
   uint32_t getCurrency( uint8_t type ) const;
   /*! add amount to the currency of type */
   void addCurrency( uint8_t type, uint32_t amount );
   /*! remove amount from the currency of type */
   void removeCurrency( uint8_t type, uint32_t amount );
   /*! return the current amount of crystals of type */
   uint32_t getCrystal( uint8_t type ) const;
   /*! add amount to the crystals of type */
   void addCrystal( uint8_t type, uint32_t amount );
   /*! remove amount from the crystals of type */
   void removeCrystal( uint8_t type, uint32_t amount );

   // Class / Job / Exp
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! returns the level of the currently active class / job */
   uint8_t getLevel() const override;
   /*! returns the level of the provided class / job */
   uint8_t getLevelForClass( Core::Common::ClassJob pClass ) const;
   /*! returns the exp of the currently active class / job */
   uint32_t getExp() const;
   /*! sets the exp of the currently active class / job */
   void setExp( uint32_t amount );
   /*! adds exp to the currently active class / job */
   void gainExp( uint32_t amount );
   /*! gain a level on the currently active class / job */
   void gainLevel();
   /*! set level on the currently active class / job to given level */
   void setLevel( uint8_t level );
   /*! set level on the provided class / job to given level */
   void setLevelForClass( uint8_t level, Core::Common::ClassJob classjob );
   /*! change class or job to given class / job */
   void setClassJob( Core::Common::ClassJob classJob );
   /*! returns a pointer to the class array */
   uint16_t * getClassArray();
   /*! returns a const pointer to the class array */
   const uint16_t * getClassArray() const;
   /*! returns a pointer to the exp array */
   uint32_t * getExpArray();
   /*! returns a const pointer to the exp array */
   const uint32_t * getExpArray() const;

   // Base Look / Stats / Params
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! return the birth day */
   uint8_t getBirthDay() const;
   /*! return the birth month */
   uint8_t getBirthMonth() const;
   /*! return the guardian diety Id */
   uint8_t getGuardianDeity() const;
   /*! get look at specified index */
   uint8_t getLookAt( uint8_t index ) const;
   /*! return the race */
   uint8_t getRace() const;
   /*! return gender 0 male, 1 female */
   uint8_t getGender() const;
   /*! return the id of the home town */
   uint8_t getStartTown() const;
   /*! return the voice id */
   uint8_t getVoiceId() const;
   /*! return the grand company */
   uint8_t getGc() const;
   /*! return the grand company rank */
   const uint8_t * getGcRankArray() const;
   /*! set look at index */
   void setLookAt( uint8_t index, uint8_t value );
   /*! set the voice Id */
   void setVoiceId( uint8_t voiceId );
   /*! set the grand company */
   void setGc( uint8_t gc );
   /*! set the grand company rank */
   void setGcRankAt( uint8_t index, uint8_t rank );
   /*! return a const pointer to the look array */
   const uint8_t * getLookArray() const;
   /*! return true if the player is loggin in for the first time */
   bool isFirstLogin() const;
   /*! set first log in state */
   void setFirstLogin( bool mode );
   /*! returns true if the player is currently in combat */
   bool isInCombat() const;
   /*! sets players combat state */
   void setInCombat( bool mode );
   /*! return current online status depending on current state / activity */
   Common::OnlineStatus getOnlineStatus();
   /*! sets the players zone, initiating a zoning process */
   void setZone( uint32_t zoneId );

   void forceZoneing( uint32_t zoneId );
   /*! return player to preset homepoint */
   void returnToHomepoint();
   /*! change position, sends update too */
   void changePosition( float x, float y, float z, float o );
   /*! return the contentId */
   uint64_t getContentId() const;
   /*! return max hp */
   uint32_t getMaxHp();
   /*! return max mp */
   uint32_t getMaxMp();
   /*! return a players total play time */
   uint32_t getPlayTime() const;
   /*! return true if the player has "new adventurere" status */
   bool isNewAdventurer() const;
   /*! change the players "new adventurere" status */
   void setNewAdventurer( bool state );
   /*! sets the list of current online status */
   void setOnlineStatusMask( uint64_t status );
   /*! returns the current online status */
   uint64_t getOnlineStatusMask() const;
   /*! perform a teleport of a specified type ( teleport,return,aethernet ) */
   void teleport( uint16_t aetheryteId, uint8_t type = 1 );
   /*! prepares zoning / fades out the screen */
   void prepareZoning( uint16_t targetZone, bool fadeOut );

   void calculateStats() override;
   void sendStats();


   // Aetheryte / Action / Attribute bitmasks
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! register aetheryte aetheryteId and send update */
   void registerAetheryte( uint8_t aetheryteId );
   /*! check if aetheryte is already registered */
   bool isAetheryteRegistered( uint8_t aetheryteId ) const;
   /*! return a const pointer to the aetheryte unlock bitmask array */
   int8_t getAetheryteMaskAt( uint8_t index ) const;
   /*! return a pointer to the aetheryte unlock bitmask array */
   uint8_t * getAetheryteArray();
   /*! set homepoint */
   void setHomepoint( uint8_t aetheryteId );
   /*! get homepoint */
   uint8_t getHomepoint() const;
   /*! discover subarea subid fo map map_id, also send udpate packet */
   void discover( int16_t map_id, int16_t sub_id );
   /*! return a pointer to the discovery bitmask array */
   uint8_t * getDiscoveryBitmask();
   /*! helper/debug function to reset all discovered areas */
   void resetDiscovery();
   /*! get a pointer to the howto bitmask array */
   uint8_t * getHowToArray();
   /*! get a const pointer to the howto bitmask array */
   const uint8_t * getHowToArray() const;
   /*! update bitmask for how-to's seen */
   void updateHowtosSeen( uint32_t howToId );
   /*! learn an action / update the unlock bitmask. */
   void learnAction( uint8_t actionId );
   /*! check if an action is already unlocked in the bitmask. */
   bool isActionLearned( uint8_t actionId ) const;
   /*! return a const pointer to the unlock bitmask array */
   const uint8_t * getUnlockBitmask() const;


   // Spawn handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! initialize the spawnId queue */
   void initSpawnIdQueue();
   /*! get the spawn id mapped to a specific actorId */
   uint8_t getSpawnIdForActorId( uint32_t actorId );
   /*! assigns the given spawnId to the actor */
   void assignSpawnIdToPlayerId( uint32_t actorId, uint8_t spawnId );
   /*! frees the spawnId assigned to the given actor */
   void freePlayerSpawnId( uint32_t actorId );
   /*! send spawn packets to pTarget */
   void spawn( PlayerPtr pTarget ) override;
   /*! send despawn packets to pTarget */
   void despawn( ActorPtr pTarget ) override;

   // Player State Handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /* return a const pointer to the state flag array */
   const uint8_t* getStateFlags() const;
   /* set a specified state flag */
   void setStateFlag( Common::PlayerStateFlag flag );
   /* set a specified state flag */
   void setStateFlags( std::vector< Common::PlayerStateFlag > flags );
   /* check if a specified flag is set */
   bool hasStateFlag( Common::PlayerStateFlag flag ) const;
   /* reset a specified flag */
   void unsetStateFlag( Common::PlayerStateFlag flag );
   /* helper function, send an empty state flag update */
   void unlock();

   // Player Session Handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! return the userlevel */
   uint8_t getUserLevel() const;
   /*! set timestamp for last received ping */
   void setLastPing( uint32_t ping );
   /*! get timestamp of last received ping */
   uint32_t getLastPing() const;

   // Player Database Handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! generate the update sql based on update flags */
   void createUpdateSql();
   /*! set an update flag */
   void setSyncFlag( uint32_t updateFlag );
   /*! load player from db, by id */
   bool load( uint32_t charId, SessionPtr pSession );
   /*! load active class data */
   bool loadClassData();
   /*! load search info */
   bool loadSearchInfo();

   // Player Network Handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   /*! send current models ( equipment ) */
   void sendModel();
   /*! send active state flags */
   void sendStateFlags();
   /*! send status update */
   void sendStatusUpdate( bool toSelf = true ) override;
   /*! send the entire inventory sequence */
   void sendInventory() const;
   /*! send active quest list */
   void sendQuestInfo();
   /*! send a quest specific message */
   void sendQuestMessage( uint32_t questId, int8_t msgId, uint8_t type, uint32_t var1, uint32_t var2 );
   /*! queue a packet for the player */
   void queuePacket( Network::Packets::GamePacketPtr pPacket );
   /*! returns true if loading is complete ( 0x69 has been received ) */
   bool isLoadingComplete() const;
   /*! set the loading complete bool */
   void setLoadingComplete( bool bComplete );
   /*! mark this player for zoning, notify worldserver */
   void performZoning(uint16_t zoneId, const Common::FFXIVARR_POSITION3& pos, float rotation);
   /*! return true if the player is marked for zoning */
   bool isMarkedForZoning() const;

   Common::ZoneingType getZoningType() const;
   void setZoningType( Common::ZoneingType zoneingType );

   void setSearchInfo( uint8_t selectRegion, uint8_t selectClass, const char* searchMessage );
   const char* getSearchMessage() const;
   uint8_t getSearchSelectRegion() const;
   uint8_t getSearchSelectClass() const;

   void sendNotice( const std::string& message );
   void sendUrgent( const std::string& message );
   void sendDebug( const std::string& message );

   // Player Battle Handling
   //////////////////////////////////////////////////////////////////////////////////////////////////////
   void onMobAggro( BattleNpcPtr pBNpc );
   void onMobDeaggro( BattleNpcPtr pBNpc );

   void initHateSlotQueue();
   void hateListAdd( BattleNpcPtr pBNpc );
   void hateListRemove( BattleNpcPtr pBNpc );

   bool hateListHasMob( BattleNpcPtr pBNpc );

   void sendHateList();

   bool actionHasCastTime( uint32_t actionId );

   Core::Entity::ActorPtr lookupTargetById( uint64_t targetId );

   bool isLogin() const;
   void setIsLogin( bool bIsLogin );

   uint16_t getZoneId() const;

   uint8_t getMode() const;
   void setMode( uint8_t mode );

   void setAutoattack( bool mode );
   bool isAutoattackOn() const;

private:
   uint32_t m_lastWrite;
   uint32_t m_lastPing;

   bool m_bIsLogin;

   // ==== CHARABASE
   uint64_t m_contentId; // This id will be the name of the folder for character settings in "My Games"

   uint8_t m_mode;

private:
   uint8_t m_mount;
   uint8_t m_ignore;
   uint8_t m_invincibleGM;
   uint8_t m_voice;

   uint64_t m_modelMainWeapon;
   uint64_t m_modelSubWeapon;
   uint64_t m_modelSystemWeapon;

   uint32_t m_modelEquip[10];

   uint8_t m_emoteModeType;

   // timestamp of first login
   uint32_t m_firstLogin;

   // id of initial language
   uint32_t m_language;

   bool m_bNewGame;

   uint32_t m_primaryTerritoryType;
   uint32_t m_primaryTerritoryId;
   uint32_t m_primaryLayoutId;
   uint32_t m_primaryExclusiveId;
   uint32_t m_primaryMoveType;
   uint32_t m_primaryContentId;

   uint32_t m_secondaryTerritoryType;
   uint32_t m_secondaryTerritoryId;
   Common::FFXIVARR_POSITION3 m_secondaryPos;
   float m_secondaryRot;
   uint32_t m_secondaryLayoutId;
   // !! END CHARABASE

   // ==== CHARADETAIL
   uint8_t m_guardianDeity;
   uint8_t m_birthDay;
   uint8_t m_birthMonth;

   struct RetainerInfo
   {
      uint32_t retainerId;
      char retainerName[32];
      uint32_t createUnixTime;
      bool isActive;
      bool isRename;
      uint8_t status;
   } m_retainerInfo[8];

   uint8_t m_titleList[32];
   uint8_t m_achievement[16];
   uint8_t m_howTo[33];
   uint8_t m_homePoint;
   uint8_t m_startTown;
   uint8_t m_favoritePoint[3];
   uint16_t m_townWarpFstFlags;
   uint8_t m_questCompleteFlags[200];
   uint8_t m_chocoboTaxiStandFlags[8];
   uint8_t m_discovery[420];
   uint32_t m_playTime;

   uint16_t m_classArray[25];
   uint32_t m_expArray[25];
   uint8_t m_aetheryte[16];
   uint8_t m_unlocks[64];

   InventoryPtr m_pInventory;
   std::map< uint32_t, Event::EventPtr > m_eventMap;
   std::map< uint32_t, uint8_t > m_playerIdToSpawnIdMap; // maps player to spawn id
   std::queue< uint8_t > m_freeSpawnIdQueue; // queue with spawn ids free to be assigned
   std::queue< uint8_t > m_freeHateSlotQueue; // queue with "hate slots" free to be assigned
   std::map< uint32_t, uint8_t > m_actorIdTohateSlotMap;
   std::map< uint32_t, uint16_t > m_questIdToQuestIdx; // quest mapping, quest id to quest container index
   std::map< uint16_t, uint32_t > m_questIdxToQuestId; // quest mapping, quest container index to questId
   std::queue< uint8_t > m_freeQuestIdxQueue; // queue with quest indices free to be assigned
   boost::shared_ptr< Common::QuestActive > m_activeQuests[30];
   int16_t m_questTracking[5];
   uint8_t m_stateFlags[7];
   uint8_t m_userLevel;
   uint16_t zoneId;
   bool m_bFirstLogin;
   bool m_bInCombat;
   bool m_bLoadingComplete;
   bool m_bAutoattack;

   Common::ZoneingType m_zoningType;
      
   bool m_bMarkedForZoning;
   uint32_t m_updateFlags;
   bool m_bNewAdventurer;
   uint64_t m_onlineStatus;
   boost::shared_ptr< QueuedZoning > m_queuedZoneing;

   // search info
   char m_searchMessage[193]; // searchmessage to show in profile
   uint8_t m_searchSelectRegion; // regions selected to show up in profile
   uint8_t m_searchSelectClass; // class selected to show up in profile

   // gc info
   uint8_t m_gc;
   uint8_t m_gcRank[3];

};

}
}

#endif