gfCDraggableKeyComponent Class Reference

#include <gfCDraggableKeyComponent.h>

Inheritance diagram for gfCDraggableKeyComponent:

Public Member Functions
fsBool	toolGet () const
void	toolSet ()
void	consume ()
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 ()

Static Public Member Functions
static fsStr	useInventoryIconNameGet (const fsStr &pEntityName)
static fsStr	inventoryIconNameGet (const fsStr &pEntityName)
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)

Static Public Attributes
static const fsCUniqueId	mTypeId
static const fsStr	mEntityPrefix

Protected Member Functions
void	resetDo () override
void	serialiseDo () override
void	deserialiseDo () override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
	gfCDraggableKeyComponent (fsCEntity *pParent)
virtual	~gfCDraggableKeyComponent ()
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 ()

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

Constructor & Destructor Documentation

gfCDraggableKeyComponent()

gfCDraggableKeyComponent::gfCDraggableKeyComponent ( fsCEntity * pParent )

protected

~gfCDraggableKeyComponent()

gfCDraggableKeyComponent::~gfCDraggableKeyComponent ( )

protectedvirtual

Member Function Documentation

consume()

void gfCDraggableKeyComponent::consume

(

)

create()

fsIComponent * gfCDraggableKeyComponent::create ( fsCEntity * pParent )

staticprotected

deserialiseDo()

void gfCDraggableKeyComponent::deserialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

inventoryIconNameGet()

fsStr gfCDraggableKeyComponent::inventoryIconNameGet ( const fsStr & pEntityName )

static

listenersDeregisterDo()

void gfCDraggableKeyComponent::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfCDraggableKeyComponent::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

resetDo()

void gfCDraggableKeyComponent::resetDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

serialiseDo()

void gfCDraggableKeyComponent::serialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

toolGet()

fsBool gfCDraggableKeyComponent::toolGet ( ) const

inline

toolSet()

void gfCDraggableKeyComponent::toolSet ( )

inline

useInventoryIconNameGet()

fsStr gfCDraggableKeyComponent::useInventoryIconNameGet ( const fsStr & pEntityName )

static

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mEntityPrefix

const fsStr gfCDraggableKeyComponent::mEntityPrefix

static

mTypeId

const fsCUniqueId gfCDraggableKeyComponent::mTypeId

static

---

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

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