2021-12-05 17:54:36 +00:00
# pragma once
2022-03-29 02:58:50 +00:00
# include <map>
# include "Component.h"
2021-12-05 17:54:36 +00:00
# include "Entity.h"
# include "EntityManager.h"
# include "GameMessages.h"
/**
* Represents the launch pad that ' s used to select and browse properties
*/
2022-03-29 02:58:50 +00:00
class PropertyEntranceComponent : public Component {
2022-07-28 13:39:57 +00:00
public :
static const uint32_t ComponentType = COMPONENT_TYPE_PROPERTY_ENTRANCE ;
explicit PropertyEntranceComponent ( uint32_t componentID , Entity * parent ) ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* Handles an OnUse request for some other entity , rendering the property browse menu
* @ param entity the entity that triggered the event
*/
void OnUse ( Entity * entity ) override ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* Handles the event triggered when the entity selects a property to visit and makes the entity to there
* @ param entity the entity that triggered the event
* @ param index the index of the property property
* @ param returnToZone whether or not the entity wishes to go back to the launch zone
* @ param sysAddr the address to send gamemessage responses to
*/
void OnEnterProperty ( Entity * entity , uint32_t index , bool returnToZone , const SystemAddress & sysAddr ) ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* Handles a request for information on available properties when an entity lands on the property
* @ param entity the entity that triggered the event
* @ param includeNullAddress unused
* @ param includeNullDescription unused
* @ param playerOwn only query properties owned by the entity
* @ param updateUi unused
* @ param numResults unused
* @ param lReputationTime unused
* @ param sortMethod unused
* @ param startIndex the minimum index to start the query off
* @ param filterText property names to search for
* @ param sysAddr the address to send gamemessage responses to
*/
void OnPropertyEntranceSync ( Entity * entity , bool includeNullAddress , bool includeNullDescription , bool playerOwn , bool updateUi , int32_t numResults , int32_t lReputationTime , int32_t sortMethod , int32_t startIndex , std : : string filterText , const SystemAddress & sysAddr ) ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* Returns the name of this property
* @ return the name of this property
*/
[ [ nodiscard ] ] std : : string GetPropertyName ( ) const { return m_PropertyName ; } ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* Returns the map ID for this property
* @ return the map ID for this property
*/
[ [ nodiscard ] ] LWOMAPID GetMapID ( ) const { return m_MapID ; } ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
PropertySelectQueryProperty SetPropertyValues ( PropertySelectQueryProperty property , LWOCLONEID cloneId = LWOCLONEID_INVALID , std : : string ownerName = " " , std : : string propertyName = " " , std : : string propertyDescription = " " , float reputation = 0 , bool isBFF = false , bool isFriend = false , bool isModeratorApproved = false , bool isAlt = false , bool isOwned = false , uint32_t privacyOption = 0 , uint32_t timeLastUpdated = 0 , float performanceCost = 0.0f ) ;
2022-03-29 02:58:50 +00:00
2022-07-28 13:39:57 +00:00
std : : string BuildQuery ( Entity * entity , int32_t sortMethod , Character * character , std : : string customQuery = " " , bool wantLimits = true ) ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
private :
/**
* Cache of property information that was queried for property launched , indexed by property ID
*/
std : : map < LWOOBJID , std : : vector < PropertySelectQueryProperty > > propertyQueries ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* The custom name for this property
*/
std : : string m_PropertyName ;
2021-12-05 17:54:36 +00:00
2022-07-28 13:39:57 +00:00
/**
* The base map ID for this property ( Avant Grove , etc ) .
*/
LWOMAPID m_MapID ;
2022-03-28 03:04:45 +00:00
2022-07-28 13:39:57 +00:00
enum ePropertySortType : int32_t {
SORT_TYPE_FRIENDS = 0 ,
SORT_TYPE_REPUTATION = 1 ,
SORT_TYPE_RECENT = 3 ,
SORT_TYPE_FEATURED = 5
} ;
2022-03-29 02:58:50 +00:00
2022-07-28 13:39:57 +00:00
std : : string baseQueryForProperties = " SELECT p.* FROM properties as p JOIN charinfo as ci ON ci.prop_clone_id = p.clone_id where p.zone_id = ? AND (p.description LIKE ? OR p.name LIKE ? OR ci.name LIKE ?) AND p.privacy_option >= ? " ;
2021-12-05 17:54:36 +00:00
} ;