Pyrogenesis
trunk
|
Motion interface for entities with complex movement capabilities. More...
#include <ICmpUnitMotion.h>
Public Member Functions | |
virtual bool | MoveToPointRange (entity_pos_t x, entity_pos_t z, entity_pos_t minRange, entity_pos_t maxRange)=0 |
Attempt to walk into range of a to a given point, or as close as possible. More... | |
virtual bool | IsInPointRange (entity_pos_t x, entity_pos_t z, entity_pos_t minRange, entity_pos_t maxRange) const =0 |
Determine wether the givven point is within the given range, using the same measurement as MoveToPointRange. More... | |
virtual bool | IsInTargetRange (entity_id_t target, entity_pos_t minRange, entity_pos_t maxRange) const =0 |
Determine whether the target is within the given range, using the same measurement as MoveToTargetRange. More... | |
virtual bool | MoveToTargetRange (entity_id_t target, entity_pos_t minRange, entity_pos_t maxRange)=0 |
Attempt to walk into range of a given target entity, or as close as possible. More... | |
virtual void | MoveToFormationOffset (entity_id_t target, entity_pos_t x, entity_pos_t z)=0 |
Join a formation, and move towards a given offset relative to the formation controller entity. More... | |
virtual void | FaceTowardsPoint (entity_pos_t x, entity_pos_t z)=0 |
Turn to look towards the given point. More... | |
virtual void | StopMoving ()=0 |
Stop moving immediately. More... | |
virtual fixed | GetCurrentSpeed () const =0 |
Get the current movement speed. More... | |
virtual void | SetSpeed (fixed speed)=0 |
Set the current movement speed. More... | |
virtual bool | IsMoving () const =0 |
Get whether the unit is moving. More... | |
virtual fixed | GetWalkSpeed () const =0 |
Get the default speed that this unit will have when walking, in metres per second. More... | |
virtual fixed | GetRunSpeed () const =0 |
Get the default speed that this unit will have when running, in metres per second. More... | |
virtual void | SetFacePointAfterMove (bool facePointAfterMove)=0 |
Set whether the unit will turn to face the target point after finishing moving. More... | |
virtual pass_class_t | GetPassabilityClass () const =0 |
Get the unit's passability class. More... | |
virtual std::string | GetPassabilityClassName () const =0 |
Get the passability class name (as defined in pathfinder.xml) More... | |
virtual entity_pos_t | GetUnitClearance () const =0 |
Get the unit clearance (used by the Obstruction component) More... | |
virtual void | SetDebugOverlay (bool enabled)=0 |
Toggle the rendering of debug info. More... | |
Public Member Functions inherited from IComponent | |
virtual | ~IComponent () |
virtual void | Init (const CParamNode ¶mNode)=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 ¶mNode, IDeserializer &deserialize)=0 |
virtual bool | NewJSObject (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 | |
Static Public Member Functions inherited from IComponent | |
static std::string | GetSchema () |
static u8 | GetSerializationVersion () |
Motion interface for entities with complex movement capabilities.
(Simpler motion is handled by ICmpMotion instead.)
It should eventually support different movement speeds, moving to areas instead of points, moving as part of a group, moving as part of a formation, etc.
|
pure virtual |
Turn to look towards the given point.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the current movement speed.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the unit's passability class.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the passability class name (as defined in pathfinder.xml)
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the default speed that this unit will have when running, in metres per second.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the unit clearance (used by the Obstruction component)
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get the default speed that this unit will have when walking, in metres per second.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Determine wether the givven point is within the given range, using the same measurement as MoveToPointRange.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Determine whether the target is within the given range, using the same measurement as MoveToTargetRange.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Get whether the unit is moving.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Join a formation, and move towards a given offset relative to the formation controller entity.
Continues following the formation until given a different command.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Attempt to walk into range of a to a given point, or as close as possible.
The range is measured from the center of the unit. If the unit is already in range, or cannot move anywhere at all, or if there is some other error, then returns false. Otherwise, returns true and sends a MotionChanged message after starting to move, and sends another MotionChanged after finishing moving. If maxRange is negative, then the maximum range is treated as infinity.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Attempt to walk into range of a given target entity, or as close as possible.
The range is measured between approximately the edges of the unit and the target, so that maxRange=0 is not unreachably close to the target. If the unit is already in range, or cannot move anywhere at all, or if there is some other error, then returns false. Otherwise, returns true and sends a MotionChanged message after starting to move, and sends another MotionChanged after finishing moving. If maxRange is negative, then the maximum range is treated as infinity.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Toggle the rendering of debug info.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Set whether the unit will turn to face the target point after finishing moving.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Set the current movement speed.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.
|
pure virtual |
Stop moving immediately.
Implemented in CCmpUnitMotion, and CCmpUnitMotionScripted.