value modification manager interface. More...

Inheritance diagram for ICmpValueModificationManager:

Collaboration diagram for ICmpValueModificationManager:

[legend]

Public Member Functions
virtual fixed	ApplyModifications (std::wstring valueName, fixed currentValue, entity_id_t entity) const =0

virtual u32	ApplyModifications (std::wstring valueName, u32 currentValue, entity_id_t entity) const =0

virtual u16	ApplyModifications (std::wstring valueName, u16 currentValue, entity_id_t entity) const =0

virtual std::wstring	ApplyModifications (std::wstring valueName, std::wstring currentValue, entity_id_t entity) const =0

virtual bool	ApplyModifications (std::wstring valueName, bool currentValue, entity_id_t entity) const =0

Public Member Functions inherited from IComponent
virtual	~IComponent ()

virtual void	Init (const CParamNode &paramNode)=0

virtual void	Deinit ()=0

virtual void	HandleMessage (const CMessage &msg, bool global)

CEntityHandle	GetEntityHandle () const

void	SetEntityHandle (CEntityHandle ent)

entity_id_t	GetEntityId () const

CEntityHandle	GetSystemEntity () const

const CSimContext &	GetSimContext () const

void	SetSimContext (const CSimContext &context)

virtual void	Serialize (ISerializer &serialize)=0

virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0

virtual bool	NewJSObject (const ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
	Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...

virtual JS::Value	GetJSInstance () const

virtual int	GetComponentTypeId () const =0

Additional Inherited Members
Public Types inherited from IComponent
using	AllocFunc = IComponent ()(const ScriptInterface &scriptInterface, JS::HandleValue ctor)

using	DeallocFunc = void()(IComponent )

Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()

static void	RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)

static void	RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)

static u8	GetSerializationVersion ()

Detailed Description

value modification manager interface.

(This interface only includes the functions needed by native code for accessing value modification data, the associated logic is handled in scripts)

Member Function Documentation

virtual bool ICmpValueModificationManager::ApplyModifications	(	std::wstring	valueName,
		bool	currentValue,
		entity_id_t	entity
	)		const

pure virtual

virtual fixed ICmpValueModificationManager::ApplyModifications	(	std::wstring	valueName,
		fixed	currentValue,
		entity_id_t	entity
	)		const

pure virtual

virtual std::wstring ICmpValueModificationManager::ApplyModifications	(	std::wstring	valueName,
		std::wstring	currentValue,
		entity_id_t	entity
	)		const

pure virtual

virtual u16 ICmpValueModificationManager::ApplyModifications	(	std::wstring	valueName,
		u16	currentValue,
		entity_id_t	entity
	)		const

pure virtual

virtual u32 ICmpValueModificationManager::ApplyModifications	(	std::wstring	valueName,
		u32	currentValue,
		entity_id_t	entity
	)		const

pure virtual

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

/home/docker/jenkins/workspace/technical-docs/source/simulation2/components/ICmpValueModificationManager.h