gfICollectableComponent Class Reference

#include <gfICollectableComponent.h>

Inheritance diagram for gfICollectableComponent:

Classes
struct	sEntityCollectedParam

Public Member Functions
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 Member Functions
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)

Static Public Attributes
static const fsCUniqueId	mCollectionStartMsg
static const fsCUniqueId	mCollectionEndMsg
static const fsCUniqueId	mLevelSkipForceCollectMsg

Protected Types
enum struct	eCOLLECTION_STATE { eINACTIVE = 0 , eCOLLECTIBLE , eCOLLECTED_EFFECT_PLAYING , eCOLLECTED_EFFECT_FINISHED }

Protected Member Functions
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
virtual void	inputStealDo ()
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()
Protected Member Functions inherited from fsITutorialEnabledComponent
	fsITutorialEnabledComponent ()
virtual	~fsITutorialEnabledComponent ()

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 }
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Member Enumeration Documentation

eCOLLECTION_STATE

enum struct gfICollectableComponent::eCOLLECTION_STATE

strongprotected

Enumerator
eINACTIVE
eCOLLECTIBLE
eCOLLECTED_EFFECT_PLAYING
eCOLLECTED_EFFECT_FINISHED

Constructor & Destructor Documentation

gfICollectableComponent()

gfICollectableComponent::gfICollectableComponent ( fsCEntity * pParent )

protected

~gfICollectableComponent()

gfICollectableComponent::~gfICollectableComponent ( )

protectedvirtual

Member Function Documentation

activate()

void gfICollectableComponent::activate

(

)

collectionEffectPlayingGet()

fsBool gfICollectableComponent::collectionEffectPlayingGet

(

)

const

collectionProcessTrigger()

void gfICollectableComponent::collectionProcessTrigger

(

)

collectionProcessTriggerDo()

void gfICollectableComponent::collectionProcessTriggerDo ( )

protectedvirtual

Reimplemented in gfCGroupCollectableComponent, and gfCLockComponent.

collectionShortCircuit()

void gfICollectableComponent::collectionShortCircuit

(

)

deactivate()

void gfICollectableComponent::deactivate

(

)

deserialiseDo()

void gfICollectableComponent::deserialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

extraPersistentTagCheckProviderSet()

void gfICollectableComponent::extraPersistentTagCheckProviderSet ( fsBool(* pProvider )(fsCEntity *const pEntity) )

static

hasBeenCollectedGet()

fsBool gfICollectableComponent::hasBeenCollectedGet

(

)

const

inInactivatedGetDo()

fsBool gfICollectableComponent::inInactivatedGetDo ( ) const

protectedvirtual

Reimplemented in gfCTappableCollectableParticleEmitterComponent.

isInactivatedGet()

fsBool gfICollectableComponent::isInactivatedGet

(

)

const

listenersDeregisterDo()

void gfICollectableComponent::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfICollectableComponent::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

midCollectionHandle()

void gfICollectableComponent::midCollectionHandle ( )

protectedvirtual

Reimplemented in gfCLockComponent.

onCollectionEffectCompleteDo()

void gfICollectableComponent::onCollectionEffectCompleteDo ( )

protectedvirtual

Reimplemented in gfCTaskComponent.

playCollectedSFX()

fsBool gfICollectableComponent::playCollectedSFX

(

)

resetDo()

void gfICollectableComponent::resetDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

serialiseDo()

void gfICollectableComponent::serialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

stateGet()

gfICollectableComponent::eCOLLECTION_STATE gfICollectableComponent::stateGet ( ) const

protected

stateSet()

void gfICollectableComponent::stateSet ( eCOLLECTION_STATE pState )

protected

tutorialCompletedDo()

void gfICollectableComponent::tutorialCompletedDo ( const fsPoint & pPos )

overrideprotectedvirtual

Implements fsITutorialEnabledComponent.

visiblePostCollectionSet()

void gfICollectableComponent::visiblePostCollectionSet

(

const fsStr &

pPostCollectionMarkerFile

)

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mCollectionEndMsg

const fsCUniqueId gfICollectableComponent::mCollectionEndMsg

static

mCollectionStartMsg

const fsCUniqueId gfICollectableComponent::mCollectionStartMsg

static

mLevelSkipForceCollectMsg

const fsCUniqueId gfICollectableComponent::mLevelSkipForceCollectMsg

static

---

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

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