ship.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include "collision.h"
#include "commodity.h"
#include "nxml.h"
#include "object.h"
#include "opengl.h"
#include "outfit.h"
#include "sound.h"
#include "spfx.h"
 
/* Target gfx dimensions */
/* TODO remove this and handle it all in the GUIs */
#define SHIP_TARGET_W   128 
#define SHIP_TARGET_H   128 
/* Ship Flags. */
#define SHIP_NOPLAYER   (1<<0)   
#define SHIP_NOESCORT   (1<<1)   
#define SHIP_UNIQUE     (1<<2)   
#define ship_isFlag(s,f)   ((s)->flags & (f)) 
#define ship_setFlag(s,f)  ((s)->flags |= (f)) 
#define ship_rmFlag(s,f)   ((s)->flags &= ~(f)) 
typedef enum ShipClass_ {
   SHIP_CLASS_NULL,        
   /* Civilian. */
   SHIP_CLASS_YACHT,       
   SHIP_CLASS_COURIER,     
   SHIP_CLASS_FREIGHTER,   
   SHIP_CLASS_ARMOURED_TRANSPORT, 
   SHIP_CLASS_BULK_FREIGHTER, 
   /* Military. */
   SHIP_CLASS_SCOUT,       
   SHIP_CLASS_INTERCEPTOR, 
   SHIP_CLASS_FIGHTER,     
   SHIP_CLASS_BOMBER,      
   SHIP_CLASS_CORVETTE,    
   SHIP_CLASS_DESTROYER,   
   SHIP_CLASS_CRUISER,     
   SHIP_CLASS_BATTLESHIP,  
   SHIP_CLASS_CARRIER,     
   SHIP_CLASS_TOTAL,       
} ShipClass;
 
typedef struct ShipMount_ {
   double x; 
   double y; 
   double h; 
} ShipMount;
 
typedef struct ShipOutfitSlot_ {
   OutfitSlot slot;  
   char *name;       
   int exclusive;    
   int required;     
   int locked;       
   const Outfit *data;
   ShipMount mount;  
} ShipOutfitSlot;
 
typedef struct ShipTrailEmitter_ {
   double x_engine;   
   double y_engine;   
   double h_engine;   
   unsigned int always_under; 
   const TrailSpec* trail_spec; 
} ShipTrailEmitter;
 
typedef struct Ship_ {
   char *name;       
   char *base_type;  
   ShipClass class;  
   char *class_display;
   int points;       
   int rarity;       
   int flags;        
   /* store stuff */
   credits_t price;  
   char *license;    
   char *cond;       
   char *condstr;    
   char *fabricator; 
   char *description;
   char *desc_extra; 
   /* movement */
   double accel;     
   double turn;      
   double speed;     
   /* characteristics */
   int crew;            
   double mass;         
   double cpu;          
   int fuel;            
   int fuel_consumption;
   double cap_cargo;    
   double dt_default;   
   /* health */
   double armour;       
   double armour_regen; 
   double shield;       
   double shield_regen; 
   double energy;       
   double energy_regen; 
   double dmg_absorb;   
   /* Graphics */
   Object *gfx_3d;         
   double gfx_3d_scale;    
   glTexture *gfx_space;   
   glTexture *gfx_engine;  
   glTexture *gfx_target;  
   glTexture *gfx_store;   
   char* gfx_comm;         
   glTexture **gfx_overlays; 
   ShipTrailEmitter *trail_emitters; 
   /* Collision polygon */
   CollPoly *polygon; 
   /* Sound */
   int sound;        
   double engine_pitch; 
   /* Outfits */
   ShipOutfitSlot *outfit_structure;
   ShipOutfitSlot *outfit_utility;  
   ShipOutfitSlot *outfit_weapon;   
   Outfit const** outfit_intrinsic; 
   /* Mounts */
   double mangle;    
   /* Statistics. */
   char *desc_stats;       
   ShipStatList *stats;    
   ShipStats stats_array;  
   /* Tags. */
   char **tags;   
   /* Lua function references. Set to LUA_NOREF if not used. */
   char *lua_file;   
   nlua_env lua_env; 
   double lua_dt;    
   int lua_init;     
   int lua_cleanup;  
   int lua_update;   
   int lua_explode_init; 
   int lua_explode_update; 
} Ship;
 
/*
 * Load/quit
 */
int ships_load (void);
void ships_free (void);
 
/*
 * Getters.
 */
const Ship* ship_get( const char* name );
const Ship* ship_getW( const char* name );
const char *ship_existsCase( const char* name );
const Ship* ship_getAll (void);
const char* ship_class( const Ship* s );
const char* ship_classDisplay( const Ship* s );
const char *ship_classToString( ShipClass class );
ShipClass ship_classFromString( const char* str );
credits_t ship_basePrice( const Ship* s );
credits_t ship_buyPrice( const Ship* s );
glTexture* ship_loadCommGFX( const Ship* s );
int ship_size( const Ship *s );
 
/*
 * Misc.
 */
int ship_compareTech( const void *arg1, const void *arg2 );