gfCParkPlacementComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCParkPlacementComponent.h
*
*       Purpose:        Transient "tycoon build" placement mode. Lives on its own
*                               short-lived entity, spawned by gfCPurchaseActionDecorationPlace
*                               after a decoration is bought. The purchased art follows the
*                               pointer, snaps to the map grid and is tinted red while its
*                               footprint is illegal. A valid tap drops it and destroys the
*                               entity - one placement per purchase.
*
*                               Decorations do not create service slots, but their asset-defined
*                               appeal contributes to the park's visitor demand after placement.
*
*********************************************************************/
 
#ifndef gfCParkPlacementComponenthdr
#define gfCParkPlacementComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsCore/fsStr.h>
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
class fsCEntity;
struct fsPoint;
 
 
class gfCParkPlacementComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        // The decoration art to preview and drop on the next valid grid cell. Called
        // right after componentAdd.
        void placementBegin(const fsStr& pDecorationImage, fsS32 pDrawWidth,
                            fsS32 pFootprintColumns, fsS32 pFootprintRows,
                            fsS32 pItemCost, fsS32 pVisitorAppeal = 0,
                            fsS32 pVisitorComfort = 0);
 
        // Asset-defined service building: the next tap creates a persistent runtime
        // slot at that point instead of a cosmetic decoration. The footprint is in
        // map tiles and controls which grid anchor the placement snaps to.
        void buildingPlacementBegin(const fsStr& pImage, const fsStr& pServiceType,
                                    fsS32 pServiceTimeMs, fsS32 pMaxQueueLength, fsS32 pDrawWidth,
                                    fsS32 pFootprintColumns, fsS32 pFootprintRows,
                                    fsS32 pItemCost, fsS32 pVisitorQuota = 0,
                                    fsS32 pVisitorAppeal = 0);
 
        // Explicitly cancel the current tool when the HUD build toggle is switched
        // off. No cost is charged until a placement actually succeeds.
        void placementEnd();
 
        virtual ~gfCParkPlacementComponent();
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static fsIComponent* const create(fsCEntity* const pParent);
        gfCParkPlacementComponent(fsCEntity* const pParent);
 
private:
 
        void placementPreviewCreate();
        fsBool placementPreviewUpdate(const fsPoint& pScreenPos);
        void placementPreviewDestroy();
 
        enum class eMode
        {
                eDecoration,
                eServiceBuilding
        };
 
        eMode mMode;
        fsStr mDecorationImage;
        fsStr mBuildingServiceType;
        fsS32 mBuildingServiceTimeMs;
        fsS32 mBuildingMaxQueueLength;
        fsS32 mBuildingVisitorQuota;
        fsS32 mBuildingVisitorAppeal;
        fsS32 mDecorationVisitorAppeal;
        fsS32 mDecorationVisitorComfort;
        fsS32 mDrawWidth;
        fsS32 mFootprintColumns;
        fsS32 mFootprintRows;
        fsS32 mItemCost;
        fsCEntity* mPlacementPreviewEntity;
        fsS32 mSnappedLocalX;
        fsS32 mSnappedLocalY;
        fsBool mPlacementValid;
};
 
#endif