gfCLockComponent Class Reference

#include <gfCLockComponent.h>

Inheritance diagram for gfCLockComponent:

Public Member Functions
void	smash ()
fsBool	lockedGet () const
fsBool	keyConsumed (fsCEntity *pKeyEnt, fsCEntity *pDragDropEnt)
fsBool	keyUsable (fsCEntity *pKeyEnt)
fsBool	keyConsumable (fsCEntity *pKeyEnt, fsCEntity *pDragDropEnt)
fsBool	keyOver (fsCEntity *pDragDropEnt)
Public Member Functions inherited from gfCTappableCollectableComponent
void	touchHitSpriteStore ()
virtual	~gfCTappableCollectableComponent ()
Public Member Functions inherited from gfICollectableComponent
fsBool	playCollectedSFX ()
void	collectionShortCircuit ()
void	collectionProcessTrigger ()
void	visiblePostCollectionSet (const fsStr &pPostCollectionMarkerFile)
void	deactivate ()
void	activate ()
fsBool	collectionEffectPlayingGet () const
fsBool	isInactivatedGet () const
fsBool	hasBeenCollectedGet () const
Public Member Functions inherited from fsIMessageListenerComponent
	fsIMessageListenerComponent (fsCEntity *pParent)
	fsIMessageListenerComponent (fsCEntity *pParent, fsS32 pPriority)
virtual	~fsIMessageListenerComponent ()
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 ()
Public Member Functions inherited from fsITutorialEnabledComponent
void	tutorialCompleted (const fsPoint &pPos)

Static Public Attributes
static const fsCUniqueId	mTypeId
static const fsStr	mEntityPrefix
Static Public Attributes inherited from gfCTappableCollectableComponent
static const fsCUniqueId	mTypeId
Static Public Attributes inherited from gfICollectableComponent
static const fsCUniqueId	mCollectionStartMsg
static const fsCUniqueId	mCollectionEndMsg
static const fsCUniqueId	mLevelSkipForceCollectMsg

Protected Member Functions
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	midCollectionHandle () override
void	serialiseDo () override
void	deserialiseDo () override
void	deactivateDo () override
void	collectionProcessTriggerDo () override
	gfCLockComponent (fsCEntity *pParent)
virtual	~gfCLockComponent ()
Protected Member Functions inherited from gfCTappableCollectableComponent
virtual fsBool	collectable () const
virtual fsBool	hitTestAndCollect (const fsPoint &pPointerPos)
virtual fsBool	hitTest (const fsPoint &pPointerPos)
void	deserialiseDo () override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	inputStealDo () override
void	activateDo () override
void	deactivateDo () override
	gfCTappableCollectableComponent (fsCEntity *pParent)
Protected Member Functions inherited from gfICollectableComponent
void	stateSet (eCOLLECTION_STATE pState)
eCOLLECTION_STATE	stateGet () const
virtual fsBool	inInactivatedGetDo () const
void	tutorialCompletedDo (const fsPoint &pPos) override
void	serialiseDo () override
void	deserialiseDo () override
void	resetDo () override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
	gfICollectableComponent (fsCEntity *pParent)
virtual	~gfICollectableComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	updateDo (fsS32 pDeltaMs)
virtual void	renderDo ()
virtual void	matrixApplyDo ()
virtual void	postLoadDo ()
virtual void	initialiseFromVariableTableDo (const fsCVariableTable &pVars)
virtual void	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)
Protected Member Functions inherited from fsIMessageListener
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()
Protected Member Functions inherited from fsITutorialEnabledComponent
	fsITutorialEnabledComponent ()
virtual	~fsITutorialEnabledComponent ()

Static Protected Member Functions
static fsIComponent *	create (fsCEntity *pParent)
Static Protected Member Functions inherited from gfCTappableCollectableComponent
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 gfICollectableComponent
static void	extraPersistentTagCheckProviderSet (fsBool(*pProvider)(fsCEntity *const pEntity))
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)
Static Public Member Functions inherited from fsITutorialEnabledComponent
static fsStr	associatedEntityNameGet (fsCEntity *pEnt)
Protected Types inherited from gfICollectableComponent
enum struct	eCOLLECTION_STATE { eINACTIVE = 0 , eCOLLECTIBLE , eCOLLECTED_EFFECT_PLAYING , eCOLLECTED_EFFECT_FINISHED }
Protected Attributes inherited from gfCTappableCollectableComponent
fsBool	mTakingInput
fsISpriteComponent *	mTouchHitSprite
gfCGhostSpriteComponent *	mGhostSpriteComp
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Constructor & Destructor Documentation

gfCLockComponent()

gfCLockComponent::gfCLockComponent ( fsCEntity * pParent )

protected

~gfCLockComponent()

gfCLockComponent::~gfCLockComponent ( )

protectedvirtual

Member Function Documentation

collectionProcessTriggerDo()

void gfCLockComponent::collectionProcessTriggerDo ( )

overrideprotectedvirtual

Reimplemented from gfICollectableComponent.

create()

fsIComponent * gfCLockComponent::create ( fsCEntity * pParent )

staticprotected

deactivateDo()

void gfCLockComponent::deactivateDo ( )

overrideprotectedvirtual

Reimplemented from gfICollectableComponent.

deserialiseDo()

void gfCLockComponent::deserialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

keyConsumable()

fsBool gfCLockComponent::keyConsumable	(	fsCEntity *	pKeyEnt,
		fsCEntity *	pDragDropEnt )

keyConsumed()

fsBool gfCLockComponent::keyConsumed	(	fsCEntity *	pKeyEnt,
		fsCEntity *	pDragDropEnt )

keyOver()

fsBool gfCLockComponent::keyOver

(

fsCEntity *

pDragDropEnt

)

keyUsable()

fsBool gfCLockComponent::keyUsable

(

fsCEntity *

pKeyEnt

)

listenersDeregisterDo()

void gfCLockComponent::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfCLockComponent::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

lockedGet()

fsBool gfCLockComponent::lockedGet

(

)

const

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

midCollectionHandle()

void gfCLockComponent::midCollectionHandle ( )

overrideprotectedvirtual

Reimplemented from gfICollectableComponent.

serialiseDo()

void gfCLockComponent::serialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

smash()

void gfCLockComponent::smash

(

)

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mEntityPrefix

const fsStr gfCLockComponent::mEntityPrefix

static

mTypeId

const fsCUniqueId gfCLockComponent::mTypeId

static

---

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

• /home/runner/work/fission/fission/gameModules/gfComponents/components/gfCLockComponent.h
• /home/runner/work/fission/fission/gameModules/gfComponents/components/gfCLockComponent.cpp