---

object.h

Go to the documentation of this file.

#ifndef __OBJECT_H
#define __OBJECT_H

#define MISSILE_FIRE_BREAK 2000
#define PLAYER_MISSILE_FIRE_BREAK 500
#define MAX_GUNS 5  /* maximum # of guns attached to game obj */

/*
 * FLAGS
 */

/* Object Component Flags   (integrated components in use) */

#define OBJCOMP_IMM  (1<<0)  // immunity
#define OBJCOMP_HP   (1<<1)  // hit points
#define OBJCOMP_VIS  (1<<2)  // visualization
#define OBJCOMP_PHYS (1<<3)  // physics
#define OBJCOMP_PATH (1<<4)  // pathing

/* Physics Flags */

#define PHYS_VEL_ZERO     (1<<0)  // velocity zeroing
#define PHYS_VEL_DAMPEN   (1<<1)  // velocity dampening (NOT IMPLMNTD)
#define PHYS_ACC_ZERO     (1<<2)  // acceleration zeroing
#define PHYS_ACC_DAMPEN   (1<<3)  // acceleartion dampening (NOT IMPLMNTD)
#define PHYS_GRAV         (1<<4)  // gravity applied
#define PHYS_TILE_REPEL   (1<<5)  // repelled from tiles
#define PHYS_TILE_BOUNCE  (1<<6)  // bounces off tiles
#define PHYS_DRIVE_FACE   (1<<7)  // drives facing module

/* Pathing Flags */

#define PATH_REV          (1<<0)  // going reverse?
#define PATH_ACC_SPEED    (1<<1)  // auto-accept speed recommendations
#define PATH_LEVEL_REL    (1<<2)  // path relative level (off: relative pt)

/* Simple Events - events without parameters */

#define  EVT_DIED       0   // obj dies (command as well)
#define  EVT_OFFSCRN    1   // obj offscreen
#define  EVT_ACTION     2   // time to perform action
#define  EVT_CALCDEST   3   // time to calculate destination
#define  EVT_MOVEOK     4   // movement was okay, no tile collisions
#define  EVT_IMM_ON     5   // immunity on (command as well)
#define  EVT_IMM_OFF    6   // immunity off
#define  EVT_ANIMEND    7   // animation reached its end
#define  EVT_BOUNCE     8   // obj bounced off of something
#define  EVT_CHGFACE    9   // obj facing a different direction
#define  EVT_FIRST     10   // object constructed, first event.

class Object
{
private:
  ObjectInfo *objectinfo;
  Animation **animations;
  int cur_anim; 
  int weakness_time_countdown;
  int cyclic; 
  Object* object_bay;
  Vector2D pos; 
  Vector2D dst; 
 /* Destination Calculated Bit
  *
  * When an object shadows another object, it needs to know the
  * other objects destination. But, we only want to calculate it
  * once, so we keep track of whether the destination has been
  * calculated or not.
  */
  bool dst_calculated; 
  int comps;   
  bool died;   
  GameTimer *game_timer;  
  ScoreManager *score_manager;
  Input *input;
 /* this will be dropped this if acces to tile pos from obj will be better */
  Tile *lastcollided; 
  int phys_flags;
  int phys_facing_offset;   
  Vector2D phys_pos; 
  Vector2D phys_vel; 
  Vector2D phys_acc; 
  Vector2D phys_dst; 
 /*
  * EXTERNAL COMPONENTS
  *
  */
  /* --- Behaviour --- */
  BehaviourInterface *behaviour;
 /* --- Guns --- */
  GunInterface **gun;
 /* --- Facing --- */
  FacingInterface *facing;
 /* public, but only meant to be changed by Path. */
 /* --- Pathing Variables --- */
  int path_flags;   
  Path *path_cur;     
  float path_dist;    
  Object *path_shdw;    
  Path *path_backup;  
  int  imm_countdown;
  int   hp_cur;     
  bool  hp_tiledmg; 
public:
 /*
  * GAME SIMULATION METHODS
  *
  * METHODS THAT ARE CALLED FROM THE GAME SIMULATION
  */
  Object( Vector2D _pos, ObjectInfo *_objectinfo, GameTimer *_timer, 
        ScoreManager *score_manager, Input *_input );
  ~Object();
 /* --- Notification --- */
 /* "x1S" means "called x1 per cycle while onscreen" */
  void OffScreen();     
  void CycleStarts();   
  void Action();        
  void CalcDestination();       
  void Draw(  Display *display, int xoffset );
  void MoveOK();        
  void CollisionDetected( Tile* );      
  void React (Object * o);      
 /* --- Introspection --- */
  int  IsPlayer();      
  bool Died() { return died; }  
  int  FlagStatus( int flagpos );       
  int GetWidth();       
  int GetHeight();      
  int GetHealthState(); 
  int GetNMissiles();   
 /* --- Access -- */
  Vector2D GetPosition() { return pos; }
  int GetTileX() { return pos.GetTileX(); }
  int GetTileY() { return pos.GetTileY(); }
  void GetCoords(float *x, float *y) { pos.GetCoords(x,y); }
  Vector2D*  GetVelocity();     
  Vector2D*  GetAcceleration(); 
  Vector2D*  GetDestination();  
  Animation*  GetAnimation();
  ObjectInfo* GetObjectInfo();
  ObjectCell *RemoveObjectCell( ObjectCell *objcell );
 /* --- Interaction --- */
  Object* ObjectBayDetach();   
  void Nudge( Vector2D dpos ); 
 /* --- Pathing Interaction --- */
  void PathRecommendsSpeed( float );
  void PathSignals( int );
 /* --- Bus Messages --- */
  void Dies() {} // will be used later.
 /* public, !!BUT!!
  *
  * for use ONLY by:
  *   * Object code
  *   * External components - ex: Behaviour, Gun code
  *
  *
  * INTEGRATED COMPONENTS
  *
  * Respect Encapsulation!
  */
 /* --- Immunity --- */
  void imm_Init();
  bool imm_Status();   
  void imm_Event( int );  
 /* --- HP --- */
  void  hp_Init( bool tiles_damage );
  int   hp_Cur();   
  void  hp_ModifyHealth( int m ); 
  void  hp_Event( int );      
  void  hp_HitTile( Tile* );  
  void  hp_HitObj( Object* ); 
 /* --- Visualization --- */
  void vis_Init();
  void vis_Event( int );           
 /* --- Physics --- */
  void phys_Init( int flags );
  void phys_Action();  
  void phys_Event( int );       
  void phys_HitTile( Tile* );   
  void phys_HitObj( Object* );  
 /* --- Pathing --- */
  void path_Event( int );  
  // --- The Bus --- //
 /* NEVER consider bus messages as arriving to components
  * in a particular order. If you need a particular order,
  * use multiple bus messages and call them in sequence.
  */
  void bus_Event( int );      
  void bus_HitTile( Tile* );  
  void bus_HitObj( Object* ); 
  void bus_PathSig( int );    
 /* For object preservation across levels (ie, the Player) */
  ObjectMemento* CreateMemento();
  void RestoreFromMemento( ObjectMemento* );
  Vector2D GetEdgePoint( int dir );
 /* Object Bay
  *
  * The Object Bay is a place for Objects to place *new* Objects for the Level
  * to pick up and put into the master object list.
  * For example, Objects that fire missiles put the missiles into the object
  * bay, and the Level picks them up and places them into its list of all
  * objects.
  */
  void ObjectBayAttach( Object* );
  Input *GetInput();
  int GetTime();
  GameTimer *GetGameTimer(); 
  ScoreManager *GetScoreManager();
};

#endif // __OBJECT_H

---