Fission FSN
Loading...
Searching...
No Matches
gfCConversationGui.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: gfCConversationGui.h
4*
5* Purpose: Character dialog Gui
6*
7*********************************************************************/
8
9#ifndef gfCConversationGuihdr
10#define gfCConversationGuihdr
11
12#include <string>
13#include <vector>
14
15#include <fsCore/fsRect.h>
17
18class fsINode;
19
20
22{
23 friend class fsCComponentFactory;
24
25public:
26
27 static const fsCUniqueId mTypeId;
28
30
31 static fsINode* const conversationCreate(const fsStr& pConversationKey);
32 static fsBool conversationExists(const fsStr& pConversationName);
33
34 // Genre cores register how to resolve the player's chosen character
35 // sex, used to pick M/F portrait art. Defaults to false (female) if
36 // never registered.
37 static void playerIsMaleProviderSet(fsBool (*pProvider)());
38
39 void listenersRegisterDo() override;
40 void listenersDeregisterDo() override;
41 fsBool messageProcessDo(const fsCUniqueId& pMessageType,
42 const fsIMessageDispatcher::sMessageParameters& pParam) override;
43
44protected:
45
46 void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
47
48 void updateDo(fsS32 pDeltaMs) override;
49
50 fsBool onButtonClicked(fsCButtonComponent* pButtonComp) override;
51 static fsIComponent* create(fsCEntity* pParent);
52
54 virtual ~gfCConversationGui();
55
56private:
57
58 class fsCMonologue
59 {
60 public:
61 fsCMonologue(fsStr pText, fsITextSpriteComponent* pTextComponent, fsBool pTeleprompt, fsRect pTextBoxRect);
62 fsCMonologue() : mCurrentWord(0), mTextComponent(nullptr) {}
63
64 fsBool isFinished() const { return mCurrentWord >= mWords.size(); }
65 void finish();
66 void updateText(fsS32 pDeltaMs);
67
68 private:
69 void fixedLineLayoutBuild(fsRect pTextBoxRect);
70 void textSet(fsS32 pWordCount);
71
72 fsF32 mCurrentWord;
73 std::vector<std::string> mWords;
74 std::vector<fsS32> mLineWordCounts;
75 fsITextSpriteComponent* mTextComponent;
76 };
77
78 struct fsSConversationKeyInfo
79 {
80 fsStr mCharacterName;
81 fsS32 mCharacterID = 0;
82 fsStr mOutfitName;
83 fsStr mEmotionName;
84 fsBool mPortraitFacingSet = false;
85 fsBool mPortraitFacingRight = false;
86 };
87
88 struct fsSConversationCharacterSlot
89 {
90 fsStr mCharacterName;
91 fsBool mRightHandSide = false;
92 };
93
94
95 // scene-name-(pre/post)(characterID)(monologueID) parkOffice-prec4m1
96 // scene-name-(pre/post)-(characterName)-(outfit)-(portraitName)-(monologueID) parkOffice-pre-emily-outfit1-happyL-m1
97 struct fsCMonologueKey {
98 fsCMonologueKey(const fsStr& pKey) : mKey(pKey) {}
99 fsBool monologueKeyMatch(fsS32 pMonologueID) const;
100 fsSConversationKeyInfo infoGet(const fsStr& pConversationName) const;
101 fsStr mKey;
102 };
103
104 fsBool portraitFirstExistingFind(
105 fsStr& pPortraitPath,
106 const std::vector<fsStr>& pBasePaths,
107 fsBool pUsePlayerSex) const;
108
109 static const fsStr mPlayer1NameKey;
110 fsStr& playerNameReplace(fsStr& pDialogue);
111
112 void conversationContinue();
113 void conversationAdvance();
114
115 const fsCMonologueKey* const currentConversationMonologue() const;
116
117 fsRect textBoxScale(const fsStr& pDialogue);
118 void mugShotUpdate(const fsCMonologueKey* const pKey);
119 void mugDirectionAlternate(const fsCMonologueKey* const pKey);
120 fsBool portraitRightHandSideGet(const fsSConversationKeyInfo& pKeyInfo);
121 fsBool portraitPathFind(fsStr& pPortraitPath, const fsSConversationKeyInfo& pKeyInfo, fsBool& pRightHandSide);
122 fsCEntity* mugShotEntityGet(fsBool pRightHandSide, fsBool& pUsesSharedMugShot) const;
123 void mugShotsHide() const;
124 void sharedMugShotPositionSet(fsCEntity* pMugShotEntity, fsBool pRightHandSide);
125 fsBool characterSlotRightHandSideGet(const fsStr& pCharacterName, fsBool pPreferredRightHandSide);
126 fsBool portraitResourceFind(fsStr& pPortraitPath, const fsStr& pBasePath) const;
127 fsBool portraitResourceFind(fsStr& pPortraitPath, const fsStr& pBasePath, fsBool pUsePlayerSex) const;
128
130
131
132 std::vector<fsCMonologueKey> mConversationKeys;
133 std::vector<fsSConversationCharacterSlot> mConversationCharacterSlots;
134
135 fsCMonologue mCurrentMonologue;
136
137 fsStr mConversationName;
138 fsS32 mMonologueID;
139 fsStr mLastUsedCharacterName;
140 fsBool mRightHandSide;
141 fsS32 mMugShotSlotX;
142
143 fsS32 mSmallTrigger;
144
145 fsS32 mSmallPosY;
146 fsS32 mSmallWidth;
147 fsS32 mSmallHeight;
148 fsStr mSmallBg;
149
150 fsS32 mNormalPosY;
151 fsS32 mNormalWidth;
152 fsS32 mNormalHeight;
153 fsStr mNormalBg;
154};
155
156#endif
Definition fsCButtonComponent.h:27
Definition fsCEntity.h:39
Definition fsCUniqueId.h:21
Definition fsCVariableTable.h:27
fsIComponent(fsCEntity *pParent)
Definition fsIComponent.cpp:86
fsIMessageListenerGuiComponent(fsCEntity *pParent, fsS32 pPriority)
Definition fsIMessageListenerGuiComponent.cpp:4
Definition fsINode.h:30
Definition fsITextSpriteComponent.h:22
Definition fsRect.h:16
Definition fsStr.h:23
fsBool messageProcessDo(const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Definition gfCConversationGui.cpp:416
static fsIComponent * create(fsCEntity *pParent)
Definition gfCConversationGui.cpp:941
void initialiseFromVariableTableDo(const fsCVariableTable &pVars) override
Definition gfCConversationGui.cpp:920
static fsINode *const conversationCreate(const fsStr &pConversationKey)
Definition gfCConversationGui.cpp:435
friend class fsCComponentFactory
Definition gfCConversationGui.h:23
void updateDo(fsS32 pDeltaMs) override
Definition gfCConversationGui.cpp:398
fsBool onButtonClicked(fsCButtonComponent *pButtonComp) override
Definition gfCConversationGui.cpp:456
void listenersRegisterDo() override
Definition gfCConversationGui.cpp:404
static fsBool conversationExists(const fsStr &pConversationName)
Definition gfCConversationGui.cpp:469
void listenersDeregisterDo() override
Definition gfCConversationGui.cpp:410
static const fsCUniqueId mTypeId
Definition gfCConversationGui.h:27
gfCConversationGui(fsCEntity *pParent)
Definition gfCConversationGui.cpp:946
static void playerIsMaleProviderSet(fsBool(*pProvider)())
Definition gfCConversationGui.cpp:152
virtual ~gfCConversationGui()
Definition gfCConversationGui.cpp:965
static const fsCUniqueId mConversationCompleteMsg
Definition gfCConversationGui.h:29
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
float fsF32
Definition fsBaseTypes.h:28
Definition fsIMessageDispatcher.h:32