prj/cam/src/ai/aicombat.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 ///////////////////////////////////////////////////////////////////////////////
   7 // $Header: r:/t2repos/thief2/src/ai/aicombat.h,v 1.26 1999/08/05 16:45:47 Justin Exp $
   8 //
   9 //
  10
  11 #ifndef __AICOMBAT_H
  12 #define __AICOMBAT_H
  13
  14 #include <dynarray.h>
  15
  16 #include <aibasabl.h>
  17 #include <aicblink.h>
  18 #include <aiutils.h>
  19
  20 #pragma once
  21 #pragma pack(4)
  22
  23 class cAISubCombat;
  24
  25 ///////////////////////////////////////////////////////////////////////////////
  26 //
  27 // Publish ability and all associated link and property types
  28 //
  29
  30 BOOL AIInitCombatAbility(IAIManager *);
  31 BOOL AITermCombatAbility();
  32
  33 ///////////////////////////////////////////////////////////////////////////////
  34 //
  35 // CLASS: cAICombat
  36 //
  37
  38 class cAICombat : public cAIAbility
  39 {
  40 public:
  41    cAICombat();
  42
  43    // Standard component methods
  44    STDMETHOD_(const char *, GetName)();
  45    STDMETHOD_(void, Init)();
  46    STDMETHOD_(void, Term)();
  47
  48    STDMETHOD_(BOOL, Save)(ITagFile *);
  49    STDMETHOD_(BOOL, Load)(ITagFile *);
  50
  51    // Notifications
  52    STDMETHOD_(void, OnActionProgress)(IAIAction * pAction);
  53    STDMETHOD_(void, OnAlertness)(ObjID source,
  54                                  eAIAwareLevel previous,
  55                                  eAIAwareLevel current,
  56                                  const sAIAlertness * pRaw);
  57    STDMETHOD_(void, OnDamage)(const sDamageMsg *pMsg, ObjID realCulpritID);
  58    STDMETHOD_(void, OnWeapon)(eWeaponEvent ev, ObjID victim, ObjID culprit);
  59    STDMETHOD_(void, OnProperty)(IProperty *, const sPropertyListenMsg *);
  60    STDMETHOD_(void, OnSound)(const sSoundInfo *, const sAISoundType * pType);
  61    STDMETHOD_(void, OnGoalChange)(const cAIGoal * pPrevious, const cAIGoal * pGoal);
  62 // @TBD (toml 07-27-98): need onmode
  63
  64    // Update the status of the current goal
  65    STDMETHOD_(eAIResult, UpdateGoal)(cAIGoal *);
  66
  67    // Ability flow
  68    STDMETHOD (SuggestMode)   (sAIModeSuggestion *);
  69    STDMETHOD (SuggestGoal)   (cAIGoal * pPrevious, cAIGoal ** ppNew);
  70    STDMETHOD (SuggestActions)(cAIGoal * pGoal, const cAIActions & previous, cAIActions * pNew);
  71
  72    // misc
  73    STDMETHOD_(void, SetTargetAlertnessThreshold)(eAIAwareLevel threshold) {m_targetAlertnessThreshold = threshold;}
  74
  75 public:
  76    // Functions potentially useful to both descendants and contained classes
  77    ObjID GetTarget();
  78    const mxs_vector & GetTargetLoc();
  79
  80    BOOL CanPlayReactCharge();
  81    void SetPlayedReactCharge();
  82
  83 protected:
  84    ObjID SeekCombat();
  85    ObjID SelectTarget();
  86    void SetTarget(ObjID);
  87
  88    void CheckLostContact();   // See if we need to play the LostContact concept.
  89
  90    BOOL  IsHostileToward(ObjID);
  91    eAIAwareLevel GetTargetAlertnessThreshold(void) const {return m_targetAlertnessThreshold;}
  92
  93    // over-ride these for ability specific targetting behavior
  94    virtual BOOL IsValidTarget(ObjID object);                         // Is this valid for acquiring or retaining?
  95    virtual BOOL IsAcquirableTarget(const sAIAwareness& awareness);   // Is this valid to acquire?
  96    virtual BOOL IsRetainableTarget(const sAIAwareness& awareness);   // Is this valid to retain?
  97    virtual eAIPriority TargetPriority(ObjID object);                 // How good is this target?
  98
  99 private:
 100    void SignalSubGoals() {}
 101
 102    void  UpdateTargets();
 103    ObjID TargetScan();
 104
 105    enum
 106    {
 107       kWasDamaged    = kBaseFirstAvailFlag,
 108       kWasThreatened = (kWasDamaged << 1),
 109
 110       kCombatFirstAvailFlag =  (kWasThreatened << 1)
 111    };
 112
 113    cAITimer       m_TargetRefreshTimer;
 114    cAIRandomTimer m_ReactChargeTimer;
 115    cAIRandomTimer m_LostContactTimer;
 116    ObjID          m_LostContactWith;
 117    eAIAwareLevel  m_targetAlertnessThreshold;   // level at which identifying a combat target becomes easier
 118
 119    int            m_lastTargetSwitch;
 120 };
 121
 122 ///////////////////////////////////////
 123
 124 inline BOOL cAICombat::CanPlayReactCharge()
 125 {
 126    return m_ReactChargeTimer.Expired();
 127 }
 128
 129 ///////////////////////////////////////
 130
 131 inline void cAICombat::SetPlayedReactCharge()
 132 {
 133    m_ReactChargeTimer.Reset();
 134 }
 135
 136 ///////////////////////////////////////////////////////////////////////////////
 137
 138 #pragma pack()
 139 #endif /* !__AICOMBAT_H */