Inheritance diagram for ICmpWaterManager:

Collaboration diagram for ICmpWaterManager:

[legend]

Public Member Functions
virtual void	RecomputeWaterData ()=0
	Recompute all the water information (foam...) More...

virtual void	SetWaterLevel (entity_pos_t h)=0
	Set the height of the water level, as a constant value across the whole map. More...

virtual entity_pos_t	GetWaterLevel (entity_pos_t x, entity_pos_t z) const =0
	Get the current water level at the given point. More...

virtual float	GetExactWaterLevel (float x, float z) const =0
	Get the current water level at the given point. More...

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 ()

Member Function Documentation

◆ GetExactWaterLevel()

virtual float ICmpWaterManager::GetExactWaterLevel	(	float	x,
		float	z
	)		const

pure virtual

Get the current water level at the given point.

virtual entity_pos_t ICmpWaterManager::GetWaterLevel	(	entity_pos_t	x,
		entity_pos_t	z
	)		const

pure virtual

Get the current water level at the given point.

virtual void ICmpWaterManager::RecomputeWaterData ( )

pure virtual

Recompute all the water information (foam...)

virtual void ICmpWaterManager::SetWaterLevel ( entity_pos_t h )

pure virtual

Set the height of the water level, as a constant value across the whole map.

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

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