outfit.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include "collision.h"
#include "commodity.h"
#include "opengl.h"
#include "shipstats.h"
#include "sound.h"
#include "spfx.h"
#include "nlua.h"
 
/*
 * properties
 */
#define outfit_isProp(o,p)          ((o)->properties & p) 
/* property flags */
#define OUTFIT_PROP_UNIQUE             (1<<0)  
#define OUTFIT_PROP_SHOOT_DRY          (1<<1)  
#define OUTFIT_PROP_WEAP_SECONDARY     (1<<10) 
#define OUTFIT_PROP_WEAP_SPIN          (1<<11) 
#define OUTFIT_PROP_WEAP_BLOWUP_ARMOUR (1<<12) 
#define OUTFIT_PROP_WEAP_BLOWUP_SHIELD (1<<13) 
/* Outfit filter labels. [Doc comments are also translator notes and must precede the #define.] */
#define OUTFIT_LABEL_WEAPON            N_("#p W ")
#define OUTFIT_LABEL_UTILITY           N_("#g U ")
#define OUTFIT_LABEL_STRUCTURE         N_("#n S ")
#define OUTFIT_LABEL_CORE              N_("#oCore")
 
/*
 * Needed because some outfittypes call other outfits.
 */
struct Outfit_;
 
typedef enum OutfitType_ {
   OUTFIT_TYPE_NULL,       
   OUTFIT_TYPE_BOLT,       
   OUTFIT_TYPE_BEAM,       
   OUTFIT_TYPE_TURRET_BOLT,
   OUTFIT_TYPE_TURRET_BEAM,
   OUTFIT_TYPE_LAUNCHER,   
   OUTFIT_TYPE_TURRET_LAUNCHER, 
   OUTFIT_TYPE_MODIFICATION, 
   OUTFIT_TYPE_AFTERBURNER,
   OUTFIT_TYPE_FIGHTER_BAY,
   OUTFIT_TYPE_MAP,        
   OUTFIT_TYPE_LOCALMAP,   
   OUTFIT_TYPE_GUI,        
   OUTFIT_TYPE_LICENSE,    
   OUTFIT_TYPE_SENTINEL    
} OutfitType;
 
typedef enum OutfitSlotType_ {
   OUTFIT_SLOT_NULL,       
   OUTFIT_SLOT_NA,         
   OUTFIT_SLOT_STRUCTURE,  
   OUTFIT_SLOT_UTILITY,    
   OUTFIT_SLOT_WEAPON      
} OutfitSlotType;
 
typedef enum OutfitSlotSize_ {
   OUTFIT_SLOT_SIZE_NA,    
   OUTFIT_SLOT_SIZE_LIGHT, 
   OUTFIT_SLOT_SIZE_MEDIUM,
   OUTFIT_SLOT_SIZE_HEAVY  
} OutfitSlotSize;
 
typedef enum OutfitAmmoAI_ {
   AMMO_AI_UNGUIDED, 
   AMMO_AI_SEEK,     
   AMMO_AI_SMART     
} OutfitAmmoAI;
 
typedef struct OutfitSlot_ {
   unsigned int spid;   
   int exclusive;       
   OutfitSlotType type; 
   OutfitSlotSize size; 
} OutfitSlot;
 
typedef struct Damage_ {
   int type;            
   double penetration;  
   double damage;       
   double disable;      
} Damage;
 
typedef struct OutfitBoltData_ {
   double delay;     
   double speed;     
   double range;     
   double falloff;   
   double energy;    
   Damage dmg;       
   double heatup;    
   double heat;      
   double trackmin;  
   double trackmax;  
   double swivel;    
   double dispersion;
   double speed_dispersion;
   int shots;        
   int mining_rarity;
   /* Sound and graphics. */
   glTexture* gfx_space; 
   glTexture* gfx_end; 
   double spin;      
   int sound;        
   int sound_hit;    
   int spfx_armour;  
   int spfx_shield;  
   /* collision polygon */
   CollPoly *polygon;
} OutfitBoltData;
 
typedef struct OutfitBeamData_ {
   /* Time stuff. */
   double delay;     
   double warmup;    
   double duration;  
   double min_duration; 
   /* Beam properties. */
   double range;     
   double turn;      
   double energy;    
   Damage dmg;       
   double heatup;    
   double heat;      
   double swivel;    
   int mining_rarity;
   /* Graphics and sound. */
   glColour colour;  
   GLfloat width;    
   GLuint shader;    
   int spfx_armour;  
   int spfx_shield;  
   int sound_warmup; 
   int sound;        
   int sound_off;    
} OutfitBeamData;
 
typedef struct OutfitLauncherData_ {
   double delay;     
   int amount;       
   double reload_time; 
   /* Lock-on information. */
   double lockon;    
   double iflockon;  
   double trackmin;  
   double trackmax;  
   double arc;       
   double swivel;    
   double dispersion;
   double speed_dispersion;
   int shots;        
   int mining_rarity;
   double ammo_mass; 
   double duration;  
   double resist;    
   OutfitAmmoAI ai;  
   double speed;     
   double speed_max; 
   double turn;      
   double thrust;    
   double energy;    
   Damage dmg;       
   glTexture* gfx_space; 
   double spin;      
   int sound;        
   int sound_hit;    
   int spfx_armour;  
   int spfx_shield;  
   const TrailSpec* trail_spec; 
   double trail_x_offset; 
   /* collision polygon */
   CollPoly *polygon; 
} OutfitLauncherData;
 
typedef struct OutfitModificationData_ {
   /* Active information (if applicable). */
   int active;       
   double duration;  
   double cooldown;  
   /* All the modifiers are based on the outfit's ship stats, nothing here but active stuff. */
} OutfitModificationData;
 
typedef struct OutfitAfterburnerData_ {
   /* Internal properties. */
   double rumble;    
   int sound_on;     
   int sound;        
   int sound_off;    
   double thrust;    
   double speed;     
   double energy;    
   double mass_limit;
   double heatup;    
   double heat;      
   double heat_cap;  
   double heat_base; 
} OutfitAfterburnerData;
 
typedef struct OutfitFighterBayData_ {
   char *ship;       
   double ship_mass; 
   const struct Outfit_ *ammo; 
   double delay;     
   int amount;       
   double reload_time;
   int sound;        
} OutfitFighterBayData;
 
/* Forward declaration */
struct OutfitMapData_s;
typedef struct OutfitMapData_s OutfitMapData_t;
 
typedef struct OutfitLocalMapData_ {
   double jump_detect;  
   double spob_detect; 
} OutfitLocalMapData;
 
typedef struct OutfitGUIData_ {
   char *gui;  
} OutfitGUIData;
 
typedef struct OutfitLicenseData_ {
   char *provides; 
} OutfitLicenseData;
 
typedef struct Outfit_ {
   char *name;       
   char *typename;   
   int rarity;       
   char *filename;   
   /* General specs */
   OutfitSlot slot;  
   char *license;    
   char *cond;       
   char *condstr;    
   double mass;      
   double cpu;       
   char *limit;      
   int *illegalto;   
   char **illegaltoS;
   /* Store stuff */
   credits_t price;  
   char *desc_raw;   
   char *summary_raw;
   char *desc_extra; 
   int priority;     
   glTexture *gfx_store;   
   glTexture **gfx_overlays;
   unsigned int properties;
   unsigned int group;     
   /* Stats. */
   ShipStatList *stats; 
   /* Tags. */
   char **tags;      
   /* Lua function references. Set to LUA_NOREF if not used. */
   char *lua_file;   
   nlua_env lua_env; 
   int lua_descextra;
   int lua_onadd;    
   int lua_onremove; 
   int lua_init;     
   int lua_cleanup;  
   int lua_update;   
   int lua_ontoggle; 
   int lua_onhit;    
   int lua_outofenergy;
   int lua_onshoot;  
   int lua_onstealth;
   int lua_onscanned;
   int lua_onscan;   
   int lua_cooldown; 
   int lua_land;     
   int lua_takeoff;  
   int lua_jumpin;   
   /* Weapons only. */
   int lua_onimpact; 
   int lua_onmiss;   
   /* Independent of slots and pilots. */
   int lua_price;    
   int lua_buy;      
   int lua_sell;     
   /* Type dependent */
   OutfitType type; 
   union {
      OutfitBoltData blt;         
      OutfitBeamData bem;         
      OutfitLauncherData lau;     
      OutfitModificationData mod; 
      OutfitAfterburnerData afb;  
      OutfitFighterBayData bay;   
      OutfitMapData_t *map;       
      OutfitLocalMapData lmap;    
      OutfitGUIData gui;          
      OutfitLicenseData lic;      
   } u; 
} Outfit;
 
/*
 * Access stuff.
 */
const Outfit* outfit_get( const char* name );
const Outfit* outfit_getW( const char* name );
const Outfit* outfit_getAll (void);
int outfit_compareTech( const void *outfit1, const void *outfit2 );
/* outfit types */
int outfit_isActive( const Outfit *o );
int outfit_isToggleable( const Outfit *o );
int outfit_isForward( const Outfit *o );
int outfit_isBolt( const Outfit *o );
int outfit_isBeam( const Outfit *o );
int outfit_isLauncher( const Outfit *o );
int outfit_isAmmo( const Outfit *o );
int outfit_isSeeker( const Outfit *o );
int outfit_isTurret( const Outfit *o );
int outfit_isMod( const Outfit *o );
int outfit_isAfterburner( const Outfit *o );
int outfit_isFighterBay( const Outfit *o );
int outfit_isMap( const Outfit *o );
int outfit_isLocalMap( const Outfit *o );
int outfit_isGUI( const Outfit *o );
int outfit_isLicense( const Outfit *o );
int outfit_isSecondary( const Outfit *o );
const char* outfit_getType( const Outfit *o );
const char* outfit_getTypeBroad( const Outfit *o );
const char* outfit_getAmmoAI( const Outfit *o );
const char* outfit_description( const Outfit *o );
const char* outfit_summary( const Outfit *o, int withname );
 
/*
 * Search.
 */
const char *outfit_existsCase( const char* name );
char **outfit_searchFuzzyCase( const char* name, int *n );
 
/*
 * Filter.
 */
int outfit_filterWeapon( const Outfit *o );
int outfit_filterUtility( const Outfit *o );
int outfit_filterStructure( const Outfit *o );
int outfit_filterCore( const Outfit *o );
int outfit_filterOther( const Outfit *o );
 
/*
 * Get data from outfits.
 */
const char *outfit_slotName( const Outfit* o );
const char *slotName( const OutfitSlotType o );
const char *outfit_slotSize( const Outfit* o );
const char *slotSize( const OutfitSlotSize o );
const glColour *outfit_slotSizeColour( const OutfitSlot* os );
char outfit_slotSizeColourFont( const OutfitSlot* os );
char outfit_slotTypeColourFont( const OutfitSlot* os );
size_t outfit_getNameWithClass( const Outfit* outfit, char* buf, size_t size );
OutfitSlotSize outfit_toSlotSize( const char *s );
const glTexture* outfit_gfx( const Outfit* o );
const CollPoly* outfit_plg( const Outfit* o );
int outfit_spfxArmour( const Outfit* o );
int outfit_spfxShield( const Outfit* o );
const Damage *outfit_damage( const Outfit* o );
double outfit_delay( const Outfit* o );
int outfit_amount( const Outfit* o );
double outfit_energy( const Outfit* o );
double outfit_heat( const Outfit* o );
double outfit_cpu( const Outfit* o );
double outfit_range( const Outfit* o );
double outfit_speed( const Outfit* o );
double outfit_spin( const Outfit* o );
double outfit_trackmin( const Outfit* o );
double outfit_trackmax( const Outfit* o );
int outfit_miningRarity( const Outfit* o );
int outfit_sound( const Outfit* o );
int outfit_soundHit( const Outfit* o );
double outfit_ammoMass( const Outfit *o );
/* Active outfits. */
double outfit_duration( const Outfit* o );
double outfit_cooldown( const Outfit* o );
 
/*
 * Loading and freeing outfit stack.
 */
int outfit_load (void);
int outfit_loadPost (void);
int outfit_mapParse(void);
void outfit_free (void);
 
/*
 * Misc.
 */
int outfit_fitsSlot( const Outfit* o, const OutfitSlot* s );
int outfit_fitsSlotType( const Outfit* o, const OutfitSlot* s );
void outfit_freeSlot( OutfitSlot* s );
glTexture* rarity_texture( int rarity );
int outfit_checkIllegal( const Outfit* o, int fct );
int outfit_licenseExists( const char *name );