mirror of
https://github.com/SapphireServer/Sapphire.git
synced 2025-04-26 22:37:45 +00:00
Slight reformatting
This commit is contained in:
Mordred
parent
7b0c0b7de3
commit
e9d0b67354
1 changed files with 172 additions and 175 deletions
|
|
@ -19,186 +19,183 @@ namespace Sapphire::Data
|
|||
|
||||
namespace Sapphire::World::Manager
|
||||
{
|
||||
/*!
|
||||
\class TerritoryMgr_c
|
||||
\brief A class managing zones
|
||||
/*!
|
||||
\class TerritoryMgr_c
|
||||
\brief A class managing zones
|
||||
|
||||
This class manages persistent and temporary instances alike.
|
||||
This class manages persistent and temporary instances alike.
|
||||
|
||||
*/
|
||||
class TerritoryMgr
|
||||
{
|
||||
|
||||
public:
|
||||
enum TerritoryIntendedUse :
|
||||
uint8_t //TODO: Add the rest of the territory types and have better names for them
|
||||
*/
|
||||
class TerritoryMgr
|
||||
{
|
||||
Town = 0,
|
||||
OpenWorld = 1,
|
||||
Inn = 2,
|
||||
Dungeon = 3,
|
||||
JailArea = 5,
|
||||
OpeningArea = 6,
|
||||
BeforeTrialDung = 7,
|
||||
AllianceRaid = 8,
|
||||
OpenWorldInstanceBattle = 9,
|
||||
Trial = 10,
|
||||
HousingArea = 13,
|
||||
HousingPrivateArea = 14,
|
||||
MSQPrivateArea = 15,
|
||||
Raids = 16,
|
||||
RaidFights = 17,
|
||||
ChocoboTutorial = 21,
|
||||
Wedding = 22,
|
||||
BeginnerTutorial = 27,
|
||||
FreeCompanyGarrison = 30,
|
||||
PalaceOfTheDead = 31,
|
||||
TreasureMapInstance = 33,
|
||||
EventTrial = 36,
|
||||
TheFeastArea = 37,
|
||||
PrivateEventArea = 40,
|
||||
//Eureka = 41, // wat
|
||||
|
||||
public:
|
||||
enum TerritoryIntendedUse : uint8_t //TODO: Add the rest of the territory types and have better names for them
|
||||
{
|
||||
Town = 0,
|
||||
OpenWorld = 1,
|
||||
Inn = 2,
|
||||
Dungeon = 3,
|
||||
JailArea = 5,
|
||||
OpeningArea = 6,
|
||||
BeforeTrialDung = 7,
|
||||
AllianceRaid = 8,
|
||||
OpenWorldInstanceBattle = 9,
|
||||
Trial = 10,
|
||||
HousingArea = 13,
|
||||
HousingPrivateArea = 14,
|
||||
MSQPrivateArea = 15,
|
||||
Raids = 16,
|
||||
RaidFights = 17,
|
||||
ChocoboTutorial = 21,
|
||||
Wedding = 22,
|
||||
BeginnerTutorial = 27,
|
||||
FreeCompanyGarrison = 30,
|
||||
PalaceOfTheDead = 31,
|
||||
TreasureMapInstance = 33,
|
||||
EventTrial = 36,
|
||||
TheFeastArea = 37,
|
||||
PrivateEventArea = 40,
|
||||
//Eureka = 41, // wat
|
||||
};
|
||||
|
||||
TerritoryMgr();
|
||||
|
||||
/*! initializes the territoryMgr */
|
||||
bool init();
|
||||
|
||||
bool createDefaultTerritories();
|
||||
|
||||
bool createHousingTerritories();
|
||||
|
||||
/*! caches TerritoryType details into m_territoryTypeMap */
|
||||
void loadTerritoryTypeDetailCache();
|
||||
|
||||
/*! List of positions for zonelines */
|
||||
void loadTerritoryPositionMap();
|
||||
|
||||
/*! returns true if the given territoryTypeId is in fact a valid zone
|
||||
based on informations in the dats ( checks if an entry in the dats exists trhough cache ) */
|
||||
bool isValidTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns the next available instanceId */
|
||||
uint32_t getNextInstanceId();
|
||||
|
||||
/*! returns true if the territoryType in question is not a persistant zone */
|
||||
bool isInstanceContentTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType in question is not a private zone */
|
||||
bool isPrivateTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType is a default non-instanced zone */
|
||||
bool isDefaultTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType is a housing zone */
|
||||
bool isHousingTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! creates a new instance for a given territoryTypeId */
|
||||
ZonePtr createTerritoryInstance( uint32_t territoryTypeId );
|
||||
|
||||
ZonePtr createInstanceContent( uint32_t contentFinderConditionId );
|
||||
|
||||
ZonePtr createHousingInterior( const Common::LandIdent& landIdent );
|
||||
|
||||
/*! removes instance by instanceId, return true if successful */
|
||||
bool removeTerritoryInstance( uint32_t territoryTypeId );
|
||||
|
||||
/*! returns a ZonePtr to the instance or nullptr if not found */
|
||||
ZonePtr getInstanceZonePtr( uint32_t instanceId ) const;
|
||||
|
||||
/*! returns the cached detail of a territory, nullptr if not found */
|
||||
Data::TerritoryTypePtr getTerritoryDetail( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! loop for processing territory logic, iterating all existing instances */
|
||||
void updateTerritoryInstances( uint32_t currentTime );
|
||||
|
||||
/*! returns a ZonePositionPtr if found, else nullptr */
|
||||
ZonePositionPtr getTerritoryPosition( uint32_t territoryPositionId ) const;
|
||||
|
||||
/*! returns a default Zone by territoryTypeId
|
||||
TODO: Mind multiple instances?! */
|
||||
ZonePtr getZoneByTerritoryTypeId( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns a Zone by landSetId */
|
||||
ZonePtr getZoneByLandSetId( uint32_t landSetId ) const;
|
||||
|
||||
bool movePlayer( uint32_t territoryTypeId, Entity::PlayerPtr pPlayer );
|
||||
|
||||
bool movePlayer( ZonePtr, Entity::PlayerPtr pPlayer );
|
||||
|
||||
/*! returns an instancePtr if the player is still bound to an isntance */
|
||||
ZonePtr getLinkedInstance( uint32_t playerId ) const;
|
||||
|
||||
/*!
|
||||
* @brief Sets the current festival for every zone
|
||||
* @param festivalId A valid festival id from festival.exd
|
||||
* @param additionalFestival A valid festival id from festival.exd, this is shown in addition to the first festival
|
||||
*/
|
||||
void setCurrentFestival( uint16_t festivalId, uint16_t additionalFestival = 0 );
|
||||
|
||||
/*!
|
||||
* @brief Disables the current festival(s) in every zone
|
||||
*/
|
||||
void disableCurrentFestival();
|
||||
|
||||
/*!
|
||||
* @brief Gets the current festival set on the server
|
||||
* @return a pair with the 2 festivals currently active
|
||||
*/
|
||||
const std::pair< uint16_t, uint16_t >& getCurrentFestival() const;
|
||||
|
||||
private:
|
||||
using TerritoryTypeDetailCache = std::unordered_map< uint16_t, Data::TerritoryTypePtr >;
|
||||
using InstanceIdToZonePtrMap = std::unordered_map< uint32_t, ZonePtr >;
|
||||
using LandSetIdToZonePtrMap = std::unordered_map< uint32_t, ZonePtr >;
|
||||
using TerritoryTypeIdToInstanceMap = std::unordered_map< uint16_t, InstanceIdToZonePtrMap >;
|
||||
using InstanceContentIdToInstanceMap = std::unordered_map< uint16_t, InstanceIdToZonePtrMap >;
|
||||
using PlayerIdToInstanceIdMap = std::unordered_map< uint32_t, uint32_t >;
|
||||
using PositionMap = std::unordered_map< int32_t, ZonePositionPtr >;
|
||||
using InstanceIdList = std::vector< uint32_t >;
|
||||
|
||||
/*! map holding details for territory templates */
|
||||
TerritoryTypeDetailCache m_territoryTypeDetailCacheMap;
|
||||
|
||||
/*! map holding actual instances of default territories */
|
||||
TerritoryTypeIdToInstanceMap m_territoryTypeIdToInstanceGuidMap;
|
||||
|
||||
/*! map holding actual instances of default territories */
|
||||
LandSetIdToZonePtrMap m_landSetIdToZonePtrMap;
|
||||
|
||||
/*! map holding actual instances of InstanceContent */
|
||||
InstanceContentIdToInstanceMap m_instanceContentToInstanceMap;
|
||||
|
||||
/*! flat map for easier lookup of instances by guid */
|
||||
InstanceIdToZonePtrMap m_instanceIdToZonePtrMap;
|
||||
|
||||
/*! map holding positions for zonelines */
|
||||
PositionMap m_territoryPositionMap;
|
||||
|
||||
/*! map storing playerIds to instanceIds, used for instanceContent */
|
||||
PlayerIdToInstanceIdMap m_playerIdToInstanceMap;
|
||||
|
||||
/*! internal counter for instanceIds */
|
||||
uint32_t m_lastInstanceId;
|
||||
|
||||
/*! set of ZonePtrs for quick iteration*/
|
||||
std::set< ZonePtr > m_zoneSet;
|
||||
|
||||
/*! set of ZonePtrs for quick iteration*/
|
||||
std::set< ZonePtr > m_instanceZoneSet;
|
||||
|
||||
/*! current festival(s) to set for public zones from festival.exd */
|
||||
std::pair< uint16_t, uint16_t > m_currentFestival;
|
||||
|
||||
public:
|
||||
/*! returns a list of instanceContent InstanceIds currently active */
|
||||
InstanceIdList getInstanceContentIdList( uint16_t instanceContentId ) const;
|
||||
|
||||
};
|
||||
|
||||
TerritoryMgr();
|
||||
|
||||
/*! initializes the territoryMgr */
|
||||
bool init();
|
||||
|
||||
bool createDefaultTerritories();
|
||||
|
||||
bool createHousingTerritories();
|
||||
|
||||
/*! caches TerritoryType details into m_territoryTypeMap */
|
||||
void loadTerritoryTypeDetailCache();
|
||||
|
||||
/*! List of positions for zonelines */
|
||||
void loadTerritoryPositionMap();
|
||||
|
||||
/*! returns true if the given territoryTypeId is in fact a valid zone
|
||||
based on informations in the dats ( checks if an entry in the dats exists trhough cache ) */
|
||||
bool isValidTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns the next available instanceId */
|
||||
uint32_t getNextInstanceId();
|
||||
|
||||
/*! returns true if the territoryType in question is not a persistant zone */
|
||||
bool isInstanceContentTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType in question is not a private zone */
|
||||
bool isPrivateTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType is a default non-instanced zone */
|
||||
bool isDefaultTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns true if the territoryType is a housing zone */
|
||||
bool isHousingTerritory( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! creates a new instance for a given territoryTypeId */
|
||||
ZonePtr createTerritoryInstance( uint32_t territoryTypeId );
|
||||
|
||||
ZonePtr createInstanceContent( uint32_t contentFinderConditionId );
|
||||
|
||||
ZonePtr createHousingInterior( const Common::LandIdent& landIdent );
|
||||
|
||||
/*! removes instance by instanceId, return true if successful */
|
||||
bool removeTerritoryInstance( uint32_t territoryTypeId );
|
||||
|
||||
/*! returns a ZonePtr to the instance or nullptr if not found */
|
||||
ZonePtr getInstanceZonePtr( uint32_t instanceId ) const;
|
||||
|
||||
/*! returns the cached detail of a territory, nullptr if not found */
|
||||
Data::TerritoryTypePtr getTerritoryDetail( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! loop for processing territory logic, iterating all existing instances */
|
||||
void updateTerritoryInstances( uint32_t currentTime );
|
||||
|
||||
/*! returns a ZonePositionPtr if found, else nullptr */
|
||||
ZonePositionPtr getTerritoryPosition( uint32_t territoryPositionId ) const;
|
||||
|
||||
/*! returns a default Zone by territoryTypeId
|
||||
TODO: Mind multiple instances?! */
|
||||
ZonePtr getZoneByTerritoryTypeId( uint32_t territoryTypeId ) const;
|
||||
|
||||
/*! returns a Zone by landSetId */
|
||||
ZonePtr getZoneByLandSetId( uint32_t landSetId ) const;
|
||||
|
||||
bool movePlayer( uint32_t territoryTypeId, Entity::PlayerPtr pPlayer );
|
||||
|
||||
bool movePlayer( ZonePtr, Entity::PlayerPtr pPlayer );
|
||||
|
||||
/*! returns an instancePtr if the player is still bound to an isntance */
|
||||
ZonePtr getLinkedInstance( uint32_t playerId ) const;
|
||||
|
||||
/*!
|
||||
* @brief Sets the current festival for every zone
|
||||
* @param festivalId A valid festival id from festival.exd
|
||||
* @param additionalFestival A valid festival id from festival.exd, this is shown in addition to the first festival
|
||||
*/
|
||||
void setCurrentFestival( uint16_t festivalId, uint16_t additionalFestival = 0 );
|
||||
|
||||
/*!
|
||||
* @brief Disables the current festival(s) in every zone
|
||||
*/
|
||||
void disableCurrentFestival();
|
||||
|
||||
/*!
|
||||
* @brief Gets the current festival set on the server
|
||||
* @return a pair with the 2 festivals currently active
|
||||
*/
|
||||
const std::pair< uint16_t, uint16_t >& getCurrentFestival() const;
|
||||
|
||||
private:
|
||||
using TerritoryTypeDetailCache = std::unordered_map< uint16_t, Data::TerritoryTypePtr >;
|
||||
using InstanceIdToZonePtrMap = std::unordered_map< uint32_t, ZonePtr >;
|
||||
using LandSetIdToZonePtrMap = std::unordered_map< uint32_t, ZonePtr >;
|
||||
using TerritoryTypeIdToInstanceMap = std::unordered_map< uint16_t, InstanceIdToZonePtrMap >;
|
||||
using InstanceContentIdToInstanceMap = std::unordered_map< uint16_t, InstanceIdToZonePtrMap >;
|
||||
using PlayerIdToInstanceIdMap = std::unordered_map< uint32_t, uint32_t >;
|
||||
using PositionMap = std::unordered_map< int32_t, ZonePositionPtr >;
|
||||
using InstanceIdList = std::vector< uint32_t >;
|
||||
|
||||
/*! map holding details for territory templates */
|
||||
TerritoryTypeDetailCache m_territoryTypeDetailCacheMap;
|
||||
|
||||
/*! map holding actual instances of default territories */
|
||||
TerritoryTypeIdToInstanceMap m_territoryTypeIdToInstanceGuidMap;
|
||||
|
||||
/*! map holding actual instances of default territories */
|
||||
LandSetIdToZonePtrMap m_landSetIdToZonePtrMap;
|
||||
|
||||
/*! map holding actual instances of InstanceContent */
|
||||
InstanceContentIdToInstanceMap m_instanceContentToInstanceMap;
|
||||
|
||||
/*! flat map for easier lookup of instances by guid */
|
||||
InstanceIdToZonePtrMap m_instanceIdToZonePtrMap;
|
||||
|
||||
/*! map holding positions for zonelines */
|
||||
PositionMap m_territoryPositionMap;
|
||||
|
||||
/*! map storing playerIds to instanceIds, used for instanceContent */
|
||||
PlayerIdToInstanceIdMap m_playerIdToInstanceMap;
|
||||
|
||||
/*! internal counter for instanceIds */
|
||||
uint32_t m_lastInstanceId;
|
||||
|
||||
/*! set of ZonePtrs for quick iteration*/
|
||||
std::set< ZonePtr > m_zoneSet;
|
||||
|
||||
/*! set of ZonePtrs for quick iteration*/
|
||||
std::set< ZonePtr > m_instanceZoneSet;
|
||||
|
||||
/*! current festival(s) to set for public zones from festival.exd */
|
||||
std::pair< uint16_t, uint16_t > m_currentFestival;
|
||||
|
||||
|
||||
|
||||
public:
|
||||
/*! returns a list of instanceContent InstanceIds currently active */
|
||||
InstanceIdList getInstanceContentIdList( uint16_t instanceContentId ) const;
|
||||
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
#endif // SAPPHIRE_TERRITORYMGR_H
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue