ship.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include "collision.h"
#include "commodity.h"
#include "gltf.h"
#include "opengl.h"
#include "outfit.h"
#include "spfx.h"
#include "vec3.h"
 
/* Ship Flags. */
#define SHIP_NOPLAYER                                                          \
   ( 1 << 0 ) 
#define SHIP_NOESCORT                                                          \
   ( 1 << 1 ) 
#define SHIP_UNIQUE                                                            \
   ( 1 << 2 ) 
#define SHIP_NEEDSGFX ( 1 << 3 ) 
#define SHIP_3DTRAILS ( 1 << 4 ) 
#define SHIP_3DMOUNTS ( 1 << 5 ) 
#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_ {
   vec3 pos; 
} ShipMount;

typedef struct ShipOutfitSlot_ {
   OutfitSlot slot;      
   char      *name;      
   int        exclusive; 
   int required; 
   int locked;   
   int visible;  
   const Outfit *data;  
   ShipMount     mount; 
} ShipOutfitSlot;
 
#define SHIP_TRAIL_ALWAYS_UNDER                                                \
   ( 1 << 0 ) 

typedef struct ShipTrailEmitter_ {
   vec3             pos;        
   unsigned int     flags;      
   const TrailSpec *trail_spec; 
} ShipTrailEmitter;

typedef struct Ship_ {
   void *rawdata;   
   char *inherits;  
   char *name;      
   char *base_type; 
   char *base_path; 
   ShipClass class; 
   char *
      class_display; 
   int faction;      
   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 */
   double      size;         
   char       *gfx_path;     
   char       *polygon_path; 
   int         noengine;     
   GltfObject *gfx_3d;       
   glTexture  *gfx_space;    
   glTexture  *gfx_engine;   
   glTexture  *_gfx_store;   
   char       *gfx_comm;     
   glTexture **gfx_overlays; 
   ShipTrailEmitter *trail_emitters; 
   int               sx; /* TODO remove this and sy when possible. */
   int               sy;
 
   /* Collision polygon */
   CollPoly polygon; 
 
   /* Sound */
   int    sound;        
   double engine_pitch; 
 
   /* Outfits */
   ShipOutfitSlot
      *outfit_structure; 
   ShipOutfitSlot
      *outfit_utility;            
   ShipOutfitSlot *outfit_weapon; 
   Outfit const  **outfit_intrinsic; 
 
   /* 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_descextra;      
   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 );
int         ship_size( const Ship *s );
 
/*
 * Rendering.
 */
void ship_renderFramebuffer( const Ship *s, GLuint fbo, double fw, double fh,
                             double dir, double engine_glow, double tilt,
                             double r, int sx, int sy, const glColour *c,
                             const Lighting *L );
USE_RESULT glTexture *ship_gfxComm( const Ship *s, int size, double tilt,
                                    double dir, const Lighting *Lscene );
void ship_renderGfxStore( GLuint fbo, const Ship *s, int size, double dir,
                          double updown, double glow );
USE_RESULT glTexture *ship_gfxStore( const Ship *s, int size, double dir,
                                     double updown, double glow );
int                   ship_gfxAnimated( const Ship *s );
 
/*
 * Misc.
 */
void   ships_resize( void );
int    ship_gfxLoaded( const Ship *s );
int    ship_gfxLoadNeeded( void );
int    ship_gfxLoad( Ship *temp );
int    ship_compareTech( const void *arg1, const void *arg2 );
double ship_maxSize( void );