Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Private Member Functions | Friends | List of all members
ICmpUnitMotionManager Class Referenceabstract

UnitMotionManager - handles motion for CCmpUnitMotion. More...

#include <ICmpUnitMotionManager.h>

Inheritance diagram for ICmpUnitMotionManager:
Inheritance graph
[legend]
Collaboration diagram for ICmpUnitMotionManager:
Collaboration graph
[legend]

Private Member Functions

virtual void Register (CCmpUnitMotion *component, entity_id_t ent, bool formationController)=0
 
virtual void Unregister (entity_id_t ent)=0
 
virtual bool ComputingMotion () const =0
 True if entities are currently in the "Move" phase. More...
 
virtual bool IsPushingActivated () const =0
 

Friends

class CCmpUnitMotion
 This class makes no sense outside of CCmpUnitMotion. More...
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 
- 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
 
- 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

UnitMotionManager - handles motion for CCmpUnitMotion.

This allows units to push past each other instead of requiring pathfinder computations, making movement much smoother overall.

Member Function Documentation

◆ ComputingMotion()

virtual bool ICmpUnitMotionManager::ComputingMotion ( ) const
privatepure virtual

True if entities are currently in the "Move" phase.

Implemented in CCmpUnitMotionManager.

◆ IsPushingActivated()

virtual bool ICmpUnitMotionManager::IsPushingActivated ( ) const
privatepure virtual
Returns
whether pushing is currently enabled or not.

Implemented in CCmpUnitMotionManager.

◆ Register()

virtual void ICmpUnitMotionManager::Register ( CCmpUnitMotion *  component,
entity_id_t  ent,
bool  formationController 
)
privatepure virtual

Implemented in CCmpUnitMotionManager.

◆ Unregister()

virtual void ICmpUnitMotionManager::Unregister ( entity_id_t  ent)
privatepure virtual

Implemented in CCmpUnitMotionManager.

Friends And Related Function Documentation

◆ CCmpUnitMotion

friend class CCmpUnitMotion
friend

This class makes no sense outside of CCmpUnitMotion.

This enforces that tight coupling.

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