The SimBaseClass

Superclasses:

VuEntity

FalconEntity

---

SimBaseClass

private:
       CampBaseClass*campaignObject;

        // Special Transmit Data
        SimBaseSpecialData specialData;

        int dirty_simbase;

  protected:
        int callsignIdx;
        int slotNumber;
        virtual void InitData(void);
        virtual void Cleanup(void);
        // for damage, death and destruction....
        float strength;
        float maxStrength;
        float dyingTimer;
        float sfxTimer;
        long lastDamageTime;
        long explosionTimer;
        VU_ID lastShooter;                              // KCK: replaces vu's lastShooter - Last person to hit this entity
        VU_TIME lastChaff, lastFlare;           // When will the most recently dropped counter-measures expire?
        long campaignFlags;
        uchar localFlags;                                       // Don't transmit these, or else..

  public:
        long timeOfDeath;
        float pctStrength;
        TransformMatrix dmx;
        DrawableObject*drawPointer;
        char displayPriority;
        ObjectGeometry* platformAngles;

        SimBaseNonLocalData *nonLocalData;

        // For regenerating entities, we keep a pointer to our init data
        SimInitDataClass *reinitData;

        // this function can be called for entities which aren't necessarily
        // exec'd in a frame (ie ground units), but need to have their
        // gun tracers and (possibly other) weapons serviced
        virtual void WeaponKeepAlive( void ) { return; };

        // Object grouping
        virtual void JoinFlight (void) {};

        //Functions
        SimBaseClass(int type);
        SimBaseClass(VU_BYTE** stream);
        SimBaseClass(FILE* filePtr);
        virtual ~SimBaseClass(void);
        int GetCallsignIdx (void) { return callsignIdx; };
        int GetSlot (void) { return slotNumber;};
        virtual uchar GetTeam (void);
        virtual uchar GetCountry(void) { return (uchar)specialData.country; };
        virtual short GetCampID (void);
        uchar GetDomain (void)                                          {       return (EntityType())->classInfo_[VU_DOMAIN]; }
        uchar GetClass (void)                                           {       return (EntityType())->classInfo_[VU_CLASS]; }
        uchar GetType (void)                                            {       return (EntityType())->classInfo_[VU_TYPE]; }
        uchar GetSType (void)                                           {       return (EntityType())->classInfo_[VU_STYPE]; }
        uchar GetSPType (void)                                          {       return (EntityType())->classInfo_[VU_SPTYPE]; }
        void ChangeOwner (VU_ID new_owner);
        virtual int Wake (void);
        virtual int Sleep (void);
        virtual MoveType GetMovementType (void);
        virtual void MakeLocal (void);
        virtual void MakeRemote (void);
        virtual int OnGround (void) { return (specialData.flags & ON_GROUND ? TRUE : FALSE);};
        virtual int IsExploding (void) { return (specialData.flags & OBJ_EXPLODING ? TRUE : FALSE);};
        int IsDead (void) { return (specialData.flags & OBJ_DEAD ? TRUE : FALSE);};
        int IsDying (void) { return (specialData.flags & OBJ_DYING ? TRUE : FALSE);};
        int IsFiring (void) { return (specialData.flags & OBJ_FIRING_GUN ? TRUE : FALSE);};
        int IsAwake (void) { return localFlags & OBJ_AWAKE; };
        int  IsSetFlag (int flag) {return ((specialData.flags & flag) ? TRUE : FALSE);};
        int  IsSetLocalFlag (int flag) {return ((localFlags & flag) ? TRUE : FALSE);};
        void SetLocalFlag (int flag) { localFlags |= flag; };
        void UnSetLocalFlag (int flag) { localFlags &= ~(flag); };
        int  IsSetCampaignFlag (int flag) {return ((campaignFlags & flag) ? TRUE : FALSE);};
        void SetCampaignFlag (int flag) {campaignFlags |= flag;};
        void UnSetCampaignFlag (int flag) {campaignFlags &= ~(flag);};
        int IsSetRemoveFlag () { return localFlags & REMOVE_NEXT_FRAME;};
        void SetRemoveFlag (void);
        void SetRemoveSilentFlag (void);
        void SetExploding (int);
        void SetFiring (int);
        void SetCallsign(int newCallsign) {callsignIdx = newCallsign;};
        void SetSlot(int newSlot) {slotNumber = newSlot;};
        int Status(void) {return specialData.status;};

        // Seems like this stuff (and its support "sepecial data") could move into vehicle or aircraft???
        // LOCAL ONLY!
        void SetChaffExpireTime (VU_TIME t)     {ShiAssert(IsLocal()); lastChaff = t;};
        void SetFlareExpireTime (VU_TIME t)     {ShiAssert(IsLocal()); lastFlare = t;};
        VU_TIME ChaffExpireTime (void)                  {ShiAssert(IsLocal()); return lastChaff;};
        VU_TIME FlareExpireTime (void)                  {ShiAssert(IsLocal()); return lastFlare;};
        // REMOTE OR LOCAL
        void SetNewestChaffID(VU_ID id);
        void SetNewestFlareID(VU_ID id);

        VU_ID   NewestChaffID(void)                     {return specialData.ChaffID;};
        VU_ID   NewestFlareID(void)                     {return specialData.FlareID;};

        virtual int IsSPJamming (void);
        virtual int IsAreaJamming (void);
        virtual int HasSPJamming (void);
        virtual int HasAreaJamming (void);

        CampBaseClass *GetCampaignObject (void) { return campaignObject; }
        void SetCampaignObject (CampBaseClass *ent);

        float PowerOutput (void) {return specialData.powerOutput;};
        float RdrAz (void) {return specialData.rdrAz;};
        float RdrEl (void) {return specialData.rdrEl;};
        float RdrAzCenter (void) {return specialData.rdrAzCenter;};
        float RdrElCenter (void) {return specialData.rdrElCenter;};
        float RdrCycleTime (void) {return specialData.rdrCycleTime;};
        float RdrRng (void) {return specialData.rdrNominalRng;};
        float Strength (void) {return strength;};
        float MaxStrength (void) {return maxStrength;};
        int GetAfterburnerStage (void);
        void SetFlag (int flag);
        void UnSetFlag (int flag);
        void SetFlagSilent (int flag);
        void UnSetFlagSilent (int flag);
        void SetCountry(int newSide);
        void SetLastChaff (long a);
        void SetLastFlare (long a);
        void SetStatus (int status);
        void SetStatusBit (int status);
        void ClearStatusBit (int status);
        virtual void SetVt (float vt);
        virtual void SetKias (float kias);
        void SetPowerOutput (float powerOutput);
        void SetRdrAz (float az);
        void SetRdrEl (float el);
        void SetRdrAzCenter (float az);
        void SetRdrElCenter (float el);
        void SetRdrCycleTime (float cycle);
        void SetRdrRng (float rng);
        void SetAfterburnerStage (int s);
        virtual void Init (SimInitDataClass* initData);
        virtual int Exec (void) { return TRUE; };
        virtual void GetTransform(TransformMatrix) {};
        virtual void ApplyDamage (FalconDamageMessage *damageMessage);
        virtual void ApplyDeathMessage (FalconDeathMessage *deathMessage);
        virtual void SetDead (int);
        virtual void MakePlayerVehicle (void) {};
        virtual void MakeNonPlayerVehicle (void) {};
        virtual void ConfigurePlayerAvionics(void) {};
        virtual void SetVuPosition (void) {};
        virtual void Regenerate (float, float, float, float) {};
        VU_ID LastShooter (void) { return lastShooter; };
        void SetDying (int flag);// { if (flag) specialData.flags |= OBJ_DYING; else specialData.flags &= ~OBJ_DYING;};
        SimBaseSpecialData* SpecialData(void) {return &specialData;};

        //a nice big number for ground vehicles and features
        virtual float Mass(void)                {return 2500.0F;}
        // incoming missile notification
        SimBaseClass *incomingMissile;
        void SetIncomingMissile ( SimBaseClass *missile );

        // threat
        FalconEntity *threatObj;
        int threatType;
        #define THREAT_NONE             0
        #define THREAT_SPIKE    1
        #define THREAT_MISSILE  2
        #define THREAT_GUN              3
        void SetThreat ( FalconEntity *threat, int type );
 

        // virtual function interface
        // serialization functions
        virtual int SaveSize();
        virtual int Save(VU_BYTE **stream);     // returns bytes written
        virtual int Save(FILE *file);           // returns bytes written

        // event handlers
        virtual int Handle(VuFullUpdateEvent *event);
        virtual int Handle(VuPositionUpdateEvent *event);
        virtual int Handle(VuTransferEvent *event);
        virtual VU_ERRCODE InsertionCallback(void);
        virtual VU_ERRCODE RemovalCallback(void);

        // callsign and radio functions
        int GetPilotVoiceId(void);
        int GetFlightCallsign(void);

        // get focus point
        virtual void GetFocusPoint(BIG_SCALAR &x, BIG_SCALAR &y, BIG_SCALAR &z);

        // Dirty Functions
        void MakeSimBaseDirty (Dirty_Sim_Base bits, Dirtyness score);
        void WriteDirty (unsigned char **stream);
        void ReadDirty (unsigned char **stream);