gfCConversationGui.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCConversationGui.h
*
*       Purpose:        Character dialog Gui
*
*********************************************************************/
 
#ifndef gfCConversationGuihdr
#define gfCConversationGuihdr
 
#include <string>
#include <vector>
 
#include <fsAppCore/src/components/gui/fsIMessageListenerGuiComponent.h>
 
class fsINode;
 
 
class gfCConversationGui : public fsIMessageListenerGuiComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        static const fsCUniqueId mConversationCompleteMsg;
 
        static fsINode* const conversationCreate(const fsStr& pConversationKey);
        static fsBool conversationExists(const fsStr& pConversationName);
 
        // Genre cores register how to resolve the player's chosen character
        // sex, used to pick M/F portrait art. Defaults to false (female) if
        // never registered.
        static void playerIsMaleProviderSet(fsBool (*pProvider)());
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
protected:
 
        void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
 
        void updateDo(fsS32 pDeltaMs) override;
 
        fsBool onButtonClicked(fsCButtonComponent* pButtonComp) override;
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCConversationGui(fsCEntity* pParent);
        virtual ~gfCConversationGui();
 
private:
 
        class fsCMonologue
        {
        public:
                fsCMonologue(fsStr pText, fsITextSpriteComponent* pTextComponent, fsBool pTeleprompt, fsS32 pTextBoxWidth);
                fsCMonologue() : mCurrentWord(0), mTextComponent(nullptr) {}
 
                fsBool isFinished() const { return mCurrentWord >= mWords.size(); }
                void finish();
                void updateText(fsS32 pDeltaMs);
 
        private:
                void fixedLineLayoutBuild(fsS32 pTextBoxWidth);
                void textSet(fsS32 pWordCount);
 
                fsF32 mCurrentWord;
                std::vector<std::string> mWords;
                std::vector<fsS32> mLineWordCounts;
                fsITextSpriteComponent* mTextComponent;
        };
 
        struct fsSConversationKeyInfo
        {
                fsStr mCharacterName;
                fsS32 mCharacterID = 0;
                fsStr mOutfitName;
                fsStr mEmotionName;
                fsBool mPortraitFacingSet = false;
                fsBool mPortraitFacingRight = false;
        };
 
        struct fsSConversationCharacterSlot
        {
                fsStr mCharacterName;
                fsBool mRightHandSide = false;
        };
 
 
        // scene-name-(pre/post)(characterID)(monologueID)                              parkOffice-prec4m1
        // scene-name-(pre/post)-(characterName)-(outfit)-(portraitName)-(monologueID)  parkOffice-pre-emily-outfit1-happyL-m1
        struct fsCMonologueKey {
                fsCMonologueKey(const fsStr& pKey) : mKey(pKey) {}
                fsBool monologueKeyMatch(fsS32 pMonologueID) const;
                fsSConversationKeyInfo infoGet(const fsStr& pConversationName) const;
                fsStr mKey;
        };
 
        fsBool portraitFirstExistingFind(
                fsStr& pPortraitPath,
                const std::vector<fsStr>& pBasePaths,
                fsBool pUsePlayerSex) const;
 
        static const fsStr mPlayer1NameKey;
        fsStr& playerNameReplace(fsStr& pDialogue);
 
        void conversationContinue();
        void conversationAdvance();
 
        const fsCMonologueKey* const currentConversationMonologue() const;
 
        fsS32 textBoxScale(const fsStr& pDialogue);
        void mugShotUpdate(const fsCMonologueKey* const pKey);
        void mugDirectionAlternate(const fsCMonologueKey* const pKey);
        fsBool portraitRightHandSideGet(const fsSConversationKeyInfo& pKeyInfo);
        fsBool portraitPathFind(fsStr& pPortraitPath, const fsSConversationKeyInfo& pKeyInfo, fsBool& pRightHandSide);
        fsCEntity* mugShotEntityGet(fsBool pRightHandSide, fsBool& pUsesSharedMugShot) const;
        void mugShotsHide() const;
        void sharedMugShotPositionSet(fsCEntity* pMugShotEntity, fsBool pRightHandSide);
        fsBool characterSlotRightHandSideGet(const fsStr& pCharacterName, fsBool pPreferredRightHandSide);
        fsBool portraitResourceFind(fsStr& pPortraitPath, const fsStr& pBasePath) const;
        fsBool portraitResourceFind(fsStr& pPortraitPath, const fsStr& pBasePath, fsBool pUsePlayerSex) const;
 
        gfCConversationGui();
 
 
        std::vector<fsCMonologueKey> mConversationKeys;
        std::vector<fsSConversationCharacterSlot> mConversationCharacterSlots;
 
        fsCMonologue mCurrentMonologue;
 
        fsStr mConversationName;
        fsS32 mMonologueID;
        fsStr mLastUsedCharacterName;
        fsBool mRightHandSide;
        fsS32 mMugShotSlotX;
 
        fsS32 mSmallTrigger;
 
        fsS32 mSmallPosY;
        fsS32 mSmallWidth;
        fsS32 mSmallHeight;
        fsStr mSmallBg;
 
        fsS32 mNormalPosY;
        fsS32 mNormalWidth;
        fsS32 mNormalHeight;
        fsStr mNormalBg;
};
 
#endif