157 lines
4.5 KiB
C++
Executable File
157 lines
4.5 KiB
C++
Executable File
// Entity.h
|
|
//
|
|
// Mark Thompson mot20@cam.ac.uk / mark@wildfiregames.com
|
|
//
|
|
// Entity class.
|
|
//
|
|
// Usage: Do not attempt to instantiate this class directly. (See EntityManager.h)
|
|
// Most of the members are trivially obvious; some highlights are:
|
|
//
|
|
// HEntity me: is a reference to this entity. Use instead of the address-of operator for
|
|
// non-temporary references. See EntityHandles.h
|
|
//
|
|
// Destroying entities: An entity is destroyed when all references to it expire.
|
|
// It is somewhat unfunny if this happens while a method from this
|
|
// class is still executing. If you need to kill an entity,
|
|
// use CEntity::kill(). If kill() releases the final handle,
|
|
// the entity is placed in the reaper queue and is deleted immediately
|
|
// prior to its next update cycle.
|
|
//
|
|
// CUnit* m_actor: is the visible representation of this entity.
|
|
// std::hash_map m_properties: isn't yet used, is capable of storing properties defined by script.
|
|
//
|
|
// snapToGround(): Called every frame, this will ensure the entity never takes flight.
|
|
// updateActorTransforms(): Must be called every time the position of this entity changes.
|
|
// Also remember to update the collision object if you alter the position directly.
|
|
//
|
|
// Some notes: update() and dispatch() /can/ be called directly without ill effects,
|
|
// but it's preferable to go through the Entity manager and the Scheduler, respectively.
|
|
//
|
|
|
|
#ifndef ENTITY_INCLUDED
|
|
#define ENTITY_INCLUDED
|
|
|
|
#include <deque>
|
|
#include "scripting/ScriptableObject.h"
|
|
|
|
#include "BaseEntity.h"
|
|
#include "Vector2D.h"
|
|
#include "BoundingObjects.h"
|
|
#include "Vector3D.h"
|
|
#include "Unit.h"
|
|
#include "UnitManager.h"
|
|
#include "EntityOrders.h"
|
|
#include "EntityHandles.h"
|
|
#include "EntityMessage.h"
|
|
#include "EventHandlers.h"
|
|
|
|
class CEntityManager;
|
|
|
|
class CEntity : public CJSObject<CEntity>
|
|
{
|
|
friend class CEntityManager;
|
|
public:
|
|
// Intrinsic properties
|
|
CBaseEntity* m_base;
|
|
|
|
float m_speed;
|
|
float m_turningRadius;
|
|
bool m_selected;
|
|
i32 m_grouped;
|
|
|
|
bool m_extant; // Don't want JS to have direct write-access to these. (Things that should be done might not be)
|
|
bool m_extant_mirror; // plus this way limits the number of nasty semantics to work around.
|
|
|
|
//-- Interpolated property
|
|
CVector3D m_position;
|
|
CVector3D m_position_previous;
|
|
CVector3D m_graphics_position;
|
|
|
|
CBoundingObject* m_bounds;
|
|
float m_targetorientation;
|
|
CVector2D m_ahead;
|
|
|
|
//-- Interpolated property
|
|
float m_orientation;
|
|
float m_orientation_previous;
|
|
float m_graphics_orientation;
|
|
|
|
//-- Scripts
|
|
CScriptObject m_EventHandlers[EVENT_LAST];
|
|
|
|
CUnit* m_actor;
|
|
bool m_moving;
|
|
|
|
std::deque<CEntityOrder> m_orderQueue;
|
|
|
|
private:
|
|
CEntity( CBaseEntity* base, CVector3D position, float orientation );
|
|
|
|
bool processGotoNoPathing( CEntityOrder* current, size_t timestep_milli );
|
|
bool processGoto( CEntityOrder* current, size_t timestep_milli );
|
|
bool processPatrol( CEntityOrder* current, size_t timestep_milli );
|
|
|
|
public:
|
|
~CEntity();
|
|
|
|
// Handle-to-self.
|
|
HEntity me;
|
|
|
|
void dispatch( const CMessage* msg );
|
|
void update( size_t timestep_millis );
|
|
void kill();
|
|
|
|
void interpolate( float relativeoffset );
|
|
void snapToGround();
|
|
void updateActorTransforms();
|
|
void render();
|
|
void renderSelectionOutline( float alpha = 1.0f );
|
|
|
|
void repath();
|
|
|
|
void loadBase();
|
|
|
|
void reorient(); // Orientation
|
|
void teleport(); // Fixes things if the position is changed by something externally.
|
|
void checkSelection(); // In case anyone tries to select/deselect this through JavaScript. You'd think they'd have something better to do.
|
|
void checkGroup(); // Groups
|
|
void checkExtant(); // Existance
|
|
|
|
bool acceptsOrder( int orderType, CEntity* orderTarget );
|
|
|
|
void clearOrders();
|
|
void pushOrder( CEntityOrder& order );
|
|
|
|
// Script constructor
|
|
|
|
static JSBool Construct( JSContext* cx, JSObject* obj, unsigned int argc, jsval* argv, jsval* rval );
|
|
|
|
// Script-bound functions
|
|
|
|
jsval ToString( JSContext* cx, uintN argc, jsval* argv );
|
|
bool Order( JSContext* cx, uintN argc, jsval* argv, bool Queued );
|
|
inline bool OrderSingle( JSContext* cx, uintN argc, jsval* argv )
|
|
{
|
|
return( Order( cx, argc, argv, false ) );
|
|
}
|
|
inline bool OrderQueued( JSContext* cx, uintN argc, jsval* argv )
|
|
{
|
|
return( Order( cx, argc, argv, true ) );
|
|
}
|
|
|
|
static void ScriptingInit();
|
|
};
|
|
|
|
// General entity globals
|
|
|
|
|
|
// In it's current incarnation, inefficient but pretty
|
|
#define SELECTION_TERRAIN_CONFORMANCE
|
|
|
|
extern int SELECTION_CIRCLE_POINTS;
|
|
extern int SELECTION_BOX_POINTS;
|
|
extern int SELECTION_SMOOTHNESS_UNIFIED;
|
|
|
|
|
|
#endif
|