shipstats.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include "nlua.h"
#include "nxml.h"

typedef enum ShipStatsType_ {
   SS_TYPE_NIL, 
 
   /*
    * D: Double type data. Should be continuous.
    */
   /* General. */
   SS_TYPE_D_SPEED_MOD,        
   SS_TYPE_D_TURN_MOD,         
   SS_TYPE_D_ACCEL_MOD,        
   SS_TYPE_D_CARGO_MOD,        
   SS_TYPE_D_FUEL_MOD,         
   SS_TYPE_D_FUEL_USAGE_MOD,   
   SS_TYPE_D_ARMOUR_MOD,       
   SS_TYPE_D_ARMOUR_REGEN_MOD, 
   SS_TYPE_D_SHIELD_MOD,       
   SS_TYPE_D_SHIELD_REGEN_MOD, 
   SS_TYPE_D_ENERGY_MOD,       
   SS_TYPE_D_ENERGY_REGEN_MOD, 
   SS_TYPE_D_CPU_MOD,          
   SS_TYPE_D_COOLDOWN_MOD,     
   SS_TYPE_D_SHIELDDOWN_MOD,   
 
   /* Freighter-type. */
   SS_TYPE_D_JUMP_DELAY, 
   SS_TYPE_D_LAND_DELAY, 
   SS_TYPE_D_CARGO_INERTIA, 
 
   /* Electronic warfare. */
   SS_TYPE_D_EW_HIDE,       
   SS_TYPE_D_EW_SIGNATURE,  
   SS_TYPE_D_EW_STEALTH,    
   SS_TYPE_D_EW_DETECT,     
   SS_TYPE_D_EW_TRACK,      
   SS_TYPE_D_EW_JUMPDETECT, 
   SS_TYPE_D_EW_STEALTH_TIMER, 
   SS_TYPE_D_EW_SCANNED_TIME,  
 
   /* Weapons. */
   SS_TYPE_D_WEAPON_RANGE,    
   SS_TYPE_D_WEAPON_DAMAGE,   
   SS_TYPE_D_WEAPON_FIRERATE, 
   SS_TYPE_D_WEAPON_ENERGY,   
 
   /* Launchers. */
   SS_TYPE_D_LAUNCH_RATE,        
   SS_TYPE_D_LAUNCH_RANGE,       
   SS_TYPE_D_LAUNCH_DAMAGE,      
   SS_TYPE_D_LAUNCH_ENERGY,      
   SS_TYPE_D_AMMO_CAPACITY,      
   SS_TYPE_D_LAUNCH_LOCKON,      
   SS_TYPE_D_LAUNCH_CALIBRATION, 
   SS_TYPE_D_LAUNCH_RELOAD,      
   SS_TYPE_D_LAUNCH_ACCEL,       
   SS_TYPE_D_LAUNCH_SPEED,       
   SS_TYPE_D_LAUNCH_TURN,        
 
   /* Fighter Bays. */
   SS_TYPE_D_FBAY_DAMAGE,   
   SS_TYPE_D_FBAY_HEALTH,   
   SS_TYPE_D_FBAY_MOVEMENT, 
   SS_TYPE_D_FBAY_CAPACITY, 
   SS_TYPE_D_FBAY_RATE,     
   SS_TYPE_D_FBAY_RELOAD,   
 
   /* Forward mounts. */
   SS_TYPE_D_FORWARD_HEAT,              
   SS_TYPE_D_FORWARD_DAMAGE,            
   SS_TYPE_D_FORWARD_FIRERATE,          
   SS_TYPE_D_FORWARD_ENERGY,            
   SS_TYPE_D_FORWARD_DAMAGE_AS_DISABLE, 
   SS_TYPE_D_FORWARD_RANGE,             
 
   /* Turrets. */
   SS_TYPE_D_TURRET_HEAT,              
   SS_TYPE_D_TURRET_DAMAGE,            
   SS_TYPE_D_TURRET_TRACKING,          
   SS_TYPE_D_TURRET_FIRERATE,          
   SS_TYPE_D_TURRET_ENERGY,            
   SS_TYPE_D_TURRET_DAMAGE_AS_DISABLE, 
   SS_TYPE_D_TURRET_RANGE,             
 
   /* Misc. */
   SS_TYPE_D_HEAT_DISSIPATION,   
   SS_TYPE_D_STRESS_DISSIPATION, 
   SS_TYPE_D_CREW,               
   SS_TYPE_D_MASS,               
   SS_TYPE_D_ENGINE_LIMIT_REL,   
   SS_TYPE_D_LOOT_MOD,           
   SS_TYPE_D_TIME_MOD,           
   SS_TYPE_D_TIME_SPEEDUP,       
   SS_TYPE_D_COOLDOWN_TIME, 
   SS_TYPE_D_JUMP_DISTANCE, 
   SS_TYPE_D_JUMP_WARMUP, 
   SS_TYPE_D_MINING_BONUS, 
 
   /*
    * A: Absolute double type data. Should be continuous.
    */
   /* Movement. */
   SS_TYPE_A_ACCEL, 
   SS_TYPE_A_TURN,  
   SS_TYPE_A_SPEED, 
   /* Health. */
   SS_TYPE_A_ENERGY,             
   SS_TYPE_A_ENERGY_REGEN,       
   SS_TYPE_A_ENERGY_REGEN_MALUS, 
   SS_TYPE_A_SHIELD,             
   SS_TYPE_A_SHIELD_REGEN,       
   SS_TYPE_A_SHIELD_REGEN_MALUS, 
   SS_TYPE_A_ARMOUR,             
   SS_TYPE_A_ARMOUR_REGEN,       
   SS_TYPE_A_ARMOUR_REGEN_MALUS, 
   SS_TYPE_A_DAMAGE,  
   SS_TYPE_A_DISABLE, 
   /* Misc. */
   SS_TYPE_A_CPU_MAX,       
   SS_TYPE_A_ENGINE_LIMIT,  
   SS_TYPE_A_FUEL_REGEN,    
   SS_TYPE_A_ASTEROID_SCAN, 
   SS_TYPE_A_NEBULA_VISIBILITY, 
 
   /*
    * P: Absolute percent type datas. Should be continuous.
    */
   SS_TYPE_P_ABSORB, 
   /* Nebula. */
   SS_TYPE_P_NEBULA_ABSORB,  
   SS_TYPE_P_JAMMING_CHANCE, 
 
   /*
    * I: Integer type data. Should be continuous.
    */
   SS_TYPE_I_FUEL,  
   SS_TYPE_I_CARGO, 
   SS_TYPE_I_CREW,  
 
   /*
    * B: Boolean type data. Should be continuous.
    */
   SS_TYPE_B_HIDDEN_JUMP_DETECT, 
   SS_TYPE_B_INSTANT_JUMP,   
   SS_TYPE_B_REVERSE_THRUST, 
 
   /*
    * End of list.
    */
   SS_TYPE_SENTINEL 
} ShipStatsType;

typedef struct ShipStatList_ {
   struct ShipStatList_ *next; 
 
   int           target; 
   ShipStatsType type;   
   union {
      double d; 
      int    i; 
   } d;         
} ShipStatList;

typedef struct ShipStats_ {
   /* Movement. */
   double speed;     
   double turn;      
   double accel;     
   double speed_mod; 
   double turn_mod;  
   double accel_mod; 
 
   /* Health. */
   double energy;             
   double energy_regen;       
   double energy_mod;         
   double energy_regen_mod;   
   double energy_regen_malus; 
   double shield;             
   double shield_regen;       
   double shield_mod;         
   double shield_regen_mod;   
   double shield_regen_malus; 
   double armour;             
   double armour_regen;       
   double armour_mod;         
   double armour_regen_mod;   
   double armour_regen_malus; 
   double damage;             
   double disable;            
 
   /* General */
   double cargo_mod;      
   double fuel_mod;       
   double fuel_usage_mod; 
   double cpu_mod;        
   double cpu_max;        
   double absorb;         
   double cooldown_mod;   
   double shielddown_mod; 
 
   /* Freighter-type. */
   double jump_delay;    
   double land_delay;    
   double cargo_inertia; 
 
   /* Stealth. */
   double ew_hide;      
   double ew_signature; 
   double ew_stealth;   
   double ew_detect;    
   double ew_track;     
   double
      ew_jump_detect; 
   double ew_stealth_timer; 
   double ew_scanned_time;  
 
   /* Military type. */
   double heat_dissipation;   
   double stress_dissipation; 
   double crew_mod;           
   double mass_mod;           
 
   /* Weapons. */
   double weapon_range;    
   double weapon_damage;   
   double weapon_firerate; 
   double weapon_energy;   
 
   /* Launchers. */
   double launch_rate;        
   double launch_range;       
   double launch_damage;      
   double launch_energy;      
   double ammo_capacity;      
   double launch_lockon;      
   double launch_calibration; 
   double launch_reload;      
   double launch_accel ;
   double launch_speed; 
   double launch_turn;  
 
   /* Fighter bays. */
   double fbay_damage;   
   double fbay_health;   
   double fbay_movement; 
   double fbay_capacity; 
   double fbay_rate;     
   double fbay_reload;   
 
   /* Fighter/Corvette type. */
   double fwd_heat;       
   double fwd_damage;     
   double fwd_firerate;   
   double fwd_energy;     
   double fwd_dam_as_dis; 
   double fwd_range;      
 
   /* Destroyer/Cruiser type. */
   double tur_heat;       
   double tur_damage;     
   double tur_tracking;   
   double tur_firerate;   
   double tur_energy;     
   double tur_dam_as_dis; 
   double tur_range;      
 
   /* Jamming. */
   double jam_chance; 
 
   /* Engine limits. */
   double engine_limit_rel; 
   double engine_limit;     
 
   /* Misc. */
   double nebu_absorb;         
   double nebu_visibility;     
   int    misc_instant_jump;   
   int    misc_reverse_thrust; 
   double asteroid_scan; 
   double mining_bonus;  
   int    misc_hidden_jump_detect; 
   int    fuel;                    
   double fuel_regen;              
   int    cargo;                   
   int    crew;                    
   double loot_mod;                
   double time_mod;                
   double time_speedup;  
   double cooldown_time; 
   double jump_distance; 
   double jump_warmup;   
} ShipStats;
 
/*
 * Safety.
 */
int ss_check( void );
 
/*
 * Loading.
 */
ShipStatList *ss_listFromXML( xmlNodePtr node );
int           ss_listToXML( xmlTextWriterPtr writer, const ShipStatList *ll );
int           ss_sort( ShipStatList **ll );
void          ss_free( ShipStatList *ll );
 
/*
 * Manipulation
 */
int ss_statsInit( ShipStats *stats );
int ss_statsMerge( ShipStats *dest, const ShipStats *src );
int ss_statsMergeSingle( ShipStats *stats, const ShipStatList *list );
int ss_statsMergeSingleScale( ShipStats *stats, const ShipStatList *list,
                              double scale );
int ss_statsMergeFromList( ShipStats *stats, const ShipStatList *list );
int ss_statsMergeFromListScale( ShipStats *stats, const ShipStatList *list,
                                double scale );
 
/*
 * Lookup.
 */
const char   *ss_nameFromType( ShipStatsType type );
size_t        ss_offsetFromType( ShipStatsType type );
ShipStatsType ss_typeFromName( const char *name );
int ss_statsListDesc( const ShipStatList *ll, char *buf, int len, int newline );
int ss_statsDesc( const ShipStats *s, char *buf, int len, int newline );
 
/*
 * Manipulation.
 */
int ss_statsSet( ShipStats *s, const char *name, double value, int overwrite );
ShipStatList *ss_statsSetList( ShipStatList *head, ShipStatsType type,
                               double value, int overwrite, int raw );
double        ss_statsGet( const ShipStats *s, const char *name );
double        ss_statsGetRaw( const ShipStats *s, ShipStatsType type );
int ss_statsGetLua( lua_State *L, const ShipStats *s, const char *name,
                    int internal );
int ss_statsGetLuaTable( lua_State *L, const ShipStats *s, int internal );
int ss_statsGetLuaTableList( lua_State *L, const ShipStatList *list,
                             int internal );