fsCGameGui Class Reference

#include <gfCGameGui.h>

Inheritance diagram for fsCGameGui:

Public Member Functions
void	delayButtonsInitialise ()
fsBool	hintActivate (fsCEntity *pStartEnt, fsCEntity *pEndEnt)
fsBool	hintActivate (std::vector< fsCEntity * > &pCandidates)
fsBool	miniGameSkipGet () const
void	minigameSkip ()
Public Member Functions inherited from fsIGuiComponent
template<typename TComponent>
TComponent *	siblingEntityComponentGet () const
template<typename TComponent>
TComponent *	siblingEntityFamilyComponentGet () const
void	listenerComponentsRegister (fsCEntity *const pRoot) const
void	listenerComponentsDeRegister (fsCEntity *const pRoot) const
Public Member Functions inherited from fsIComponent
template<typename TInterface>
std::vector< fsCEntity * >	appSceneEntitiesWithComponentOfFamilyType () const
template<typename TInterface>
fsCEntity *	appSceneFirstEntityWithComponentOfFamilyType () const
fsCEntity *	appSceneEntityNamed (const fsStr &pName) const
void	reset ()
void	update (fsS32 pDeltaMs)
void	render ()
void	matrixApply ()
void	postLoad ()
void	deserialise ()
void	serialise ()
void	initialiseFromVariableTable (const fsCVariableTable &pVars)
void	initialise ()
void	finalise ()
fsCEntity *	parentGet () const
fsCEntity *	grandparentGet () const
Public Member Functions inherited from fsIMessageListener
void	listenersRegister ()
void	listenersDeregister ()
void	prioritySet (fsS32 pPriority)
fsBool	messageProcess (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam)
void	inputSteal ()

Static Public Attributes
static const fsCUniqueId	mTypeId
static const fsCUniqueId	mHintButtonPressedMsg
static const fsStr	mPlayerControlledContinueButtonName

Protected Member Functions
void	renderDo () override
void	updateDo (fsS32 pDeltaMs) override
void	postLoadDo () override
void	listenersDeregisterDo () override
void	listenersRegisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
fsBool	onButtonClicked (fsCButtonComponent *pButtonComp) override
	fsCGameGui (fsCEntity *pParent)
virtual	~fsCGameGui ()
Protected Member Functions inherited from fsIMessageListenerGuiComponent
	fsIMessageListenerGuiComponent (fsCEntity *pParent, fsS32 pPriority)
	fsIMessageListenerGuiComponent (fsCEntity *pParent)
virtual	~fsIMessageListenerGuiComponent ()
Protected Member Functions inherited from fsIGuiComponent
void	layoutFileProcess ()
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsIGuiComponent (fsCEntity *pParent)
virtual	~fsIGuiComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
virtual void	matrixApplyDo ()
virtual void	deserialiseDo ()
virtual void	serialiseDo ()
virtual void	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)
Protected Member Functions inherited from fsIMessageListener
virtual void	inputStealDo ()
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()

Static Protected Member Functions
static fsIComponent *	create (fsCEntity *pParent)

Friends
class	fsCComponentFactory

Additional Inherited Members
Public Types inherited from fsIMessageListener
enum	{   ePRIORITY_NORMAL = 0 , ePRIORITY_DEBUG_WINDOW , ePRIORITY_SOFTWARE_CURSOR , ePRIORITY_TEXT_ENTRY ,   ePRIORITY_DEBUG_MODAL , ePRIORITY_DEBUG_MODAL_BUTTON }
Static Public Member Functions inherited from fsIGuiComponent
static void	flush ()
static fsCEntity *	guiCreateFromCommands (fsStr &pCommands, fsCEntity *pParent=nullptr, fsBool pModal=true, fsBool pNewGrammarMode=false)
static fsCEntity *	guiCreateFromFile (const fsCResourceName &pGuiLayoutFileName, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsCGuiParseTree	parseToTree (fsStr &pCommands, fsBool pNewGrammarMode=false)
static fsCEntity *	constructFromTree (const fsCGuiParseTree &pTree, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsBool	newGrammarFileNameResolve (const fsStr &pLegacyFileName, fsStr &pOutResolvedFileName)
static fsIGuiComponent *	guiParentGetFromComponent (const fsIComponent *pComponent)
static fsBool	entityHasGuiComponentGet (const fsINode *pNode)
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Constructor & Destructor Documentation

fsCGameGui()

fsCGameGui::fsCGameGui ( fsCEntity * pParent )

protected

~fsCGameGui()

fsCGameGui::~fsCGameGui ( )

protectedvirtual

Member Function Documentation

create()

fsIComponent * fsCGameGui::create ( fsCEntity * pParent )

staticprotected

delayButtonsInitialise()

void fsCGameGui::delayButtonsInitialise

(

)

hintActivate() [1/2]

fsBool fsCGameGui::hintActivate	(	fsCEntity *	pStartEnt,
		fsCEntity *	pEndEnt )

hintActivate() [2/2]

fsBool fsCGameGui::hintActivate

(

std::vector< fsCEntity * > &

pCandidates

)

initialiseFromVariableTableDo()

void fsCGameGui::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

listenersDeregisterDo()

void fsCGameGui::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void fsCGameGui::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

fsBool fsCGameGui::messageProcessDo ( const fsCUniqueId & pMessageType, const fsIMessageDispatcher::sMessageParameters & pParam )

overrideprotectedvirtual

Implements fsIMessageListener.

minigameSkip()

void fsCGameGui::minigameSkip

(

)

miniGameSkipGet()

fsBool fsCGameGui::miniGameSkipGet

(

)

const

onButtonClicked()

fsBool fsCGameGui::onButtonClicked ( fsCButtonComponent * pButtonComp )

overrideprotectedvirtual

Reimplemented from fsIGuiComponent.

postLoadDo()

void fsCGameGui::postLoadDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

renderDo()

void fsCGameGui::renderDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

updateDo()

void fsCGameGui::updateDo ( fsS32 pDeltaMs )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mHintButtonPressedMsg

const fsCUniqueId fsCGameGui::mHintButtonPressedMsg

static

mPlayerControlledContinueButtonName

const fsStr fsCGameGui::mPlayerControlledContinueButtonName

static

mTypeId

const fsCUniqueId fsCGameGui::mTypeId

static

---

The documentation for this class was generated from the following files:

• /home/runner/work/fission/fission/gameModules/gfHogCore/components/gui/gfCGameGui.h
• /home/runner/work/fission/fission/gameModules/gfHogCore/components/gui/gfCGameGui.cpp