____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

missile.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2008 by Lutz Sammer
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; only version 2 of the License.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __MISSILE_H__
#define __MISSILE_H__


/*----------------------------------------------------------------------------
--  Documentation
----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------
--  Includes
----------------------------------------------------------------------------*/

#include <vector>
#include "unitsound.h"

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CGraphic;
class CUnit;
class CViewport;
class CFile;
class LuaCallback;

/*----------------------------------------------------------------------------
--  Missile-type
----------------------------------------------------------------------------*/

#define MAX_MISSILES 2048        


typedef int MissileClass;

enum _missile_class_ {
    MissileClassNone,
    MissileClassPointToPoint,
    MissileClassPointToPointWithHit,
    MissileClassPointToPointCycleOnce,
    MissileClassPointToPointBounce,
    MissileClassStay,
    MissileClassCycleOnce,
    MissileClassFire,
    MissileClassHit,
    MissileClassParabolic,
};

class MissileType {
public:
    MissileType(const std::string &ident);
    ~MissileType();

    void LoadMissileSprite();
    void Init(void);
    void DrawMissileType(int frame, int x, int y) const;


    std::string Ident;         
    int Transparency;          
    int Width;                 
    int Height;                
    int DrawLevel;             
    int SpriteFrames;          
    int NumDirections;         

    SoundConfig FiredSound;    
    SoundConfig ImpactSound;   

    bool Flip;                 
    bool CanHitOwner;          
    bool FriendlyFire;         

    MissileClass Class;        
    int NumBounces;            
    int StartDelay;            
    int Sleep;                 
    int Speed;                 

    int Range;                 
    int SplashFactor;          
    std::string ImpactName;    
    MissileType *ImpactMissile;
    std::string SmokeName;     
    MissileType *SmokeMissile; 
    LuaCallback *ImpactParticle; 

// --- FILLED UP ---
    CGraphic *G;         
};

/*----------------------------------------------------------------------------
--  Missile
----------------------------------------------------------------------------*/

class Missile {
protected:
    Missile();

public:
    virtual ~Missile() {};

    static Missile *Init(MissileType *mtype, int sx, int sy, int dx, int dy);

    virtual void Action() = 0;

    void DrawMissile() const;
    void SaveMissile(CFile *file) const;

    int SourceX;  
    int SourceY;  
    int X;        
    int Y;        
    int DX;       
    int DY;       
    MissileType *Type;  
    int SpriteFrame;  
    int State;        
    int AnimWait;     
    int Wait;         
    int Delay;        

    CUnit *SourceUnit;  
    CUnit *TargetUnit;  

    int Damage;  

    int TTL;     
    int Hidden;  

// Internal use:
    int CurrentStep;  
    int TotalStep;    

    unsigned  Local:1;      
    unsigned int Slot;      


    static unsigned int Count; 
};

class MissileNone : public Missile {
public:
    virtual void Action();
};
class MissilePointToPoint : public Missile {
public:
    virtual void Action();
};
class MissilePointToPointWithHit : public Missile {
public:
    virtual void Action();
};
class MissilePointToPointCycleOnce : public Missile {
public:
    virtual void Action();
};
class MissilePointToPointBounce : public Missile {
public:
    virtual void Action();
};
class MissileStay : public Missile {
public:
    virtual void Action();
};
class MissileCycleOnce : public Missile {
public:
    virtual void Action();
};
class MissileFire : public Missile {
public:
    virtual void Action();
};
class MissileHit : public Missile {
public:
    virtual void Action();
};
class MissileParabolic : public Missile {
public:
    virtual void Action();
};

class BurningBuildingFrame {
public:
    BurningBuildingFrame() : Percent(0), Missile(NULL) {};

    int          Percent;  
    MissileType *Missile;  
} ;

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern std::vector<BurningBuildingFrame *> BurningBuildingFrames;  

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

// In script_missile.cpp

extern void MissileCclRegister(void);

// In missile.cpp

extern void LoadMissileSprites();
extern MissileType *NewMissileTypeSlot(const std::string& ident);
extern MissileType *MissileTypeByIdent(const std::string& ident);
extern Missile *MakeMissile(MissileType *mtype, int sx, int sy, int dx,
    int dy);
extern Missile *MakeLocalMissile(MissileType *mtype, int sx, int sy, int dx,
    int dy);
extern void FireMissile(CUnit *unit);

extern int FindAndSortMissiles(const CViewport *vp, Missile **table, int tablesize);

extern void MissileActions(void);
extern int ViewPointDistanceToMissile(const Missile *missile);

extern MissileType *MissileBurningBuilding(int percent);

extern void SaveMissiles(CFile *file);

extern void InitMissileTypes(void);
extern void CleanMissileTypes(void);
extern void InitMissiles(void);
extern void CleanMissiles(void);
#ifdef DEBUG
extern void FreeBurningBuildingFrames();
#endif


#endif // !__MISSILE_H__

---