gfCTappableCollectableComponent Class Reference

#include <gfCTappableCollectableComponent.h>

Inheritance diagram for gfCTappableCollectableComponent:

Public Member Functions
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 Public Attributes inherited from gfICollectableComponent
static const fsCUniqueId	mCollectionStartMsg
static const fsCUniqueId	mCollectionEndMsg
static const fsCUniqueId	mLevelSkipForceCollectMsg

Protected Member Functions
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 void	midCollectionHandle ()
virtual fsBool	inInactivatedGetDo () const
virtual void	onCollectionEffectCompleteDo ()
virtual void	collectionProcessTriggerDo ()
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)

Protected Attributes
fsBool	mTakingInput
fsISpriteComponent *	mTouchHitSprite
gfCGhostSpriteComponent *	mGhostSpriteComp
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Friends
class	fsCComponentFactory
class	gfCTutorialSequencerComponent

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 }

Constructor & Destructor Documentation

~gfCTappableCollectableComponent()

gfCTappableCollectableComponent::~gfCTappableCollectableComponent ( )

virtual

gfCTappableCollectableComponent()

gfCTappableCollectableComponent::gfCTappableCollectableComponent ( fsCEntity * pParent )

protected

Member Function Documentation

activateDo()

void gfCTappableCollectableComponent::activateDo ( )

overrideprotectedvirtual

Reimplemented from gfICollectableComponent.

collectable()

virtual fsBool gfCTappableCollectableComponent::collectable ( ) const

inlineprotectedvirtual

Reimplemented in gfCGroupCollectableComponent, and gfCTappableCollectableParticleEmitterComponent.

create()

fsIComponent * gfCTappableCollectableComponent::create ( fsCEntity * pParent )

staticprotected

deactivateDo()

void gfCTappableCollectableComponent::deactivateDo ( )

overrideprotectedvirtual

Reimplemented from gfICollectableComponent.

deserialiseDo()

void gfCTappableCollectableComponent::deserialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

hitTest()

fsBool gfCTappableCollectableComponent::hitTest ( const fsPoint & pPointerPos )

protectedvirtual

Reimplemented in gfCTappableCollectableParticleEmitterComponent.

hitTestAndCollect()

fsBool gfCTappableCollectableComponent::hitTestAndCollect ( const fsPoint & pPointerPos )

protectedvirtual

Reimplemented in gfCTappableCollectableParticleEmitterComponent.

inputStealDo()

void gfCTappableCollectableComponent::inputStealDo ( )

overrideprotectedvirtual

Reimplemented from fsIMessageListener.

listenersDeregisterDo()

void gfCTappableCollectableComponent::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfCTappableCollectableComponent::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

Reimplemented in gfCTrapComponent.

touchHitSpriteStore()

void gfCTappableCollectableComponent::touchHitSpriteStore

(

)

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

gfCTutorialSequencerComponent

friend class gfCTutorialSequencerComponent

friend

Member Data Documentation

mGhostSpriteComp

gfCGhostSpriteComponent* gfCTappableCollectableComponent::mGhostSpriteComp

protected

mTakingInput

fsBool gfCTappableCollectableComponent::mTakingInput

protected

mTouchHitSprite

fsISpriteComponent* gfCTappableCollectableComponent::mTouchHitSprite

protected

mTypeId

const fsCUniqueId gfCTappableCollectableComponent::mTypeId

static

---

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

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